API Documentation

Cloud/StorageService/Adapter/Nirvanix.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_Nirvanix

Adapter for Nirvanix 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  USERNAME = 'auth_username'
Constant  PASSWORD = 'auth_password'
Constant  APP_KEY = 'auth_accesskey'
Constant  REMOTE_DIRECTORY = 'remote_directory'

Properties

Propertyprotected  $_imfNs= ''
Details
Type
Propertyprotected  $_metadataNs= ''
Details
Type
Propertyprotected\Zend_Service_Nirvanix  $_nirvanix= ''

The Nirvanix adapter

Details
Type
\Zend_Service_Nirvanix
Propertyprotected  $_remoteDirectory= ''
Details
Type
Propertyprivate  $maxPageSize= '500'
Default value500Details
Type

Methods

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

Constructor

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

Get full path to an object

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

Delete an item in the storage service.

Parameters
Name Type Description
$path string
$options array
methodpublicdeleteMetadata( string $path, array $metadata = null, array $options = null ) : void

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

Parameters
Name Type Description
$path string
$metadata array
  • An associative array specifying the key/value pairs for the metadata to be deleted. If null, all metadata associated with the object will be deleted.
$options array
methodpublicfetchItem( string $path, array $options = null ) : mixed

Get an item from the storage service.

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

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

Parameters
Name Type Description
$path string
$options array
Returns
Type Description
array An associative array of key/value pairs specifying the metadata for this object. If no metadata exists, an empty array is returned.
methodprivategetAllFolders(  $path,  $resultArray ) : void

Parameters
Name Type Description
$path
$resultArray
methodpublicgetClient( ) : \Zend_Service_Nirvanix

Get the concrete client.

Returns
Type Description
\Zend_Service_Nirvanix
methodpubliclistItems( string $path, array $options = null ) : array

Return an array of the items contained in the given path. The items returned are the files or objects that in the specified path.

The $path must be a directory

Parameters
Name Type Description
$path string
$options array
Returns
Type Description
array
methodpublicmoveItem( string $sourcePath,  $destinationPath, array $options = null ) : 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
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 = null ) : 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
methodpublicstoreMetadata( string $destinationPath, array $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.

Parameters
Name Type Description
$destinationPath string
$metadata array

associative array specifying the key/value pairs for the metadata.

$options array
Documentation was generated by DocBlox 0.13.3.