Service/Rackspace/Files/Container.php

Show:

inherited

Classes
- \Zend_Service_Rackspace_Files_Container

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_Rackspace
Subpackage: Files

\Zend_Service_Rackspace_Files_Container
jump to top

Package: Zend_Service_Rackspace

Constants

 
                ERROR_PARAM_FILE_CONSTRUCT
                = 'The Zend_Service_Rackspace_Files passed in construction is not valid'

 
                ERROR_PARAM_ARRAY_CONSTRUCT
                = 'The array passed in construction is not valid'

 
                ERROR_PARAM_NO_NAME
                = 'The container name is empty'

Properties

string $name

Details

Type: string

Methods

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

Construct

Parameters

Name	Type	Description
$service	\Zend_Service_Rackspace_Files
$data

Throws

Exception	Description
\Zend_Service_Rackspace_Files_Exception

addObject(string $name, string $file, array $metadata = array()) : bool

Add an object in the container

Parameters

Name	Type	Description
$name	string
$file	string	the content of the object
$metadata	array

Returns

Type	Description
bool

changeTtlCdn(integer $ttl) : bool

Change the TTL for the CDN container

Parameters

Name	Type	Description
$ttl	integer

Returns

Type	Description
bool

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

Copy an object to another container

Parameters

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

Returns

Type	Description
bool

deleteObject(string $obj) : bool

Delete an object in the container

Parameters

Name	Type	Description
$obj	string

Returns

Type	Description
bool

disableCdn() : bool

Disable the CDN for the container

Returns

Type	Description
bool

disableLogCdn() : bool

Disable the log retention for the CDN

Returns

Type	Description
bool

enableCdn(integer $ttl = \Zend_Service_Rackspace_Files::CDN_TTL_MIN) : array | bool

Enable the CDN for the container

Parameters

Name	Type	Description
$ttl	integer

Returns

Type	Description
array \| bool

enableLogCdn() : bool

Enable the log retention for the CDN

Returns

Type	Description
bool

getCdnInfo() : array | bool

Get the CDN information

Returns

Type	Description
array \| bool

getCdnTtl() : integer | bool

Get the TTL of the CDN

Returns

Type	Description
integer \| bool

getCdnUri() : string | bool

Get the CDN URI

Returns

Type	Description
string \| bool

getCdnUriSsl() : string | bool

Get the CDN URI SSL

Returns

Type	Description
string \| bool

getInfo() : array | bool

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

Returns

Type	Description
array \| bool

getMetadata(string $key = null) : array | string | bool

Get the metadata of the container

If $key is empty return the array of metadata

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
array \| string \| bool

getMetadataObject(string $object) : array

Get the metadata of an object in the container

Parameters

Name	Type	Description
$object	string

Returns

Type	Description
array

getName() : string

Get the name of the container

Returns

Type	Description
string

getObject(string $name, array $headers = array()) : \Zend_Service_Rackspace_Files_Object | bool

Get an object of the container

Parameters

Name	Type	Description
$name	string
$headers	array

Returns

Type	Description
\Zend_Service_Rackspace_Files_Object \| bool

getObjectCount() : integer | bool

Get the total count of objects in the container

Returns

Type	Description
integer \| bool

getObjects() : \Zend_Service_Rackspace_Files_ObjectList

Get all the object of the container

Returns

Type	Description
\Zend_Service_Rackspace_Files_ObjectList

getSize() : integer | bool

Get the size in bytes of the container

Returns

Type	Description
integer \| bool

isCdnEnabled() : bool

Return true if the container is CDN enabled

Returns

Type	Description
bool

isCdnLogEnabled() : bool

Return true if the log retention is enabled for the CDN

Returns

Type	Description
bool

setMetadataObject(string $object, array $metadata = array()) : bool

Set the metadata of an object in the container

Parameters

Name	Type	Description
$object	string
$metadata	array

Returns

Type	Description
bool

Service/Rackspace/Files/Container.php

\Zend_Service_Rackspace_Files_Containerjump to top

Constants

Properties

Methods

\Zend_Service_Rackspace_Files_Container
jump to top