API Documentation

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 license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Cloud  
subpackage
StorageService  

\Zend_Cloud_StorageService_Adapter_FileSystem

FileSystem adapter for unstructured cloud storage.

Implements
\Zend_Cloud_StorageService_Adapter
category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Cloud  
subpackage
StorageService  

Constants

Constant  LOCAL_DIRECTORY = 'local_directory'

Options array keys for the file system adapter.

Properties

Propertyprotectedstring  $_directory= 'null'

The directory for the data

Default valuenullDetails
Type
string

Methods

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

Constructor

Parameters
Name Type Description
$options array|\Zend_Config
methodprivate_getFullPath( string $path ) : string

Return the full path for the file.

Parameters
Name Type Description
$path string
Returns
Type Description
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
Name Type Description
$sourcePath string
$destinationPath
$options array
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
Name Type Description
$path string
$options array
methodpublicdeleteMetadata( string $path ) : void

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

Parameters
Name Type Description
$path string
methodpublicfetchItem( string $path, array $options = array ) : false|string

Get an item from the storage service.

TODO: Support streaming

Parameters
Name Type Description
$path string
$options array
Returns
Type Description
falsestring
methodpublicfetchMetadata( string $path, array $options = array ) : array

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

Parameters
Name Type Description
$path string
$options array
Returns
Type Description
array
methodpublicgetClient( ) : \strings

Get the concrete client.

Returns
Type Description
\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
Name Type Description
$path string Must be a directory
$options array
Returns
Type Description
array A 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
Name Type Description
$sourcePath string
$destinationPath
$options array
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
Name Type Description
$path string
$name string
$options array
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
Name Type Description
$destinationPath string
$data mixed
$options array
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
Name Type Description
$destinationPath string
$metadata
$options array
Documentation was generated by DocBlox 0.13.3.