App Engine PHP SDK  v1 rev.445
The PHP runtime is available as an experimental Preview feature.
Public Member Functions | Public Attributes | List of all members
google\appengine\ext\cloud_storage_streams\CloudStorageStreamWrapper Class Reference

Public Member Functions

 __construct ()
 
 __destruct ()
 
 dir_closedir ()
 
 dir_opendir ($path, $options)
 
 dir_readdir ()
 
 dir_rewinddir ()
 
 mkdir ($path, $mode, $options)
 
 rmdir ($path, $options)
 
 rename ($from, $to)
 
 stream_cast ()
 
 stream_close ()
 
 stream_eof ()
 
 stream_flush ()
 
 stream_metadata ($path, $option, $value)
 
 stream_open ($path, $mode, $options, &$opened_path)
 
 stream_read ($count)
 
 stream_seek ($offset, $whence)
 
 stream_set_option ($option, $arg1, $arg2)
 
 stream_stat ()
 
 stream_tell ()
 
 stream_write ($data)
 
 unlink ($path)
 
 url_stat ($path, $flags)
 
 getMetaData ()
 
 getContentType ()
 

Public Attributes

 $context
 
const STREAM_OPEN_FOR_INCLUDE = 0x80
 

Detailed Description

Allowed stream_context options. "anonymous": Boolean, if set then OAuth tokens will not be generated. "acl": The ACL to apply when creating an object. "Content-Type": The content type of the object being written.

Constructor & Destructor Documentation

google\appengine\ext\cloud_storage_streams\CloudStorageStreamWrapper::__construct ( )

Constructs a new stream wrapper.

google\appengine\ext\cloud_storage_streams\CloudStorageStreamWrapper::__destruct ( )

Destructs an existing stream wrapper.

Member Function Documentation

google\appengine\ext\cloud_storage_streams\CloudStorageStreamWrapper::dir_closedir ( )

Close an open directory handle.

google\appengine\ext\cloud_storage_streams\CloudStorageStreamWrapper::dir_opendir (   $path,
  $options 
)

Open a directory handle.

google\appengine\ext\cloud_storage_streams\CloudStorageStreamWrapper::dir_readdir ( )

Read entry from the directory handle.

Returns
string representing the next filename, of false if there is no next file.
google\appengine\ext\cloud_storage_streams\CloudStorageStreamWrapper::dir_rewinddir ( )

Reset the output returned from dir_readdir.

Returns
bool true if the stream can be rewound, false otherwise.
google\appengine\ext\cloud_storage_streams\CloudStorageStreamWrapper::rename (   $from,
  $to 
)

Rename a cloud storage object.

Returns
TRUE if the object was renamed, FALSE otherwise
google\appengine\ext\cloud_storage_streams\CloudStorageStreamWrapper::stream_cast ( )

Retrieve the underlaying resource of the stream, called in response to stream_select().

As GS streams have no underlying resource, we can only return false

google\appengine\ext\cloud_storage_streams\CloudStorageStreamWrapper::stream_close ( )

All resources that were locked, or allocated, by the wrapper should be released.

No value is returned.

google\appengine\ext\cloud_storage_streams\CloudStorageStreamWrapper::stream_eof ( )

Tests for end-of-file on a file pointer.

Returns
TRUE if the read/write position is at the end of the stream and if no more data is available to be read, or FALSE otherwise
google\appengine\ext\cloud_storage_streams\CloudStorageStreamWrapper::stream_flush ( )

Flushes the output.

Returns
TRUE if the cached data was successfully stored (or if there was no data to store), or FALSE if the data could not be stored.
google\appengine\ext\cloud_storage_streams\CloudStorageStreamWrapper::stream_read (   $count)

Read from a stream, return string of bytes.

google\appengine\ext\cloud_storage_streams\CloudStorageStreamWrapper::stream_write (   $data)

Return the number of bytes written.

google\appengine\ext\cloud_storage_streams\CloudStorageStreamWrapper::unlink (   $path)

Deletes a file. Called in response to unlink($filename).


The documentation for this class was generated from the following file: