Service/Amazon/S3/Stream.php

Show:

inherited

Classes
- \Zend_Service_Amazon_S3_Stream

Table of Contents

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Service
Subpackage: Amazon_S3
Version: $Id: Stream.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Service_Amazon_S3_Stream
jump to top

Package: Zend\Service\Amazon\S3

Amazon S3 PHP stream wrapper

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

array $_bucketList = array()

Available buckets

Default valuearray()Details

Type: array

string $_objectBuffer = null

Current read/write buffer

Default valuenullDetails

Type: string

string $_objectName = null

File name to interact with

Default valuenullDetails

Type: string

integer $_objectSize = 0

Total size of the object as returned by S3 (Content-length)

Default value0Details

Type: integer

integer $_position = 0

Current read/write position

Default value0Details

Type: integer

\Zend_Service_Amazon_S3 $_s3 = null

Default valuenullDetails

Type: \Zend_Service_Amazon_S3

boolean $_writeBuffer = false

Write the buffer on fflush()?

Default valuefalseDetails

Type: boolean

Methods

_getNamePart(string $path) : string

Extract object name from URL

Parameters

Name	Type	Description
$path	string

Returns

Type	Description
string

_getS3Client(string $path) : \Zend_Service_Amazon_S3

Retrieve client for this stream type

Parameters

Name	Type	Description
$path	string

Returns

Type	Description
\Zend_Service_Amazon_S3

dir_closedir() : boolean

Close a directory

Returns

Type	Description
boolean	True

dir_opendir(string $path, integer $options) : boolean

Attempt to open a directory

Parameters

Name	Type	Description
$path	string
$options	integer

Returns

Type	Description
boolean

dir_readdir() : string

Return the next filename in the directory

Returns

Type	Description
string

dir_rewinddir() : boolean

Reset the directory pointer

Returns

Type	Description
boolean	True

mkdir(string $path, integer $mode, integer $options) : boolean

Create a new directory

Parameters

Name	Type	Description
$path	string
$mode	integer
$options	integer

Returns

Type	Description
boolean

rename(string $path_from, string $path_to) : boolean

Attempt to rename the item

Parameters

Name	Type	Description
$path_from	string
$path_to	string

Returns

Type	Description
boolean	False

rmdir(string $path, integer $options) : boolean

Remove a directory

Parameters

Name	Type	Description
$path	string
$options	integer

Returns

Type	Description
boolean

stream_close() : void

Close the stream

stream_eof() : boolean

End of the stream?

Returns

Type	Description
boolean

stream_flush() : boolean

Flush current cached stream data to storage

Returns

Type	Description
boolean

stream_open(string $path, string $mode, integer $options, string $opened_path) : boolean

Open the stream

Parameters

Name	Type	Description
$path	string
$mode	string
$options	integer
$opened_path	string

Returns

Type	Description
boolean

stream_read(integer $count) : string

Read from the stream

http://bugs.php.net/21641 - stream_read() is always passed PHP's internal read buffer size (8192) no matter what is passed as $count parameter to fread().

Parameters

Name	Type	Description
$count	integer

Returns

Type	Description
string

stream_seek(integer $offset, integer $whence) : boolean

Update the read/write position of the stream

Parameters

Name	Type	Description
$offset	integer
$whence	integer

Returns

Type	Description
boolean

stream_stat() : array

Returns data array of stream variables

Returns

Type	Description
array

stream_tell() : integer

What is the current read/write position of the stream

Returns

Type	Description
integer

stream_write(string $data) : integer

Write to the stream

Parameters

Name	Type	Description
$data	string

Returns

Type	Description
integer

unlink(string $path) : boolean

Attempt to delete the item

Parameters

Name	Type	Description
$path	string

Returns

Type	Description
boolean

url_stat(string $path, integer $flags) : array

Return array of URL variables

Parameters

Name	Type	Description
$path	string
$flags	integer

Returns

Type	Description
array

Service/Amazon/S3/Stream.php

\Zend_Service_Amazon_S3_Streamjump to top

Properties

Methods

\Zend_Service_Amazon_S3_Stream
jump to top