google/appengine/ext/cloud_storage_streams/CloudStorageStreamWrapper.php
Classes
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
\google\appengine\ext\cloud_storage_streams\CloudStorageStreamWrapper
"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.
Constants
Properties
Methods
__construct
()
: void
Constructs a new stream wrapper.
__destruct
()
: void
Destructs an existing stream wrapper.
dir_closedir
()
: void
Close an open directory handle.
dir_opendir
( $path, $options)
: void
Open a directory handle.
| Name | Type | Description |
|---|---|---|
| $path | ||
| $options |
dir_readdir
()
: string
Read entry from the directory handle.
| Type | Description |
|---|---|
| string | representing the next filename, of false if there is no next file. |
dir_rewinddir
()
: bool
Reset the output returned from dir_readdir.
| Type | Description |
|---|---|
| bool | true if the stream can be rewound, false otherwise. |
getContentType
()
: void
getMetaData
()
: void
mkdir
( $path, $mode, $options)
: void
| Name | Type | Description |
|---|---|---|
| $path | ||
| $mode | ||
| $options |
rename
( $from, $to)
: TRUE
Rename a cloud storage object.
| Name | Type | Description |
|---|---|---|
| $from | ||
| $to |
| Type | Description |
|---|---|
| TRUE | if the object was renamed, FALSE otherwise |
rmdir
( $path, $options)
: void
| Name | Type | Description |
|---|---|---|
| $path | ||
| $options |
stream_cast
()
: void
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
stream_close
()
: void
All resources that were locked, or allocated, by the wrapper should be released.
No value is returned.
stream_eof
()
: TRUE
Tests for end-of-file on a file pointer.
| Type | Description |
|---|---|
| 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 |
stream_flush
()
: TRUE
Flushes the output.
| Type | Description |
|---|---|
| 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. |
stream_metadata
( $path, $option, $value)
: void
| Name | Type | Description |
|---|---|---|
| $path | ||
| $option | ||
| $value |
stream_open
( $path, $mode, $options, $opened_path)
: void
| Name | Type | Description |
|---|---|---|
| $path | ||
| $mode | ||
| $options | ||
| $opened_path |
stream_read
( $count)
: void
Read from a stream, return string of bytes.
| Name | Type | Description |
|---|---|---|
| $count |
stream_seek
( $offset, $whence)
: void
| Name | Type | Description |
|---|---|---|
| $offset | ||
| $whence |
stream_set_option
( $option, $arg1, $arg2)
: void
| Name | Type | Description |
|---|---|---|
| $option | ||
| $arg1 | ||
| $arg2 |
stream_stat
()
: void
stream_tell
()
: void
stream_write
( $data)
: void
Return the number of bytes written.
| Name | Type | Description |
|---|---|---|
| $data |
unlink
( $path)
: void
Deletes a file.
Called in response to unlink($filename).
| Name | Type | Description |
|---|---|---|
| $path |
url_stat
( $path, $flags)
: void
| Name | Type | Description |
|---|---|---|
| $path | ||
| $flags |