Service/Rackspace/Files.php

Show:

inherited

Classes
- \Zend_Service_Rackspace_Files

Table of Contents

Zend Framework

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-2014 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Service
Subpackage: Rackspace

\Zend_Service_Rackspace_Files
jump to top

Package: Zend_Service

Parent(s): \Zend_Service_Rackspace_Abstract

Constants

 
                ERROR_CONTAINER_NOT_EMPTY
                = 'The container is not empty, I cannot delete it.'

 
                ERROR_CONTAINER_NOT_FOUND
                = 'The container was not found.'

 
                ERROR_OBJECT_NOT_FOUND
                = 'The object was not found.'

 
                ERROR_OBJECT_MISSING_PARAM
                = 'Missing Content-Length or Content-Type header in the request'

 
                ERROR_OBJECT_CHECKSUM
                = 'Checksum of the file content failed'

 
                ERROR_CONTAINER_EXIST
                = 'The container already exists'

 
                ERROR_PARAM_NO_NAME_CONTAINER
                = 'You must specify the container name'

 
                ERROR_PARAM_NO_NAME_OBJECT
                = 'You must specify the object name'

 
                ERROR_PARAM_NO_CONTENT
                = 'You must specify the content of the object'

 
                ERROR_PARAM_NO_NAME_SOURCE_CONTAINER
                = 'You must specify the source container name'

 
                ERROR_PARAM_NO_NAME_SOURCE_OBJECT
                = 'You must specify the source object name'

 
                ERROR_PARAM_NO_NAME_DEST_CONTAINER
                = 'You must specify the destination container name'

 
                ERROR_PARAM_NO_NAME_DEST_OBJECT
                = 'You must specify the destination object name'

 
                ERROR_PARAM_NO_METADATA
                = 'You must specify the metadata array'

 
                ERROR_CDN_TTL_OUT_OF_RANGE
                = 'TTL must be a number in seconds, min is 900 sec and maximum is 1577836800 (50 years)'

 
                ERROR_PARAM_UPDATE_CDN
                = 'You must specify at least one the parameters: ttl, cdn_enabled or log_retention'

 
                HEADER_CONTENT_TYPE
                = 'Content-Type'

 
                HEADER_HASH
                = 'Etag'

 
                HEADER_LAST_MODIFIED
                = 'Last-Modified'

 
                HEADER_CONTENT_LENGTH
                = 'Content-Length'

 
                HEADER_COPY_FROM
                = 'X-Copy-From'

 
                METADATA_OBJECT_HEADER
                = "X-Object-Meta-"

 
                METADATA_CONTAINER_HEADER
                = "X-Container-Meta-"

 
                CDN_URI
                = "X-CDN-URI"

 
                CDN_SSL_URI
                = "X-CDN-SSL-URI"

 
                CDN_ENABLED
                = "X-CDN-Enabled"

 
                CDN_LOG_RETENTION
                = "X-Log-Retention"

 
                CDN_ACL_USER_AGENT
                = "X-User-Agent-ACL"

 
                CDN_ACL_REFERRER
                = "X-Referrer-ACL"

 
                CDN_TTL
                = "X-TTL"

 
                CDN_TTL_MIN
                = 900

 
                CDN_TTL_MAX
                = 1577836800

 
                CDN_EMAIL
                = "X-Purge-Email"

 
                ACCOUNT_CONTAINER_COUNT
                = "X-Account-Container-Count"

 
                ACCOUNT_BYTES_USED
                = "X-Account-Bytes-Used"

 
                ACCOUNT_OBJ_COUNT
                = "X-Account-Object-Count"

 
                CONTAINER_OBJ_COUNT
                = "X-Container-Object-Count"

 
                CONTAINER_BYTES_USE
                = "X-Container-Bytes-Used"

 
                MANIFEST_OBJECT_HEADER
                = "X-Object-Manifest"

Methods

copyObject(string $container_source, string $obj_source, string $container_dest, string $obj_dest, array $metadata = array(), string $content_type = null) : boolean

Copy an object from a container to another

Parameters

Name	Type	Description
$container_source	string
$obj_source	string
$container_dest	string
$obj_dest	string
$metadata	array
$content_type	string

Returns

Type	Description
boolean

createContainer(string $container, array $metadata = array()) : \Zend_Service_Rackspace_Files_Container | boolean

Create a container

Parameters

Name	Type	Description
$container	string
$metadata	array

Returns

Type	Description
\Zend_Service_Rackspace_Files_Container \| boolean

deleteContainer(\sting $container) : boolean

Delete a container (only if it's empty)

Parameters

Name	Type	Description
$container	\sting

Returns

Type	Description
boolean

deleteObject(string $container, string $object) : boolean

Delete an object in a container

Parameters

Name	Type	Description
$container	string
$object	string

Returns

Type	Description
boolean

enableCdnContainer(string $container, integer $ttl = self::CDN_TTL_MIN) : array | boolean

Enable the CDN for a container

Parameters

Name	Type	Description
$container	string
$ttl	integer

Returns

Type	Description
array \| boolean

getCdnContainers(array $options = array()) : array | boolean

Get all the CDN containers

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
array \| boolean

getContainer(string $container) : \Container | boolean

Get a container

Parameters

Name	Type	Description
$container	string

Returns

Type	Description
\Container \| boolean

getContainers(array $options = array()) : \Zend_Service_Rackspace_Files_ContainerList | boolean

Get all the containers

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\Zend_Service_Rackspace_Files_ContainerList \| boolean

getCountContainers() : integer

Return the total count of containers

Returns

Type	Description
integer

getCountObjects() : integer

Return the count of objects contained in all the containers

Returns

Type	Description
integer

getInfoAccount() : array | boolean

Get the metadata information of the accounts: - total count containers - size in bytes of all the containers - total objects in all the containers

Returns

Type	Description
array \| boolean

getInfoCdnContainer(string $container) : array | boolean

Get the information of a Cdn container

Parameters

Name	Type	Description
$container	string

Returns

Type	Description
array \| boolean

getMetadataContainer(string $container) : array | boolean

Get the metadata of a container

Parameters

Name	Type	Description
$container	string

Returns

Type	Description
array \| boolean

getMetadataObject(string $container, string $object) : array | boolean

Get the metadata of an object

Parameters

Name	Type	Description
$container	string
$object	string

Returns

Type	Description
array \| boolean

getObject(string $container, string $object, array $headers = array()) : \Zend_Service_Rackspace_Files_Object | boolean

Get an object in a container

Parameters

Name	Type	Description
$container	string
$object	string
$headers	array

Returns

Type	Description
\Zend_Service_Rackspace_Files_Object \| boolean

getObjects(string $container, array $options = array()) : \Zend_Service_Rackspace_Files_ObjectList | boolean

Get all the objects of a container

Parameters

Name	Type	Description
$container	string
$options	array

Returns

Type	Description
\Zend_Service_Rackspace_Files_ObjectList \| boolean

getSizeContainers() : integer

Return the size in bytes of all the containers

Returns

Type	Description
integer

setMetadataObject(string $container, string $object, array $metadata) : boolean

Set the metadata of a object in a container The old metadata values are replaced with the new one

Parameters

Name	Type	Description
$container	string
$object	string
$metadata	array

Returns

Type	Description
boolean

storeObject(string $container, string $object, string $content, array $metadata = array(), string $content_type = null) : boolean

Store a file in a container

Parameters

Name	Type	Description
$container	string
$object	string
$content	string
$metadata	array
$content_type	string

Returns

Type	Description
boolean

updateCdnContainer(string $container, integer $ttl = null, boolean $cdn_enabled = null, boolean $log = null) : boolean

Update the attribute of a CDN container

Parameters

Name	Type	Description
$container	string
$ttl	integer
$cdn_enabled	boolean
$log	boolean

Returns

Type	Description
boolean

Service/Rackspace/Files.php

\Zend_Service_Rackspace_Filesjump to top

Constants

Methods

\Zend_Service_Rackspace_Files
jump to top