Cloud/StorageService/Adapter/FileSystem.php
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
[email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Cloud
- Subpackage
- StorageService
\Zend_Cloud_StorageService_Adapter_FileSystem
Package: Zend_Cloud\StorageServiceFileSystem adapter for unstructured cloud storage.
- Implements
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
LOCAL_DIRECTORY
= 'local_directory'
Options array keys for the file system adapter.
Properties
string $_directory = null
The directory for the data
Default valuenull
Details- Type
- string
Methods
_getFullPath(string $path) : string
Return the full path for the file.
ParametersName | Type | Description |
---|
$path | string | |
---|
Returns copyItem(string $sourcePath, $destinationPath, array $options = array()) : void
Copy an item in the storage service to a given path.
WARNING: This operation is *very* expensive for services that do not
support copying an item natively.
ParametersName | Type | Description |
---|
$sourcePath | string | |
---|
$destinationPath | | |
---|
$options | array | |
---|
Details- TODO
- Support streams for those services that don't support natively
deleteItem(string $path, array $options = array()) : void
Delete an item in the storage service.
ParametersName | Type | Description |
---|
$path | string | |
---|
$options | array | |
---|
deleteMetadata(string $path) : void
Delete a key/value array of metadata at the given path.
ParametersName | Type | Description |
---|
$path | string | |
---|
fetchItem(string $path, array $options = array()) : false | string
Get an item from the storage service.
TODO: Support streaming
ParametersName | Type | Description |
---|
$path | string | |
---|
$options | array | |
---|
ReturnsType | Description |
---|
false | string | |
fetchMetadata(string $path, array $options = array()) : array
Get a key/value array of metadata for the given path.
ParametersName | Type | Description |
---|
$path | string | |
---|
$options | array | |
---|
Returns listItems(string $path, array $options = null) : array
List items in the given directory in the storage service
The $path must be a directory
ParametersName | Type | Description |
---|
$path | string | Must be a directory |
---|
$options | array | |
---|
ReturnsType | Description |
---|
array | A list of item names |
moveItem(string $sourcePath, $destinationPath, array $options = array()) : void
Move an item in the storage service to a given path.
WARNING: This operation is *very* expensive for services that do not
support moving an item natively.
ParametersName | Type | Description |
---|
$sourcePath | string | |
---|
$destinationPath | | |
---|
$options | array | |
---|
Details- TODO
- Support streams for those services that don't support natively
renameItem(string $path, string $name, array $options = null) : void
Rename an item in the storage service to a given name.
ParametersName | Type | Description |
---|
$path | string | |
---|
$name | string | |
---|
$options | array | |
---|
storeItem(string $destinationPath, mixed $data, array $options = array()) : void
Store an item in the storage service.
WARNING: This operation overwrites any item that is located at
$destinationPath.
ParametersName | Type | Description |
---|
$destinationPath | string | |
---|
$data | mixed | |
---|
$options | array | |
---|
Details- TODO
- Support streams
storeMetadata(string $destinationPath, $metadata, array $options = array()) : void
Store a key/value array of metadata at the given path.
WARNING: This operation overwrites any metadata that is located at
$destinationPath.
ParametersName | Type | Description |
---|
$destinationPath | string | |
---|
$metadata | | |
---|
$options | array | |
---|