Service/Amazon/S3/Stream.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service
subpackage: Amazon_S3
version: $Id: Stream.php 22623 2010-07-18 00:43:57Z torio $
Classes: Zend_Service_Amazon_S3_Stream

Description

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.

Zend_Service_Amazon_S3_Stream
jump to top

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Service
subpackage: Amazon_S3
Properties: $_writeBuffer; $_position; $_objectSize; $_objectName; $_objectBuffer; $_bucketList; $_s3
Methods: _getS3Client; _getNamePart; stream_open; stream_close; stream_read; stream_write; stream_eof; stream_tell; stream_seek; stream_flush; stream_stat; unlink; rename; mkdir; rmdir; dir_opendir; url_stat; dir_readdir; dir_rewinddir; dir_closedir

Description

Amazon S3 PHP stream wrapper

Properties

$_bucketList
jump to class

array $_bucketList = 'array'

Details

$_bucketList: array
Available buckets
visibility: private
default: array
final: false
static: false

$_objectBuffer
jump to class

string $_objectBuffer = 'null'

Details

$_objectBuffer: string
Current read/write buffer
visibility: private
default: null
final: false
static: false

$_objectName
jump to class

string $_objectName = 'null'

Details

$_objectName: string
File name to interact with
visibility: private
default: null
final: false
static: false

$_objectSize
jump to class

integer $_objectSize = '0'

Details

$_objectSize: integer
Total size of the object as returned by S3 (Content-length)
visibility: private
default: 0
final: false
static: false

$_position
jump to class

integer $_position = '0'

Details

$_position: integer
Current read/write position
visibility: private
default: 0
final: false
static: false

$_s3
jump to class

Zend_Service_Amazon_S3 $_s3 = 'null'

Details

$_s3: Zend_Service_Amazon_S3
visibility: private
default: null
final: false
static: false

$_writeBuffer
jump to class

boolean $_writeBuffer = 'false'

Details

$_writeBuffer: boolean
Write the buffer on fflush()?
visibility: private
default: false
final: false
static: false

Methods

_getNamePart
jump to class

_getNamePart(
          string $path
          )
        
        :
        string

Extract object name from URL

Arguments

$path: string

Output

string

Details

visibility: protected
final: false
static: false

_getS3Client
jump to class

_getS3Client(
          string $path
          )
        
        :
        Zend_Service_Amazon_S3

Retrieve client for this stream type

Arguments

$path: string

Output

Zend_Service_Amazon_S3

Details

visibility: protected
final: false
static: false

dir_closedir
jump to class

dir_closedir(
          
          )
        
        :
        boolean

Close a directory

Output

boolean: True

Details

visibility: public
final: false
static: false

dir_opendir
jump to class

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

Attempt to open a directory

Arguments

$path: string
$options: integer

Output

boolean

Details

visibility: public
final: false
static: false

dir_readdir
jump to class

dir_readdir(
          
          )
        
        :
        string

Return the next filename in the directory

Output

string

Details

visibility: public
final: false
static: false

dir_rewinddir
jump to class

dir_rewinddir(
          
          )
        
        :
        boolean

Reset the directory pointer

Output

boolean: True

Details

visibility: public
final: false
static: false

mkdir
jump to class

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

Create a new directory

Arguments

$path: string
$mode: integer
$options: integer

Output

boolean

Details

visibility: public
final: false
static: false

rename
jump to class

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

Attempt to rename the item

Arguments

$path_from: string
$path_to: string

Output

boolean: False

Details

visibility: public
final: false
static: false

rmdir
jump to class

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

Remove a directory

Arguments

$path: string
$options: integer

Output

boolean

Details

visibility: public
final: false
static: false

stream_close
jump to class

stream_close(
          
          )
        
        :
        void

Close the stream

Details

visibility: public
final: false
static: false

stream_eof
jump to class

stream_eof(
          
          )
        
        :
        boolean

End of the stream?

Output

boolean

Details

visibility: public
final: false
static: false

stream_flush
jump to class

stream_flush(
          
          )
        
        :
        boolean

Flush current cached stream data to storage

Output

boolean

Details

visibility: public
final: false
static: false

stream_open
jump to class

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

Open the stream

Arguments

$path: string
$mode: string
$options: integer
$opened_path: string

Output

boolean

Details

visibility: public
final: false
static: false

stream_read
jump to class

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().

Arguments

$count: integer

Output

string

Details

visibility: public
final: false
static: false

stream_seek
jump to class

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

Update the read/write position of the stream

Arguments

$offset: integer
$whence: integer

Output

boolean

Details

visibility: public
final: false
static: false

stream_stat
jump to class

stream_stat(
          
          )
        
        :
        array

Returns data array of stream variables

Output

array

Details

visibility: public
final: false
static: false

stream_tell
jump to class

stream_tell(
          
          )
        
        :
        integer

What is the current read/write position of the stream

Output

integer

Details

visibility: public
final: false
static: false

stream_write
jump to class

stream_write(
          string $data
          )
        
        :
        integer

Write to the stream

Arguments

$data: string

Output

integer

Details

visibility: public
final: false
static: false

unlink
jump to class

unlink(
          string $path
          )
        
        :
        boolean

Attempt to delete the item

Arguments

$path: string

Output

boolean

Details

visibility: public
final: false
static: false

url_stat
jump to class

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

Return array of URL variables

Arguments

$path: string
$flags: integer

Output

array

Details

visibility: public
final: false
static: false

API Documentation

Service/Amazon/S3/Stream.php

Description

Zend_Service_Amazon_S3_Streamjump to top

Description

Properties

$_bucketListjump to class

Details

$_objectBufferjump to class

Details

$_objectNamejump to class

Details

$_objectSizejump to class

Details

$_positionjump to class

Details

$_s3jump to class

Details

$_writeBufferjump to class

Details

Methods

_getNamePartjump to class

Arguments

Output

Details

_getS3Clientjump to class

Arguments

Output

Details

dir_closedirjump to class

Output

Details

dir_opendirjump to class

Arguments

Output

Details

dir_readdirjump to class

Output

Details

dir_rewinddirjump to class

Output

Details

mkdirjump to class

Arguments

Output

Details

renamejump to class

Arguments

Output

Details

rmdirjump to class

Arguments

Output

Details

stream_closejump to class

Details

stream_eofjump to class

Output

Details

stream_flushjump to class

Output

Details

stream_openjump to class

Arguments

Output

Details

stream_readjump to class

Arguments

Output

Details

stream_seekjump to class

Arguments

Output

Details

stream_statjump to class

Output

Details

stream_telljump to class

Output

Details

Zend_Service_Amazon_S3_Stream
jump to top

$_bucketList
jump to class

$_objectBuffer
jump to class

$_objectName
jump to class

$_objectSize
jump to class

$_position
jump to class

$_s3
jump to class

$_writeBuffer
jump to class

_getNamePart
jump to class

_getS3Client
jump to class

dir_closedir
jump to class

dir_opendir
jump to class

dir_readdir
jump to class

dir_rewinddir
jump to class

mkdir
jump to class

rename
jump to class

rmdir
jump to class

stream_close
jump to class

stream_eof
jump to class

stream_flush
jump to class

stream_open
jump to class

stream_read
jump to class

stream_seek
jump to class

stream_stat
jump to class

stream_tell
jump to class

stream_write
jump to class

unlink
jump to class

url_stat
jump to class