API Documentation

Zend/Service/Amazon/S3/Stream.php

Show: inherited
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 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Service_Amazon_S3_Stream

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

Propertyprivatearray  $_bucketList= 'array()'

Available buckets
Default valuearray()Details
Type
array
Propertyprivatestring  $_objectBuffer= 'null'

Current read/write buffer
Default valuenullDetails
Type
string
Propertyprivatestring  $_objectName= 'null'

File name to interact with
Default valuenullDetails
Type
string
Propertyprivateinteger  $_objectSize= '0'

Total size of the object as returned by S3 (Content-length)
Default value0Details
Type
integer
Propertyprivateinteger  $_position= '0'

Current read/write position
Default value0Details
Type
integer
Propertyprivate\Zend_Service_Amazon_S3  $_s3= 'null'

Default valuenullDetails
Type
\Zend_Service_Amazon_S3
Propertyprivateboolean  $_writeBuffer= 'false'

Write the buffer on fflush()?
Default valuefalseDetails
Type
boolean

Methods

methodprotected_getNamePart( string $path ) : string

Extract object name from URL

Parameters
Name Type Description
$path string
Returns
Type Description
string
methodprotected_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
methodpublicdir_closedir( ) : boolean

Close a directory

Returns
Type Description
boolean True
methodpublicdir_opendir( string $path, integer $options ) : boolean

Attempt to open a directory

Parameters
Name Type Description
$path string
$options integer
Returns
Type Description
boolean
methodpublicdir_readdir( ) : string

Return the next filename in the directory

Returns
Type Description
string
methodpublicdir_rewinddir( ) : boolean

Reset the directory pointer

Returns
Type Description
boolean True
methodpublicmkdir( 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
methodpublicrename( 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
methodpublicrmdir( string $path, integer $options ) : boolean

Remove a directory

Parameters
Name Type Description
$path string
$options integer
Returns
Type Description
boolean
methodpublicstream_close( ) : void

Close the stream

methodpublicstream_eof( ) : boolean

End of the stream?

Returns
Type Description
boolean
methodpublicstream_flush( ) : boolean

Flush current cached stream data to storage

Returns
Type Description
boolean
methodpublicstream_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
methodpublicstream_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
methodpublicstream_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
methodpublicstream_stat( ) : array

Returns data array of stream variables

Returns
Type Description
array
methodpublicstream_tell( ) : integer

What is the current read/write position of the stream

Returns
Type Description
integer
methodpublicstream_write( string $data ) : integer

Write to the stream

Parameters
Name Type Description
$data string
Returns
Type Description
integer
methodpublicunlink( string $path ) : boolean

Attempt to delete the item

Parameters
Name Type Description
$path string
Returns
Type Description
boolean
methodpublicurl_stat( string $path, integer $flags ) : array

Return array of URL variables

Parameters
Name Type Description
$path string
$flags integer
Returns
Type Description
array
Documentation was generated by DocBlox 0.15.1.