OpenCloud/ObjectStore/CDNContainer.php

Properties

Description

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

Classes

CDNContainer

Properties

 
 
No 
No 

Description

A simple container for the CDN Service
This class implements metadata-handling and other features that are common to the object storage components.

Methods

Create, Delete, Refresh, Service, Update, Url, __construct, is_valid_name,

Create( array   $params = array(), ) : boolean

Description

Creates a new container with the specified attributes

Arguments

Name Type Description Default
$params array

array of parameters

array()

Return value

Type Description
boolean TRUE on success; FALSE on failure

Tags

Name Description
throws

Delete( ) : boolean

Description

Deletes the specified container

Return value

Type Description
boolean TRUE on success; FALSE on failure

Tags

Name Description
throws

Refresh(   $name = NULL,   $url = NULL, ) : void

Description

Loads the object from the service

Arguments

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

Return value

Type Description
void

Service( ) : n/a

Description

Returns the Service associated with the Container

Return value

Type Description
n/a n/a

Update( ) : boolean

Description

Updates the metadata for a container

Return value

Type Description
boolean TRUE on success; FALSE on failure

Tags

Name Description
throws

Url( string   $subresource = '', ) : string

Description

Returns the URL of the container

Arguments

Name Type Description Default
$subresource string

not used; required for compatibility

''

Return value

Type Description
string

Tags

Name Description
throws

__construct( \OpenCloud\ObjectStore\OpenCloud\ObjectStore   $service, mixed   $cdata = NULL, ) : n/a

Description

Creates the container object
Creates a new container object or, if the $cdata object is a string, retrieves the named container from the object store. If $cdata is an array or an object, then its values are used to set this object.

Arguments

Name Type Description Default
$service \OpenCloud\ObjectStore\OpenCloud\ObjectStore
  • the ObjectStore service
$cdata mixed
  • if supplied, the name of the object
NULL

Return value

Type Description
n/a n/a

is_valid_name( string   $name, ) : boolean

Description

Validates that the container name is acceptable

Arguments

Name Type Description Default
$name string

the container name to validate

Return value

Type Description
boolean TRUE if ok; throws an exception if not

Tags

Name Description
throws

Properties

$_cdn, $bytes, $container_url, $count, $name, $service,

  private  $_cdn =




  public  $bytes = 0




  private  $container_url =




  public  $count = 0




  public  $name =




  private  $service =




Documentation was generated by phpDocumentor 2.0.0b6 .

Namespaces

Packages