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.
Common interface for unstructured cloud storage.

copyItem(
string $sourcePath, $destinationPath, array $options
=
null
)
:
void
Copy an item in the storage service to a given path.
The $destinationPath must be a directory.
Name | Type | Description |
---|---|---|
$sourcePath | string | |
$destinationPath | ||
$options | array |

deleteItem(
string $path, array $options
=
null
)
:
void
Delete an item in the storage service.
Name | Type | Description |
---|---|---|
$path | string | |
$options | array |

deleteMetadata(
string $path
)
:
void
Delete a key/value array of metadata at the given path.
Name | Type | Description |
---|---|---|
$path | string |

fetchItem(
string $path, array $options
=
null
)
:
mixed
Get an item from the storage service.
Name | Type | Description |
---|---|---|
$path | string | |
$options | array |
Type | Description |
---|---|
mixed |

fetchMetadata(
string $path, array $options
=
null
)
:
array
Get a key/value array of metadata for the given path.
Name | Type | Description |
---|---|---|
$path | string | |
$options | array |
Type | Description |
---|---|
array |

listItems(
string $path, array $options
=
null
)
:
array
List items in the given directory in the storage service
The $path must be a directory
Name | Type | Description |
---|---|---|
$path | string | Must be a directory |
$options | array |
Type | Description |
---|---|
array | A list of item names |

moveItem(
string $sourcePath, $destinationPath, array $options
=
null
)
:
void
Move an item in the storage service to a given path.
The $destinationPath must be a directory.
Name | Type | Description |
---|---|---|
$sourcePath | string | |
$destinationPath | ||
$options | array |

renameItem(
string $path, string $name, array $options
=
null
)
:
void
Rename an item in the storage service to a given name.
Name | Type | Description |
---|---|---|
$path | string | |
$name | string | |
$options | array |

storeItem(
string $destinationPath, mixed $data, array $options
=
null
)
:
boolean
Store an item in the storage service.
WARNING: This operation overwrites any item that is located at $destinationPath.
Name | Type | Description |
---|---|---|
$destinationPath | string | |
$data | mixed | |
$options | array |
Type | Description |
---|---|
boolean |

storeMetadata(
string $destinationPath, $metadata, array $options
=
null
)
:
void
Store a key/value array of metadata at the given path.
WARNING: This operation overwrites any metadata that is located at $destinationPath.
Name | Type | Description |
---|---|---|
$destinationPath | string | |
$metadata | ||
$options | array |