Cloud/StorageService/Adapter/FileSystem.php

Show: PublicProtectedPrivateinherited
Table of Contents
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\StorageService
FileSystem 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

>VConstant  LOCAL_DIRECTORY = 'local_directory'
Options array keys for the file system adapter.

Properties

>VPropertyprotectedstring $_directory = null
The directory for the data
Default valuenullDetails
Type
string

Methods

methodpublic__construct(array | \Zend_Config $options = array()) : void

Constructor

Parameters
NameTypeDescription
$optionsarray | \Zend_Config
methodprivate_getFullPath(string $path) : string

Return the full path for the file.

Parameters
NameTypeDescription
$pathstring
Returns
TypeDescription
string
methodpubliccopyItem(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.
Parameters
NameTypeDescription
$sourcePathstring
$destinationPath
$optionsarray
Details
TODO
Support streams for those services that don't support natively  
methodpublicdeleteItem(string $path, array $options = array()) : void

Delete an item in the storage service.

Parameters
NameTypeDescription
$pathstring
$optionsarray
methodpublicdeleteMetadata(string $path) : void

Delete a key/value array of metadata at the given path.

Parameters
NameTypeDescription
$pathstring
methodpublicfetchItem(string $path, array $options = array()) : false | string

Get an item from the storage service.

TODO: Support streaming
Parameters
NameTypeDescription
$pathstring
$optionsarray
Returns
TypeDescription
false | string
methodpublicfetchMetadata(string $path, array $options = array()) : array

Get a key/value array of metadata for the given path.

Parameters
NameTypeDescription
$pathstring
$optionsarray
Returns
TypeDescription
array
methodpublicgetClient() : \strings

Get the concrete client.

Returns
TypeDescription
\strings
methodpubliclistItems(string $path, array $options = null) : array

List items in the given directory in the storage service

The $path must be a directory
Parameters
NameTypeDescription
$pathstring

Must be a directory

$optionsarray
Returns
TypeDescription
arrayA list of item names
methodpublicmoveItem(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.
Parameters
NameTypeDescription
$sourcePathstring
$destinationPath
$optionsarray
Details
TODO
Support streams for those services that don't support natively  
methodpublicrenameItem(string $path, string $name, array $options = null) : void

Rename an item in the storage service to a given name.

Parameters
NameTypeDescription
$pathstring
$namestring
$optionsarray
methodpublicstoreItem(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.
Parameters
NameTypeDescription
$destinationPathstring
$datamixed
$optionsarray
Details
TODO
Support streams  
methodpublicstoreMetadata(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.
Parameters
NameTypeDescription
$destinationPathstring
$metadata
$optionsarray
Documentation was generated by phpDocumentor 2.2.0 .