API Documentation

Zend/Cloud/StorageService/Adapter.php

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

    Category
    Zend  
    Copyright
    Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  
    Package
    Zend_Cloud  
    Subpackage
    StorageService  

    \Zend_Cloud_StorageService_Adapter

    Package: Zend\Cloud\StorageService

    Common interface for unstructured cloud storage.

    Category
    Zend  
    Copyright
    Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
    License
    New BSD License  

    Constants

    Constant  HTTP_ADAPTER = 'http_adapter'

    Methods

    methodpubliccopyItem( string $sourcePath,  $destinationPath, array $options = null ) : void

    Copy an item in the storage service to a given path.

    The $destinationPath must be a directory.

    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 ) : void

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

    Parameters
    Name Type Description
    $path string
    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
    methodpublicgetClient( ) : void

    Get the concrete client.

    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 = null ) : void

    Move an item in the storage service to a given path.

    The $destinationPath must be a directory.

    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 ) : boolean

    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
    Returns
    Type Description
    boolean
    methodpublicstoreMetadata( 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.

    Parameters
    Name Type Description
    $destinationPath string
    $metadata
    $options array
    Documentation was generated by DocBlox 0.15.1.