OpenCloud/ObjectStore/Container.php

Properties

Description

Containers for OpenStack Object Storage (Swift) and Rackspace Cloud Files

Classes

Container

Properties

 
 
No 
No 

Description

A regular container with a (potentially) CDN container
This is the main entry point; CDN containers should only be used internally.

Methods

CDN, CDNURI, CDNURL, CDNinfo, CreateStaticSite, DataObject, DisableCDN, EnableCDN, ObjectList, PublicURL, PublishToCDN, Refresh, SSLURI, StaticSiteErrorPage, StreamingURI,

CDN( ) : n/a

Description

Returns the CDN service associated with this container.

Return value

Type Description
n/a n/a

CDNURI( ) : string

Description

Returns the CDN container URI prefix

Return value

Type Description
string

Tags

Name Description
api

CDNURL( ) : string

Description

Returns the CDN URL of the container (if enabled)
The CDNURL() is used to manage the container. Note that it is different from the PublicURL() of the container, which is the publicly-accessible URL on the network.

Return value

Type Description
string

Tags

Name Description
api

CDNinfo(   $prop = null, ) : \OpenCloud\ObjectStore\stdClass

Description

Returns the CDN info about the container

Arguments

Name Type Description Default
$prop n/a null

Return value

Type Description
\OpenCloud\ObjectStore\stdClass

Tags

Name Description
api

CreateStaticSite( string   $index, ) : \OpenCloud\HttpResponse

Description

Creates a static website from the container

Arguments

Name Type Description Default
$index string

the index page (starting page) of the website

Return value

Type Description
\OpenCloud\HttpResponse

Tags

Name Description
api
link http://docs.rackspace.com/files/api/v1/cf-devguide/content/Create_Static_Website-dle4000.html

DataObject( string   $name = null, ) : \OpenCloud\ObjectStore\DataObject

Description

Returns a new DataObject associated with this container

Arguments

Name Type Description Default
$name string

if supplied, the name of the object to return

null

Return value

Type Description
\OpenCloud\ObjectStore\DataObject

DisableCDN( ) : void

Description

Disables the containers CDN function.
Note that the container will still be available on the CDN until its TTL expires.

Return value

Type Description
void

Tags

Name Description
api

EnableCDN(   $ttl = null, ) : \OpenCloud\ObjectStore\CDNContainer

Description

Makes the container public via the CDN

Arguments

Name Type Description Default
$ttl n/a null

Return value

Type Description
\OpenCloud\ObjectStore\CDNContainer

Tags

Name Description
api
throws if CDN services are not available

ObjectList( array   $params = array(), ) : \OpenCloud\ObjectStore\OpenCloud\Collection

Description

Creates a Collection of objects in the container

Arguments

Name Type Description Default
$params array

associative array of parameter values. * account/tenant - The unique identifier of the account/tenant. * container- The unique identifier of the container. * limit (Optional) - The number limit of results. * marker (Optional) - Value of the marker, that the object names greater in value than are returned. * end_marker (Optional) - Value of the marker, that the object names less in value than are returned. * prefix (Optional) - Value of the prefix, which the returned object names begin with. * format (Optional) - Value of the serialized response format, either json or xml. * delimiter (Optional) - Value of the delimiter, that all the object names nested in the container are returned.

array()

Return value

Type Description
\OpenCloud\ObjectStore\OpenCloud\Collection

Tags

Name Description
link for a list of possible parameter names and values
throws

PublicURL( ) : n/a

Description

Returns the Public URL of the container (on the CDN network)

Return value

Type Description
n/a n/a

PublishToCDN(   $ttl = NULL, ) : n/a

Description

a synonym for PublishToCDN for backwards-compatibility

Arguments

Name Type Description Default
$ttl n/a NULL

Return value

Type Description
n/a n/a

Tags

Name Description
api

Refresh(   $id = NULL,   $url = NULL, ) : n/a

Description

Refreshes, then associates the CDN container

Arguments

Name Type Description Default
$id n/a NULL
$url n/a NULL

Return value

Type Description
n/a n/a

SSLURI( ) : string

Description

Returns the SSL URI for the container

Return value

Type Description
string

Tags

Name Description
api

StaticSiteErrorPage( string   $name, ) : \OpenCloud\HttpResponse

Description

Sets the error page(s) for the static website

Arguments

Name Type Description Default
$name string

the name of the error page

Return value

Type Description
\OpenCloud\HttpResponse

Tags

Name Description
api
link http://docs.rackspace.com/files/api/v1/cf-devguide/content/Set_Error_Pages_for_Static_Website-dle4005.html

StreamingURI( ) : string

Description

Returns the streaming URI for the container

Return value

Type Description
string

Tags

Name Description
api

Properties

$_cdn,

  private  $_cdn =




Documentation was generated by phpDocumentor 2.0.0b6 .

Namespaces

Packages