Service/Rackspace/Files/Container.php

Show: PublicProtectedPrivateinherited
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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Service_Rackspace  
Subpackage
Files  

\Zend_Service_Rackspace_Files_Container

Package: Default

Constants

>VConstant  ERROR_PARAM_FILE_CONSTRUCT = 'The Zend_Service_Rackspace_Files passed in construction is not valid'
>VConstant  ERROR_PARAM_ARRAY_CONSTRUCT = 'The array passed in construction is not valid'
>VConstant  ERROR_PARAM_NO_NAME = 'The container name is empty'

Properties

>VPropertyprotectedstring $name
Details
Type
string

Methods

methodpublic__construct(\Zend_Service_Rackspace_Files $service,  $data) : void

Construct

Parameters
NameTypeDescription
$service\Zend_Service_Rackspace_Files
$data
methodpublicaddObject(string $name, string $file, array $metadata = array()) : \boolen

Add an object in the container

Parameters
NameTypeDescription
$namestring
$filestring

the content of the object

$metadataarray
Returns
TypeDescription
\boolen
methodpublicchangeTtlCdn(integer $ttl) : boolean

Change the TTL for the CDN container

Parameters
NameTypeDescription
$ttlinteger
Returns
TypeDescription
boolean
methodpubliccopyObject(string $obj_source, string $container_dest, string $obj_dest, array $metadata = array(), string $content_type = null) : boolean

Copy an object to another container

Parameters
NameTypeDescription
$obj_sourcestring
$container_deststring
$obj_deststring
$metadataarray
$content_typestring
Returns
TypeDescription
boolean
methodpublicdeleteObject(string $obj) : boolean

Delete an object in the container

Parameters
NameTypeDescription
$objstring
Returns
TypeDescription
boolean
methodpublicdisableCdn() : boolean

Disable the CDN for the container

Returns
TypeDescription
boolean
methodpublicdisableLogCdn() : boolean

Disable the log retention for the CDN

Returns
TypeDescription
boolean
methodpublicenableCdn(integer $ttl = \Zend_Service_Rackspace_Files::CDN_TTL_MIN) : array | boolean

Enable the CDN for the container

Parameters
NameTypeDescription
$ttlinteger
Returns
TypeDescription
array | boolean
methodpublicenableLogCdn() : boolean

Enable the log retention for the CDN

Returns
TypeDescription
boolean
methodpublicgetCdnInfo() : array | boolean

Get the CDN information

Returns
TypeDescription
array | boolean
methodpublicgetCdnTtl() : integer | boolean

Get the TTL of the CDN

Returns
TypeDescription
integer | boolean
methodpublicgetCdnUri() : string | boolean

Get the CDN URI

Returns
TypeDescription
string | boolean
methodpublicgetCdnUriSsl() : string | boolean

Get the CDN URI SSL

Returns
TypeDescription
string | boolean
methodpublicgetInfo() : array | boolean

Get the information of the container (total of objects, total size)

Returns
TypeDescription
array | boolean
methodpublicgetMetadata(string $key = null) : array | string | boolean

Get the metadata of the container

If $key is empty return the array of metadata

Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
array | string | boolean
methodpublicgetMetadataObject(string $object) : array

Get the metadata of an object in the container

Parameters
NameTypeDescription
$objectstring
Returns
TypeDescription
array
methodpublicgetName() : string

Get the name of the container

Returns
TypeDescription
string
methodpublicgetObject(string $name, array $headers = array()) : \Zend_Service_Rackspace_Files_Object | boolean

Get an object of the container

Parameters
NameTypeDescription
$namestring
$headersarray
Returns
TypeDescription
\Zend_Service_Rackspace_Files_Object | boolean
methodpublicgetObjectCount() : integer | boolean

Get the total count of objects in the container

Returns
TypeDescription
integer | boolean
methodpublicgetObjects() : \Zend_Service_Rackspace_Files_ObjectList

Get all the object of the container

methodpublicgetSize() : integer | boolean

Get the size in bytes of the container

Returns
TypeDescription
integer | boolean
methodpublicisCdnEnabled() : boolean

Return true if the container is CDN enabled

Returns
TypeDescription
boolean
methodpublicisCdnLogEnabled() : boolean

Return true if the log retention is enabled for the CDN

Returns
TypeDescription
boolean
methodpublicsetMetadataObject(string $object, array $metadata = array()) : boolean

Set the metadata of an object in the container

Parameters
NameTypeDescription
$objectstring
$metadataarray
Returns
TypeDescription
boolean
Documentation was generated by phpDocumentor 2.0.0a12.