Location: PHPKode > projects > php-opencloud > php-opencloud-master/docs/api/container.inc.html
<html xmlns="http://www.w3.org/1999/xhtml"><head><title></title><meta http-equiv="Content-Type" content="text/html; charset=utf-8"></meta><link rel="stylesheet" href="css/black-tie/jquery-ui-1.8.2.custom.css" type="text/css"></link><link rel="stylesheet" href="css/jquery.treeview.css" type="text/css"></link><link rel="stylesheet" href="css/default.css" type="text/css"></link><script type="text/javascript" src="js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="js/jquery.cookie.js"></script><script type="text/javascript" src="js/jquery.treeview.js"></script></head><body><script type="text/javascript">
          $(document).ready(function()
          {
            $(".filetree").treeview({
              animated: "fast",
              collapsed: true,
              persist: "cookie"
            });
          });

          function jq_escape(myid)
          {
            return '#' + myid.replace(/(#|\$|:|\.|\(|\))/g, '\\$1');
          }

          function applySearchHash()
          {
            hashes = document.location.hash.substr(1, document.location.hash.length);
            if (hashes != "")
            {
              hashes = hashes.split('/');
              $.each(hashes, function(index, hash)
              {
                node = $(jq_escape(hash));
                switch (node[0].nodeName)
                {
                  case 'DIV':
                    tabs = node.parents('.tabs');
                    $(tabs[0]).tabs('select', '#' + hash)
                    break;
                  case 'A':
                    window.scrollTo(0, node.offset().top);
                    break;
                }
              });
            }
          }

          jQuery(function()
          {
            jQuery(".tabs").tabs();
            applySearchHash();
          });
        </script><div id="maincontainer"><div id="header"><h1>
                phpDocumentor
              <img src="images/top-stopper.png"></img></h1></div><ul xmlns="" id="menu">
<li><a href="graph.html">Class diagram</a></li>
<li><a href="markers.html">TODO / Markers</a></li>
<li><a href="parse_markers.html">Errors</a></li>
</ul>
<div id="content_container"><div xmlns="" id="content">
<h1>container.inc</h1>
<div class="file_menu">
<a href="#includes">Includes</a> |<a href="#classes">Classes</a> |</div>
<div class="properties">
<h1>Properties</h1>
<label class="property-key">author</label><div class="property-value"></div>
<label class="property-key">copyright</label><div class="property-value"></div>
<label class="property-key">package</label><div class="property-value"></div>
<label class="property-key">version</label><div class="property-value"></div>
</div>
<h2>Description</h2>Containers for OpenStack Object Storage (Swift) and Rackspace Cloud Files<br><br><a name="includes"></a><h2>Includes</h2>dataobject.inc <span class="nb-faded-text">(Require Once)</span><br>objstorebase.inc <span class="nb-faded-text">(Require Once)</span><br><a name="classes"></a><h2>Classes</h2>
<div id="CDNContainer" class="class">
<h3>CDNContainer</h3>
<div class="properties">
<h1>Properties</h1>
<label class="property-key">Extends</label><div class="property-value">
<a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase">\OpenCloud\ObjectStore\ObjStoreBase</a>
         </div>
<label class="property-key">Implements</label><div class="property-value"> 
      </div>
<label class="property-key">author</label><div class="property-value">
<a title="" href="mailto:hide@address.com">Glen Campbell</a>
             
        </div>
<label class="property-key">Abstract</label><div class="property-value">No 
      </div>
<label class="property-key">Final</label><div class="property-value">No 
      </div>
</div>
<h4>Description</h4>
<em>A simple container for the CDN Service</em><br><p>This class implements metadata-handling and other features that are common to
the object storage components.</p><br><div id="methods_CDNContainer">
<h4>Methods</h4>
<a style="font-style: italic;" href="#CDNContainer::CheckAttributePrefix()">CheckAttributePrefix</a>,
      <a style="font-style: italic;" href="#CDNContainer::CheckJsonError()">CheckJsonError</a>,
      <a style="font-style: italic;" href="#CDNContainer::Create()">Create</a>,
      <a style="font-style: italic;" href="#CDNContainer::DataObject()">DataObject</a>,
      <a style="font-style: italic;" href="#CDNContainer::Delete()">Delete</a>,
      <a style="font-style: italic;" href="#CDNContainer::GetHttpRequestObject()">GetHttpRequestObject</a>,
      <a style="font-style: italic;" href="#CDNContainer::GetMetadata()">GetMetadata</a>,
      <a style="font-style: italic;" href="#CDNContainer::JsonCollectionElement()">JsonCollectionElement</a>,
      <a style="font-style: italic;" href="#CDNContainer::JsonCollectionName()">JsonCollectionName</a>,
      <a style="font-style: italic;" href="#CDNContainer::JsonName()">JsonName</a>,
      <a style="font-style: italic;" href="#CDNContainer::MakeQueryString()">MakeQueryString</a>,
      <a style="font-style: italic;" href="#CDNContainer::MetadataHeaders()">MetadataHeaders</a>,
      <a style="font-style: italic;" href="#CDNContainer::Name()">Name</a>,
      <a style="font-style: italic;" href="#CDNContainer::ObjectList()">ObjectList</a>,
      <a style="font-style: italic;" href="#CDNContainer::Prefix()">Prefix</a>,
      <a style="font-style: italic;" href="#CDNContainer::Refresh()">Refresh</a>,
      <a style="font-style: italic;" href="#CDNContainer::Service()">Service</a>,
      <a style="font-style: italic;" href="#CDNContainer::SetProperty()">SetProperty</a>,
      <a style="font-style: italic;" href="#CDNContainer::Update()">Update</a>,
      <a style="font-style: italic;" href="#CDNContainer::Url()">Url</a>,
      <a style="font-style: italic;" href="#CDNContainer::__construct()">__construct</a>,
      <a style="font-style: italic;" href="#CDNContainer::__set()">__set</a>,
      <a style="font-style: italic;" href="#CDNContainer::debug()">debug</a>,
      <a style="font-style: italic;" href="#CDNContainer::is_valid_name()">is_valid_name</a>,
      <a style="font-style: italic;" href="#CDNContainer::to_string()">to_string</a>,
      <div class="method">
<a id="CDNContainer::CheckAttributePrefix()"></a><h3>CheckAttributePrefix<span class="nb-faded-text">(
          string
             
            $property,
          array
             
            $prefixes
            = array(),
          
          )
        </span>
        :
        <span class="nb-faded-text">boolean</span>
</h3>
<h4>Description</h4>
<em>Checks the attribute $property and only permits it if the prefix is
in the specified $prefixes array</em><br><small><p>This is to support extension namespaces in some services.</p></small><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody>
<tr>
<td>$property</td>
<td style="white-space: normal;">string</td>
<td><p>the name of the attribute</p></td>
<td></td>
</tr>
<tr>
<td>$prefixes</td>
<td style="white-space: normal;">array</td>
<td><p>a list of prefixes</p></td>
<td>array()</td>
</tr>
</tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>boolean</td>
<td>TRUE if valid; FALSE if not</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>inherited_from</td>
<td><a href="base.inc.html#%5COpenCloud%5CBase::CheckAttributePrefix()"><small>\OpenCloud\Base::CheckAttributePrefix()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::CheckAttributePrefix()"><small>\OpenCloud\ObjectStore\ObjStoreBase::CheckAttributePrefix()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::CheckJsonError()"></a><h3>CheckJsonError<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">boolean</span>
</h3>
<h4>Description</h4>
<em>Checks the most recent JSON operation for errors</em><br><small><p>This function should be called after any <code>json_*()</code> function call.
This ensures that nasty JSON errors are detected and the proper
exception thrown.</p>

<p>Example:
  <code>$obj = json_decode($string);</code>
  <code>if (check_json_error()) do something ...</code></p></small><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>boolean</td>
<td>TRUE if an error occurred, FALSE if none</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>throws</td>
<td></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="base.inc.html#%5COpenCloud%5CBase::CheckJsonError()"><small>\OpenCloud\Base::CheckJsonError()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::CheckJsonError()"><small>\OpenCloud\ObjectStore\ObjStoreBase::CheckJsonError()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::Create()"></a><h3>Create<span class="nb-faded-text">(
          array
             
            $params
            = array(),
          
          )
        </span>
        :
        <span class="nb-faded-text">boolean</span>
</h3>
<h4>Description</h4>
<em>Creates a new container with the specified attributes</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$params</td>
<td style="white-space: normal;">array</td>
<td><p>array of parameters</p></td>
<td>array()</td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>boolean</td>
<td>TRUE on success; FALSE on failure</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>throws</td>
<td></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::DataObject()"></a><h3>DataObject<span class="nb-faded-text">(
          string
             
            $name
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">\OpenCloud\ObjectStore\DataObject</span>
</h3>
<h4>Description</h4>
<em>Returns a new DataObject associated with this container</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$name</td>
<td style="white-space: normal;">string</td>
<td><p>if supplied, the name of the object to return</p></td>
<td>NULL</td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>\OpenCloud\ObjectStore\DataObject</td>
<td></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::Delete()"></a><h3>Delete<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">boolean</span>
</h3>
<h4>Description</h4>
<em>Deletes the specified container</em><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>boolean</td>
<td>TRUE on success; FALSE on failure</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>throws</td>
<td></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::GetHttpRequestObject()"></a><h3>GetHttpRequestObject<span class="nb-faded-text">(
          
             
            $url,
          
             
            $method
            = 'GET',
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Returns a class that implements the HttpRequest interface.</em><br><small><p>This can be stubbed out for unit testing and avoid making live calls.</p></small><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody>
<tr>
<td>$url</td>
<td style="white-space: normal;">n/a</td>
<td></td>
<td></td>
</tr>
<tr>
<td>$method</td>
<td style="white-space: normal;">n/a</td>
<td></td>
<td>'GET'</td>
</tr>
</tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>inherited_from</td>
<td><a href="base.inc.html#%5COpenCloud%5CBase::GetHttpRequestObject()"><small>\OpenCloud\Base::GetHttpRequestObject()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::GetHttpRequestObject()"><small>\OpenCloud\ObjectStore\ObjStoreBase::GetHttpRequestObject()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::GetMetadata()"></a><h3>GetMetadata<span class="nb-faded-text">(
          
             
            $response,
          
          )
        </span>
        :
        <span class="nb-faded-text">void</span>
</h3>
<h4>Description</h4>
<em>Given an HttpResponse object, converts the appropriate headers
to metadata</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$response</td>
<td style="white-space: normal;">n/a</td>
<td><p>\OpenCloud\HttpResponse</p>
</td>
<td></td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>void</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::GetMetadata()"><small>\OpenCloud\ObjectStore\ObjStoreBase::GetMetadata()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::JsonCollectionElement()"></a><h3>JsonCollectionElement<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::JsonCollectionElement()"><small>\OpenCloud\ObjectStore\ObjStoreBase::JsonCollectionElement()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::JsonCollectionName()"></a><h3>JsonCollectionName<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::JsonCollectionName()"><small>\OpenCloud\ObjectStore\ObjStoreBase::JsonCollectionName()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::JsonName()"></a><h3>JsonName<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::JsonName()"><small>\OpenCloud\ObjectStore\ObjStoreBase::JsonName()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::MakeQueryString()"></a><h3>MakeQueryString<span class="nb-faded-text">(
          array
             
            $arr,
          
          )
        </span>
        :
        <span class="nb-faded-text">string</span>
</h3>
<h4>Description</h4>
<em>Converts an array of key/value pairs into a single query string</em><br><small><p>For example, array('A'=>1,'B'=>2) would become 'A=1&amp;B=2'.</p></small><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$arr</td>
<td style="white-space: normal;">array</td>
<td><p>array of key/value pairs</p>
</td>
<td></td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>string</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>inherited_from</td>
<td><a href="base.inc.html#%5COpenCloud%5CBase::MakeQueryString()"><small>\OpenCloud\Base::MakeQueryString()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::MakeQueryString()"><small>\OpenCloud\ObjectStore\ObjStoreBase::MakeQueryString()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::MetadataHeaders()"></a><h3>MetadataHeaders<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">\OpenCloud\ObjectStore\array;</span>
</h3>
<h4>Description</h4>
<em>If object has metadata, returns an associative array of headers</em><br><small><p>For example, if a DataObject has a metadata item named 'FOO',
then this would return array('X-Object-Meta-FOO'=>$value);</p></small><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>\OpenCloud\ObjectStore\array;</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::MetadataHeaders()"><small>\OpenCloud\ObjectStore\ObjStoreBase::MetadataHeaders()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::Name()"></a><h3>Name<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Returns the displayable name of the object</em><br><small><p>Can be overridden by child objects; <em>must</em> be overridden by child
objects if the object does not have a <code>name</code> attribute defined.</p></small><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>api</td>
<td></td>
</tr>
<tr>
<td>throws</td>
<td>if attribute 'name' is not defined</td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::Name()"><small>\OpenCloud\ObjectStore\ObjStoreBase::Name()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::ObjectList()"></a><h3>ObjectList<span class="nb-faded-text">(
          array
             
            $params
            = array(),
          
          )
        </span>
        :
        <span class="nb-faded-text">\OpenCloud\ObjectStore\OpenCloud\Collection</span>
</h3>
<h4>Description</h4>
<em>Creates a Collection of objects in the container</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$params</td>
<td style="white-space: normal;">array</td>
<td><p>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.</p>
</td>
<td>array()</td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>\OpenCloud\ObjectStore\OpenCloud\Collection</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>link</td>
<td><a href="http://api.openstack.org"><small>for a list of possible parameter
names and values</small></a></td>
</tr>
<tr>
<td>throws</td>
<td></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::Prefix()"></a><h3>Prefix<span class="nb-faded-text">(
          string
             
            $type
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Returns the proper prefix for the specified type of object</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$type</td>
<td style="white-space: normal;">string</td>
<td><p>The type of object; derived from <code>get_class()</code> if not specified.</p>
</td>
<td>NULL</td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::Prefix()"><small>\OpenCloud\ObjectStore\ObjStoreBase::Prefix()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::Refresh()"></a><h3>Refresh<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">void</span>
</h3>
<h4>Description</h4>
<em>Loads the object from the service</em><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>void</td>
<td></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::Service()"></a><h3>Service<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Returns the Service associated with the Container</em><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::SetProperty()"></a><h3>SetProperty<span class="nb-faded-text">(
          string
             
            $property,
          mixed
             
            $value,
          array
             
            $prefixes
            = array(),
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Sets an extended (unrecognized) property on the current object</em><br><small><p>If RAXSDK_STRICT_PROPERTY_CHECKS is TRUE, then the prefix of the
property name must appear in the $prefixes array, or else an
exception is thrown.</p></small><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody>
<tr>
<td>$property</td>
<td style="white-space: normal;">string</td>
<td><p>the property name</p></td>
<td></td>
</tr>
<tr>
<td>$value</td>
<td style="white-space: normal;">mixed</td>
<td><p>the value of the property</p></td>
<td></td>
</tr>
<tr>
<td>$prefixes</td>
<td style="white-space: normal;">array</td>
<td><p>optional list of supported prefixes</p></td>
<td>array()</td>
</tr>
</tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>throws</td>
<td>if strict checks are on and the property prefix is not in the list of prefixes.</td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="base.inc.html#%5COpenCloud%5CBase::SetProperty()"><small>\OpenCloud\Base::SetProperty()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::SetProperty()"><small>\OpenCloud\ObjectStore\ObjStoreBase::SetProperty()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::Update()"></a><h3>Update<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">boolean</span>
</h3>
<h4>Description</h4>
<em>Updates the metadata for a container</em><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>boolean</td>
<td>TRUE on success; FALSE on failure</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>throws</td>
<td></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::Url()"></a><h3>Url<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">string</span>
</h3>
<h4>Description</h4>
<em>Returns the URL of the container</em><br><small><p>The assumption is that nearly all objects will have a URL; at this
base level, it simply throws an exception to enforce the idea that
subclasses need to define this method.</p></small><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>string</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>throws</td>
<td></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::__construct()"></a><h3>__construct<span class="nb-faded-text">(
          \OpenCloud\ObjectStore\OpenCloud\ObjectStore
             
            $service,
          mixed
             
            $cdata
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Creates the container object</em><br><small><p>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.</p></small><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody>
<tr>
<td>$service</td>
<td style="white-space: normal;">\OpenCloud\ObjectStore\OpenCloud\ObjectStore</td>
<td><ul>
<li>the ObjectStore service</li>
</ul>
</td>
<td></td>
</tr>
<tr>
<td>$cdata</td>
<td style="white-space: normal;">mixed</td>
<td><ul>
<li>if supplied, the name of the object</li>
</ul>
</td>
<td>NULL</td>
</tr>
</tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::__set()"></a><h3>__set<span class="nb-faded-text">(
          string
             
            $property,
          mixed
             
            $value,
          
          )
        </span>
        :
        <span class="nb-faded-text">void</span>
</h3>
<h4>Description</h4>
<em>Sets extended attributes on an object and validates them</em><br><small><p>This function is provided to ensure that attributes cannot
arbitrarily added to an object. If this function is called, it
means that the attribute is not defined on the object, and thus
an exception is thrown.</p></small><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody>
<tr>
<td>$property</td>
<td style="white-space: normal;">string</td>
<td><p>the name of the attribute</p></td>
<td></td>
</tr>
<tr>
<td>$value</td>
<td style="white-space: normal;">mixed</td>
<td><p>the value of the attribute</p></td>
<td></td>
</tr>
</tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>void</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>inherited_from</td>
<td><a href="base.inc.html#%5COpenCloud%5CBase::__set()"><small>\OpenCloud\Base::__set()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::__set()"><small>\OpenCloud\ObjectStore\ObjStoreBase::__set()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::debug()"></a><h3>debug<span class="nb-faded-text">(
          string
             
            $msg,
          mixed
             
            $p1
            = NULL,
          mixed
             
            $p2
            = NULL,
          mixed
             
            $p3
            = NULL,
          mixed
             
            $p4
            = NULL,
          mixed
             
            $p5
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">void</span>
</h3>
<h4>Description</h4>
<em>Displays a debug message if $RAXSDK_DEBUG is TRUE</em><br><small><p>The primary parameter is a string in sprintf() format, and it can accept
up to five optional parameters. It prints the debug message, prefixed
with "Debug:" and the class name, to the standard output device.</p>

<p>Example:
  <code>$this-&gt;debug('Starting execution of %s', get_class($this))</code></p></small><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody>
<tr>
<td>$msg</td>
<td style="white-space: normal;">string</td>
<td><p>The message string (required); can be in sprintf() format.</p>
</td>
<td></td>
</tr>
<tr>
<td>$p1</td>
<td style="white-space: normal;">mixed</td>
<td><p>Optional argument to be passed to sprintf()</p>
</td>
<td>NULL</td>
</tr>
<tr>
<td>$p2</td>
<td style="white-space: normal;">mixed</td>
<td><p>Optional argument to be passed to sprintf()</p>
</td>
<td>NULL</td>
</tr>
<tr>
<td>$p3</td>
<td style="white-space: normal;">mixed</td>
<td><p>Optional argument to be passed to sprintf()</p>
</td>
<td>NULL</td>
</tr>
<tr>
<td>$p4</td>
<td style="white-space: normal;">mixed</td>
<td><p>Optional argument to be passed to sprintf()</p>
</td>
<td>NULL</td>
</tr>
<tr>
<td>$p5</td>
<td style="white-space: normal;">mixed</td>
<td><p>Optional argument to be passed to sprintf()</p>
</td>
<td>NULL</td>
</tr>
</tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>void</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>inherited_from</td>
<td><a href="base.inc.html#%5COpenCloud%5CBase::debug()"><small>\OpenCloud\Base::debug()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::debug()"><small>\OpenCloud\ObjectStore\ObjStoreBase::debug()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::is_valid_name()"></a><h3>is_valid_name<span class="nb-faded-text">(
          string
             
            $name,
          
          )
        </span>
        :
        <span class="nb-faded-text">boolean</span>
</h3>
<h4>Description</h4>
<em>Validates that the container name is acceptable</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$name</td>
<td style="white-space: normal;">string</td>
<td><p>the container name to validate</p></td>
<td></td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>boolean</td>
<td>TRUE if ok; throws an exception if not</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>throws</td>
<td></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="CDNContainer::to_string()"></a><h3>to_string<span class="nb-faded-text">(
          mixed
             
            $x,
          
          )
        </span>
        :
        <span class="nb-faded-text">string</span>
</h3>
<h4>Description</h4>
<em>Converts a value to an HTTP-displayable string form</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$x</td>
<td style="white-space: normal;">mixed</td>
<td><p>a value to convert</p></td>
<td></td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>string</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>inherited_from</td>
<td><a href="base.inc.html#%5COpenCloud%5CBase::to_string()"><small>\OpenCloud\Base::to_string()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::to_string()"><small>\OpenCloud\ObjectStore\ObjStoreBase::to_string()</small></a></td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="properties_CDNContainer">
<h4>Properties</h4>
<a href="#CDNContainer::%24_cdn">$_cdn</a>,
      <a href="#CDNContainer::%24_errors">$_errors</a>,
      <a href="#CDNContainer::%24bytes">$bytes</a>,
      <a href="#CDNContainer::%24container_url">$container_url</a>,
      <a href="#CDNContainer::%24count">$count</a>,
      <a href="#CDNContainer::%24http_headers">$http_headers</a>,
      <a href="#CDNContainer::%24metadata">$metadata</a>,
      <a href="#CDNContainer::%24name">$name</a>,
      <a href="#CDNContainer::%24service">$service</a>,
      <div class="method">
<a id="CDNContainer::$_cdn"></a><h3>
<span class="nb-faded-text"> 
          private 
          </span>$_cdn
          =
          </h3>
<em></em><br>
</div>
<div class="method">
<a id="CDNContainer::$_errors"></a><h3>
<span class="nb-faded-text"> 
          private 
          </span>$_errors
          =
          array()</h3>
<em></em><br>
</div>
<div class="method">
<a id="CDNContainer::$bytes"></a><h3>
<span class="nb-faded-text"> 
          public 
          </span>$bytes
          =
          0</h3>
<em></em><br>
</div>
<div class="method">
<a id="CDNContainer::$container_url"></a><h3>
<span class="nb-faded-text"> 
          private 
          </span>$container_url
          =
          </h3>
<em></em><br>
</div>
<div class="method">
<a id="CDNContainer::$count"></a><h3>
<span class="nb-faded-text"> 
          public 
          </span>$count
          =
          0</h3>
<em></em><br>
</div>
<div class="method">
<a id="CDNContainer::$http_headers"></a><h3>
<span class="nb-faded-text"> 
          private 
          </span>$http_headers
          =
          array()</h3>
<em></em><br>
</div>
<div class="method">
<a id="CDNContainer::$metadata"></a><h3>
<span class="nb-faded-text"> 
          public 
          </span>$metadata
          =
          </h3>
<em></em><br>
</div>
<div class="method">
<a id="CDNContainer::$name"></a><h3>
<span class="nb-faded-text"> 
          public 
          </span>$name
          =
          </h3>
<em></em><br>
</div>
<div class="method">
<a id="CDNContainer::$service"></a><h3>
<span class="nb-faded-text"> 
          private 
          </span>$service
          =
          </h3>
<em></em><br>
</div>
</div>
<div id="constants_CDNContainer">
<h4>Constants</h4>
<a id="CDNContainer::ACCOUNT_META_PREFIX"></a><div class="constant">
<h3>
<span class="nb-faded-text"> 
        </span>ACCOUNT_META_PREFIX<span class="nb-faded-text">
         = 'X-Account-'</span>
</h3>
<em></em><br><br>
</div>
<a id="CDNContainer::CDNCONTAINER_META_PREFIX"></a><div class="constant">
<h3>
<span class="nb-faded-text"> 
        </span>CDNCONTAINER_META_PREFIX<span class="nb-faded-text">
         = 'X-Cdn-'</span>
</h3>
<em></em><br><br>
</div>
<a id="CDNContainer::CONTAINER_META_PREFIX"></a><div class="constant">
<h3>
<span class="nb-faded-text"> 
        </span>CONTAINER_META_PREFIX<span class="nb-faded-text">
         = 'X-Container-Meta-'</span>
</h3>
<em></em><br><br>
</div>
<a id="CDNContainer::OBJECT_META_PREFIX"></a><div class="constant">
<h3>
<span class="nb-faded-text"> 
        </span>OBJECT_META_PREFIX<span class="nb-faded-text">
         = 'X-Object-Meta-'</span>
</h3>
<em></em><br><br>
</div>
</div>
<div style="clear: both"></div>
</div>
<div id="Container" class="class">
<h3>Container</h3>
<div class="properties">
<h1>Properties</h1>
<label class="property-key">Extends</label><div class="property-value">
<a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer">\OpenCloud\ObjectStore\CDNContainer</a>
         </div>
<label class="property-key">Implements</label><div class="property-value"> 
      </div>
<label class="property-key">author</label><div class="property-value">
<a title="" href="mailto:hide@address.com">Glen Campbell</a>
             
        </div>
<label class="property-key">Abstract</label><div class="property-value">No 
      </div>
<label class="property-key">Final</label><div class="property-value">No 
      </div>
</div>
<h4>Description</h4>
<em>A regular container with a (potentially) CDN container</em><br><p>This is the main entry point; CDN containers should only be used internally.</p><br><div id="methods_Container">
<h4>Methods</h4>
<a style="font-style: italic;" href="#Container::CDN()">CDN</a>,
      <a style="font-style: italic;" href="#Container::CDNURI()">CDNURI</a>,
      <a style="font-style: italic;" href="#Container::CDNURL()">CDNURL</a>,
      <a style="font-style: italic;" href="#Container::CDNinfo()">CDNinfo</a>,
      <a style="font-style: italic;" href="#Container::CheckAttributePrefix()">CheckAttributePrefix</a>,
      <a style="font-style: italic;" href="#Container::CheckJsonError()">CheckJsonError</a>,
      <a style="font-style: italic;" href="#Container::Create()">Create</a>,
      <a style="font-style: italic;" href="#Container::CreateStaticSite()">CreateStaticSite</a>,
      <a style="font-style: italic;" href="#Container::DataObject()">DataObject</a>,
      <a style="font-style: italic;" href="#Container::Delete()">Delete</a>,
      <a style="font-style: italic;" href="#Container::DisableCDN()">DisableCDN</a>,
      <a style="font-style: italic;" href="#Container::EnableCDN()">EnableCDN</a>,
      <a style="font-style: italic;" href="#Container::GetHttpRequestObject()">GetHttpRequestObject</a>,
      <a style="font-style: italic;" href="#Container::GetMetadata()">GetMetadata</a>,
      <a style="font-style: italic;" href="#Container::JsonCollectionElement()">JsonCollectionElement</a>,
      <a style="font-style: italic;" href="#Container::JsonCollectionName()">JsonCollectionName</a>,
      <a style="font-style: italic;" href="#Container::JsonName()">JsonName</a>,
      <a style="font-style: italic;" href="#Container::MakeQueryString()">MakeQueryString</a>,
      <a style="font-style: italic;" href="#Container::MetadataHeaders()">MetadataHeaders</a>,
      <a style="font-style: italic;" href="#Container::Name()">Name</a>,
      <a style="font-style: italic;" href="#Container::ObjectList()">ObjectList</a>,
      <a style="font-style: italic;" href="#Container::Prefix()">Prefix</a>,
      <a style="font-style: italic;" href="#Container::PublicURL()">PublicURL</a>,
      <a style="font-style: italic;" href="#Container::PublishToCDN()">PublishToCDN</a>,
      <a style="font-style: italic;" href="#Container::Refresh()">Refresh</a>,
      <a style="font-style: italic;" href="#Container::SSLURI()">SSLURI</a>,
      <a style="font-style: italic;" href="#Container::Service()">Service</a>,
      <a style="font-style: italic;" href="#Container::SetProperty()">SetProperty</a>,
      <a style="font-style: italic;" href="#Container::StaticSiteErrorPage()">StaticSiteErrorPage</a>,
      <a style="font-style: italic;" href="#Container::StreamingURI()">StreamingURI</a>,
      <a style="font-style: italic;" href="#Container::Update()">Update</a>,
      <a style="font-style: italic;" href="#Container::Url()">Url</a>,
      <a style="font-style: italic;" href="#Container::__construct()">__construct</a>,
      <a style="font-style: italic;" href="#Container::__set()">__set</a>,
      <a style="font-style: italic;" href="#Container::debug()">debug</a>,
      <a style="font-style: italic;" href="#Container::is_valid_name()">is_valid_name</a>,
      <a style="font-style: italic;" href="#Container::to_string()">to_string</a>,
      <div class="method">
<a id="Container::CDN()"></a><h3>CDN<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Returns the CDN service associated with this container.</em><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Container::CDNURI()"></a><h3>CDNURI<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">string</span>
</h3>
<h4>Description</h4>
<em>Returns the CDN container URI prefix</em><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>string</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>api</td>
<td></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Container::CDNURL()"></a><h3>CDNURL<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">string</span>
</h3>
<h4>Description</h4>
<em>Returns the CDN URL of the container (if enabled)</em><br><small><p>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.</p></small><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>string</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>api</td>
<td></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Container::CDNinfo()"></a><h3>CDNinfo<span class="nb-faded-text">(
          
             
            $prop
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">\OpenCloud\ObjectStore\stdClass</span>
</h3>
<h4>Description</h4>
<em>Returns the CDN info about the container</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$prop</td>
<td style="white-space: normal;">n/a</td>
<td></td>
<td>NULL</td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>\OpenCloud\ObjectStore\stdClass</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>api</td>
<td></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Container::CheckAttributePrefix()"></a><h3>CheckAttributePrefix<span class="nb-faded-text">(
          string
             
            $property,
          array
             
            $prefixes
            = array(),
          
          )
        </span>
        :
        <span class="nb-faded-text">boolean</span>
</h3>
<h4>Description</h4>
<em>Checks the attribute $property and only permits it if the prefix is
in the specified $prefixes array</em><br><small><p>This is to support extension namespaces in some services.</p></small><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody>
<tr>
<td>$property</td>
<td style="white-space: normal;">string</td>
<td><p>the name of the attribute</p></td>
<td></td>
</tr>
<tr>
<td>$prefixes</td>
<td style="white-space: normal;">array</td>
<td><p>a list of prefixes</p></td>
<td>array()</td>
</tr>
</tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>boolean</td>
<td>TRUE if valid; FALSE if not</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>inherited_from</td>
<td><a href="base.inc.html#%5COpenCloud%5CBase::CheckAttributePrefix()"><small>\OpenCloud\Base::CheckAttributePrefix()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::CheckAttributePrefix()"><small>\OpenCloud\ObjectStore\ObjStoreBase::CheckAttributePrefix()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::CheckAttributePrefix()"><small>\OpenCloud\ObjectStore\CDNContainer::CheckAttributePrefix()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::CheckJsonError()"></a><h3>CheckJsonError<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">boolean</span>
</h3>
<h4>Description</h4>
<em>Checks the most recent JSON operation for errors</em><br><small><p>This function should be called after any <code>json_*()</code> function call.
This ensures that nasty JSON errors are detected and the proper
exception thrown.</p>

<p>Example:
  <code>$obj = json_decode($string);</code>
  <code>if (check_json_error()) do something ...</code></p></small><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>boolean</td>
<td>TRUE if an error occurred, FALSE if none</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>throws</td>
<td></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="base.inc.html#%5COpenCloud%5CBase::CheckJsonError()"><small>\OpenCloud\Base::CheckJsonError()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::CheckJsonError()"><small>\OpenCloud\ObjectStore\ObjStoreBase::CheckJsonError()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::CheckJsonError()"><small>\OpenCloud\ObjectStore\CDNContainer::CheckJsonError()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::Create()"></a><h3>Create<span class="nb-faded-text">(
          array
             
            $params
            = array(),
          
          )
        </span>
        :
        <span class="nb-faded-text">boolean</span>
</h3>
<h4>Description</h4>
<em>Creates a new container with the specified attributes</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$params</td>
<td style="white-space: normal;">array</td>
<td><p>array of parameters</p></td>
<td>array()</td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>boolean</td>
<td>TRUE on success; FALSE on failure</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>throws</td>
<td></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::Create()"><small>\OpenCloud\ObjectStore\CDNContainer::Create()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::CreateStaticSite()"></a><h3>CreateStaticSite<span class="nb-faded-text">(
          string
             
            $index,
          
          )
        </span>
        :
        <span class="nb-faded-text">\OpenCloud\HttpResponse</span>
</h3>
<h4>Description</h4>
<em>Creates a static website from the container</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$index</td>
<td style="white-space: normal;">string</td>
<td><p>the index page (starting page) of the website</p>
</td>
<td></td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>\OpenCloud\HttpResponse</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>api</td>
<td></td>
</tr>
<tr>
<td>link</td>
<td><a href="http://docs.rackspace.com/files/api/v1/cf-devguide/content/Create_Static_Website-dle4000.html"><small>http://docs.rackspace.com/files/api/v1/cf-devguide/content/Create_Static_Website-dle4000.html</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::DataObject()"></a><h3>DataObject<span class="nb-faded-text">(
          string
             
            $name
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">\OpenCloud\ObjectStore\DataObject</span>
</h3>
<h4>Description</h4>
<em>Returns a new DataObject associated with this container</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$name</td>
<td style="white-space: normal;">string</td>
<td><p>if supplied, the name of the object to return</p></td>
<td>NULL</td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>\OpenCloud\ObjectStore\DataObject</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::DataObject()"><small>\OpenCloud\ObjectStore\CDNContainer::DataObject()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Container::Delete()"></a><h3>Delete<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">boolean</span>
</h3>
<h4>Description</h4>
<em>Deletes the specified container</em><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>boolean</td>
<td>TRUE on success; FALSE on failure</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>throws</td>
<td></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::Delete()"><small>\OpenCloud\ObjectStore\CDNContainer::Delete()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::DisableCDN()"></a><h3>DisableCDN<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">void</span>
</h3>
<h4>Description</h4>
<em>Disables the containers CDN function.</em><br><small><p>Note that the container will still be available on the CDN until
its TTL expires.</p></small><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>void</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>api</td>
<td></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Container::EnableCDN()"></a><h3>EnableCDN<span class="nb-faded-text">(
          integer
             
            $TTL
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">\OpenCloud\ObjectStore\CDNContainer</span>
</h3>
<h4>Description</h4>
<em>Makes the container public via the CDN</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$TTL</td>
<td style="white-space: normal;">integer</td>
<td><p>the Time-To-Live for the CDN container; if NULL, then the cloud's default value will be used for caching.</p>
</td>
<td>NULL</td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>\OpenCloud\ObjectStore\CDNContainer</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>api</td>
<td></td>
</tr>
<tr>
<td>throws</td>
<td>if CDN services are not available</td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::GetHttpRequestObject()"></a><h3>GetHttpRequestObject<span class="nb-faded-text">(
          
             
            $url,
          
             
            $method
            = 'GET',
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Returns a class that implements the HttpRequest interface.</em><br><small><p>This can be stubbed out for unit testing and avoid making live calls.</p></small><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody>
<tr>
<td>$url</td>
<td style="white-space: normal;">n/a</td>
<td></td>
<td></td>
</tr>
<tr>
<td>$method</td>
<td style="white-space: normal;">n/a</td>
<td></td>
<td>'GET'</td>
</tr>
</tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>inherited_from</td>
<td><a href="base.inc.html#%5COpenCloud%5CBase::GetHttpRequestObject()"><small>\OpenCloud\Base::GetHttpRequestObject()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::GetHttpRequestObject()"><small>\OpenCloud\ObjectStore\ObjStoreBase::GetHttpRequestObject()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::GetHttpRequestObject()"><small>\OpenCloud\ObjectStore\CDNContainer::GetHttpRequestObject()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::GetMetadata()"></a><h3>GetMetadata<span class="nb-faded-text">(
          
             
            $response,
          
          )
        </span>
        :
        <span class="nb-faded-text">void</span>
</h3>
<h4>Description</h4>
<em>Given an HttpResponse object, converts the appropriate headers
to metadata</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$response</td>
<td style="white-space: normal;">n/a</td>
<td><p>\OpenCloud\HttpResponse</p>
</td>
<td></td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>void</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::GetMetadata()"><small>\OpenCloud\ObjectStore\ObjStoreBase::GetMetadata()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::GetMetadata()"><small>\OpenCloud\ObjectStore\CDNContainer::GetMetadata()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::JsonCollectionElement()"></a><h3>JsonCollectionElement<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::JsonCollectionElement()"><small>\OpenCloud\ObjectStore\ObjStoreBase::JsonCollectionElement()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::JsonCollectionElement()"><small>\OpenCloud\ObjectStore\CDNContainer::JsonCollectionElement()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::JsonCollectionName()"></a><h3>JsonCollectionName<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::JsonCollectionName()"><small>\OpenCloud\ObjectStore\ObjStoreBase::JsonCollectionName()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::JsonCollectionName()"><small>\OpenCloud\ObjectStore\CDNContainer::JsonCollectionName()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::JsonName()"></a><h3>JsonName<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::JsonName()"><small>\OpenCloud\ObjectStore\ObjStoreBase::JsonName()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::JsonName()"><small>\OpenCloud\ObjectStore\CDNContainer::JsonName()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::MakeQueryString()"></a><h3>MakeQueryString<span class="nb-faded-text">(
          array
             
            $arr,
          
          )
        </span>
        :
        <span class="nb-faded-text">string</span>
</h3>
<h4>Description</h4>
<em>Converts an array of key/value pairs into a single query string</em><br><small><p>For example, array('A'=>1,'B'=>2) would become 'A=1&amp;B=2'.</p></small><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$arr</td>
<td style="white-space: normal;">array</td>
<td><p>array of key/value pairs</p>
</td>
<td></td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>string</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>inherited_from</td>
<td><a href="base.inc.html#%5COpenCloud%5CBase::MakeQueryString()"><small>\OpenCloud\Base::MakeQueryString()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::MakeQueryString()"><small>\OpenCloud\ObjectStore\ObjStoreBase::MakeQueryString()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::MakeQueryString()"><small>\OpenCloud\ObjectStore\CDNContainer::MakeQueryString()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::MetadataHeaders()"></a><h3>MetadataHeaders<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">\OpenCloud\ObjectStore\array;</span>
</h3>
<h4>Description</h4>
<em>If object has metadata, returns an associative array of headers</em><br><small><p>For example, if a DataObject has a metadata item named 'FOO',
then this would return array('X-Object-Meta-FOO'=>$value);</p></small><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>\OpenCloud\ObjectStore\array;</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::MetadataHeaders()"><small>\OpenCloud\ObjectStore\ObjStoreBase::MetadataHeaders()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::MetadataHeaders()"><small>\OpenCloud\ObjectStore\CDNContainer::MetadataHeaders()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::Name()"></a><h3>Name<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Returns the displayable name of the object</em><br><small><p>Can be overridden by child objects; <em>must</em> be overridden by child
objects if the object does not have a <code>name</code> attribute defined.</p></small><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>api</td>
<td></td>
</tr>
<tr>
<td>throws</td>
<td>if attribute 'name' is not defined</td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::Name()"><small>\OpenCloud\ObjectStore\ObjStoreBase::Name()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::Name()"><small>\OpenCloud\ObjectStore\CDNContainer::Name()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::ObjectList()"></a><h3>ObjectList<span class="nb-faded-text">(
          array
             
            $params
            = array(),
          
          )
        </span>
        :
        <span class="nb-faded-text">\OpenCloud\ObjectStore\OpenCloud\Collection</span>
</h3>
<h4>Description</h4>
<em>Creates a Collection of objects in the container</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$params</td>
<td style="white-space: normal;">array</td>
<td><p>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.</p>
</td>
<td>array()</td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>\OpenCloud\ObjectStore\OpenCloud\Collection</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>link</td>
<td><a href="http://api.openstack.org"><small>for a list of possible parameter
names and values</small></a></td>
</tr>
<tr>
<td>throws</td>
<td></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::ObjectList()"><small>\OpenCloud\ObjectStore\CDNContainer::ObjectList()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::Prefix()"></a><h3>Prefix<span class="nb-faded-text">(
          string
             
            $type
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Returns the proper prefix for the specified type of object</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$type</td>
<td style="white-space: normal;">string</td>
<td><p>The type of object; derived from <code>get_class()</code> if not specified.</p>
</td>
<td>NULL</td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::Prefix()"><small>\OpenCloud\ObjectStore\ObjStoreBase::Prefix()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::Prefix()"><small>\OpenCloud\ObjectStore\CDNContainer::Prefix()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::PublicURL()"></a><h3>PublicURL<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Returns the Public URL of the container (on the CDN network)</em><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Container::PublishToCDN()"></a><h3>PublishToCDN<span class="nb-faded-text">(
          
             
            $TTL
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>a synonym for PublishToCDN for backwards-compatibility</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$TTL</td>
<td style="white-space: normal;">n/a</td>
<td></td>
<td>NULL</td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>api</td>
<td></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Container::Refresh()"></a><h3>Refresh<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">void</span>
</h3>
<h4>Description</h4>
<em>Refreshes, then associates the CDN container</em><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>void</td>
<td></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Container::SSLURI()"></a><h3>SSLURI<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">string</span>
</h3>
<h4>Description</h4>
<em>Returns the SSL URI for the container</em><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>string</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>api</td>
<td></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Container::Service()"></a><h3>Service<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Returns the Service associated with the Container</em><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::Service()"><small>\OpenCloud\ObjectStore\CDNContainer::Service()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Container::SetProperty()"></a><h3>SetProperty<span class="nb-faded-text">(
          string
             
            $property,
          mixed
             
            $value,
          array
             
            $prefixes
            = array(),
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Sets an extended (unrecognized) property on the current object</em><br><small><p>If RAXSDK_STRICT_PROPERTY_CHECKS is TRUE, then the prefix of the
property name must appear in the $prefixes array, or else an
exception is thrown.</p></small><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody>
<tr>
<td>$property</td>
<td style="white-space: normal;">string</td>
<td><p>the property name</p></td>
<td></td>
</tr>
<tr>
<td>$value</td>
<td style="white-space: normal;">mixed</td>
<td><p>the value of the property</p></td>
<td></td>
</tr>
<tr>
<td>$prefixes</td>
<td style="white-space: normal;">array</td>
<td><p>optional list of supported prefixes</p></td>
<td>array()</td>
</tr>
</tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>throws</td>
<td>if strict checks are on and the property prefix is not in the list of prefixes.</td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="base.inc.html#%5COpenCloud%5CBase::SetProperty()"><small>\OpenCloud\Base::SetProperty()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::SetProperty()"><small>\OpenCloud\ObjectStore\ObjStoreBase::SetProperty()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::SetProperty()"><small>\OpenCloud\ObjectStore\CDNContainer::SetProperty()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::StaticSiteErrorPage()"></a><h3>StaticSiteErrorPage<span class="nb-faded-text">(
          string
             
            $name,
          
          )
        </span>
        :
        <span class="nb-faded-text">\OpenCloud\HttpResponse</span>
</h3>
<h4>Description</h4>
<em>Sets the error page(s) for the static website</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$name</td>
<td style="white-space: normal;">string</td>
<td><p>the name of the error page</p></td>
<td></td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>\OpenCloud\HttpResponse</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>api</td>
<td></td>
</tr>
<tr>
<td>link</td>
<td><a href="http://docs.rackspace.com/files/api/v1/cf-devguide/content/Set_Error_Pages_for_Static_Website-dle4005.html"><small>http://docs.rackspace.com/files/api/v1/cf-devguide/content/Set_Error_Pages_for_Static_Website-dle4005.html</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::StreamingURI()"></a><h3>StreamingURI<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">string</span>
</h3>
<h4>Description</h4>
<em>Returns the streaming URI for the container</em><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>string</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>api</td>
<td></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Container::Update()"></a><h3>Update<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">boolean</span>
</h3>
<h4>Description</h4>
<em>Updates the metadata for a container</em><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>boolean</td>
<td>TRUE on success; FALSE on failure</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>throws</td>
<td></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::Update()"><small>\OpenCloud\ObjectStore\CDNContainer::Update()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::Url()"></a><h3>Url<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">string</span>
</h3>
<h4>Description</h4>
<em>Returns the URL of the container</em><br><small><p>The assumption is that nearly all objects will have a URL; at this
base level, it simply throws an exception to enforce the idea that
subclasses need to define this method.</p></small><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>string</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>throws</td>
<td></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::Url()"><small>\OpenCloud\ObjectStore\CDNContainer::Url()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::__construct()"></a><h3>__construct<span class="nb-faded-text">(
          \OpenCloud\ObjectStore\OpenCloud\ObjectStore
             
            $service,
          mixed
             
            $cdata
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Creates the container object</em><br><small><p>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.</p></small><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody>
<tr>
<td>$service</td>
<td style="white-space: normal;">\OpenCloud\ObjectStore\OpenCloud\ObjectStore</td>
<td><ul>
<li>the ObjectStore service</li>
</ul>
</td>
<td></td>
</tr>
<tr>
<td>$cdata</td>
<td style="white-space: normal;">mixed</td>
<td><ul>
<li>if supplied, the name of the object</li>
</ul>
</td>
<td>NULL</td>
</tr>
</tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>n/a</td>
<td>n/a</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::__construct()"><small>\OpenCloud\ObjectStore\CDNContainer::__construct()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Container::__set()"></a><h3>__set<span class="nb-faded-text">(
          string
             
            $property,
          mixed
             
            $value,
          
          )
        </span>
        :
        <span class="nb-faded-text">void</span>
</h3>
<h4>Description</h4>
<em>Sets extended attributes on an object and validates them</em><br><small><p>This function is provided to ensure that attributes cannot
arbitrarily added to an object. If this function is called, it
means that the attribute is not defined on the object, and thus
an exception is thrown.</p></small><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody>
<tr>
<td>$property</td>
<td style="white-space: normal;">string</td>
<td><p>the name of the attribute</p></td>
<td></td>
</tr>
<tr>
<td>$value</td>
<td style="white-space: normal;">mixed</td>
<td><p>the value of the attribute</p></td>
<td></td>
</tr>
</tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>void</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>inherited_from</td>
<td><a href="base.inc.html#%5COpenCloud%5CBase::__set()"><small>\OpenCloud\Base::__set()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::__set()"><small>\OpenCloud\ObjectStore\ObjStoreBase::__set()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::__set()"><small>\OpenCloud\ObjectStore\CDNContainer::__set()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::debug()"></a><h3>debug<span class="nb-faded-text">(
          string
             
            $msg,
          mixed
             
            $p1
            = NULL,
          mixed
             
            $p2
            = NULL,
          mixed
             
            $p3
            = NULL,
          mixed
             
            $p4
            = NULL,
          mixed
             
            $p5
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">void</span>
</h3>
<h4>Description</h4>
<em>Displays a debug message if $RAXSDK_DEBUG is TRUE</em><br><small><p>The primary parameter is a string in sprintf() format, and it can accept
up to five optional parameters. It prints the debug message, prefixed
with "Debug:" and the class name, to the standard output device.</p>

<p>Example:
  <code>$this-&gt;debug('Starting execution of %s', get_class($this))</code></p></small><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody>
<tr>
<td>$msg</td>
<td style="white-space: normal;">string</td>
<td><p>The message string (required); can be in sprintf() format.</p>
</td>
<td></td>
</tr>
<tr>
<td>$p1</td>
<td style="white-space: normal;">mixed</td>
<td><p>Optional argument to be passed to sprintf()</p>
</td>
<td>NULL</td>
</tr>
<tr>
<td>$p2</td>
<td style="white-space: normal;">mixed</td>
<td><p>Optional argument to be passed to sprintf()</p>
</td>
<td>NULL</td>
</tr>
<tr>
<td>$p3</td>
<td style="white-space: normal;">mixed</td>
<td><p>Optional argument to be passed to sprintf()</p>
</td>
<td>NULL</td>
</tr>
<tr>
<td>$p4</td>
<td style="white-space: normal;">mixed</td>
<td><p>Optional argument to be passed to sprintf()</p>
</td>
<td>NULL</td>
</tr>
<tr>
<td>$p5</td>
<td style="white-space: normal;">mixed</td>
<td><p>Optional argument to be passed to sprintf()</p>
</td>
<td>NULL</td>
</tr>
</tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>void</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>inherited_from</td>
<td><a href="base.inc.html#%5COpenCloud%5CBase::debug()"><small>\OpenCloud\Base::debug()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::debug()"><small>\OpenCloud\ObjectStore\ObjStoreBase::debug()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::debug()"><small>\OpenCloud\ObjectStore\CDNContainer::debug()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::is_valid_name()"></a><h3>is_valid_name<span class="nb-faded-text">(
          string
             
            $name,
          
          )
        </span>
        :
        <span class="nb-faded-text">boolean</span>
</h3>
<h4>Description</h4>
<em>Validates that the container name is acceptable</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$name</td>
<td style="white-space: normal;">string</td>
<td><p>the container name to validate</p></td>
<td></td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>boolean</td>
<td>TRUE if ok; throws an exception if not</td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>throws</td>
<td></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::is_valid_name()"><small>\OpenCloud\ObjectStore\CDNContainer::is_valid_name()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Container::to_string()"></a><h3>to_string<span class="nb-faded-text">(
          mixed
             
            $x,
          
          )
        </span>
        :
        <span class="nb-faded-text">string</span>
</h3>
<h4>Description</h4>
<em>Converts a value to an HTTP-displayable string form</em><br><h4>Arguments</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
</tr></thead>
<tbody><tr>
<td>$x</td>
<td style="white-space: normal;">mixed</td>
<td><p>a value to convert</p></td>
<td></td>
</tr></tbody>
</table>
<h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>string</td>
<td></td>
</tr></tbody>
</table>
<h4>Tags</h4>
<table>
<thead><tr>
<th>Name</th>
<th>Description</th>
</tr></thead>
<tbody>
<tr>
<td>inherited_from</td>
<td><a href="base.inc.html#%5COpenCloud%5CBase::to_string()"><small>\OpenCloud\Base::to_string()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="objstorebase.inc.html#%5COpenCloud%5CObjectStore%5CObjStoreBase::to_string()"><small>\OpenCloud\ObjectStore\ObjStoreBase::to_string()</small></a></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="container.inc.html#%5COpenCloud%5CObjectStore%5CCDNContainer::to_string()"><small>\OpenCloud\ObjectStore\CDNContainer::to_string()</small></a></td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="properties_Container">
<h4>Properties</h4>
<a href="#Container::%24_cdn">$_cdn</a>,
      <a href="#Container::%24_errors">$_errors</a>,
      <a href="#Container::%24bytes">$bytes</a>,
      <a href="#Container::%24container_url">$container_url</a>,
      <a href="#Container::%24count">$count</a>,
      <a href="#Container::%24http_headers">$http_headers</a>,
      <a href="#Container::%24metadata">$metadata</a>,
      <a href="#Container::%24name">$name</a>,
      <a href="#Container::%24service">$service</a>,
      <div class="method">
<a id="Container::$_cdn"></a><h3>
<span class="nb-faded-text"> 
          private 
          </span>$_cdn
          =
          </h3>
<em></em><br>
</div>
<div class="method">
<a id="Container::$_errors"></a><h3>
<span class="nb-faded-text"> 
          private 
          </span>$_errors
          =
          array()</h3>
<em></em><br>
</div>
<div class="method">
<a id="Container::$bytes"></a><h3>
<span class="nb-faded-text"> 
          public 
          </span>$bytes
          =
          0</h3>
<em></em><br>
</div>
<div class="method">
<a id="Container::$container_url"></a><h3>
<span class="nb-faded-text"> 
          private 
          </span>$container_url
          =
          </h3>
<em></em><br>
</div>
<div class="method">
<a id="Container::$count"></a><h3>
<span class="nb-faded-text"> 
          public 
          </span>$count
          =
          0</h3>
<em></em><br>
</div>
<div class="method">
<a id="Container::$http_headers"></a><h3>
<span class="nb-faded-text"> 
          private 
          </span>$http_headers
          =
          array()</h3>
<em></em><br>
</div>
<div class="method">
<a id="Container::$metadata"></a><h3>
<span class="nb-faded-text"> 
          public 
          </span>$metadata
          =
          </h3>
<em></em><br>
</div>
<div class="method">
<a id="Container::$name"></a><h3>
<span class="nb-faded-text"> 
          public 
          </span>$name
          =
          </h3>
<em></em><br>
</div>
<div class="method">
<a id="Container::$service"></a><h3>
<span class="nb-faded-text"> 
          private 
          </span>$service
          =
          </h3>
<em></em><br>
</div>
</div>
<div id="constants_Container">
<h4>Constants</h4>
<a id="Container::ACCOUNT_META_PREFIX"></a><div class="constant">
<h3>
<span class="nb-faded-text"> 
        </span>ACCOUNT_META_PREFIX<span class="nb-faded-text">
         = 'X-Account-'</span>
</h3>
<em></em><br><br>
</div>
<a id="Container::CDNCONTAINER_META_PREFIX"></a><div class="constant">
<h3>
<span class="nb-faded-text"> 
        </span>CDNCONTAINER_META_PREFIX<span class="nb-faded-text">
         = 'X-Cdn-'</span>
</h3>
<em></em><br><br>
</div>
<a id="Container::CONTAINER_META_PREFIX"></a><div class="constant">
<h3>
<span class="nb-faded-text"> 
        </span>CONTAINER_META_PREFIX<span class="nb-faded-text">
         = 'X-Container-Meta-'</span>
</h3>
<em></em><br><br>
</div>
<a id="Container::OBJECT_META_PREFIX"></a><div class="constant">
<h3>
<span class="nb-faded-text"> 
        </span>OBJECT_META_PREFIX<span class="nb-faded-text">
         = 'X-Object-Meta-'</span>
</h3>
<em></em><br><br>
</div>
</div>
<div style="clear: both"></div>
</div>
</div>
<small xmlns="" class="footer">Documentation was generated by <a href="http://www.phpdoc.org">phpDocumentor 2.0.0a8</a>.</small></div><div id="index"><div class="padder"><script xmlns="" type="text/javascript">
      $(function() {

        var is_chrome = /chrome/.test( navigator.userAgent.toLowerCase() );
        var is_local = /file:\/\//.test(document.location.href);
        if (is_chrome && is_local)
        {
          // search is disabled on chrome with local files due to http://code.google.com/p/chromium/issues/detail?id=40787
          return;
        }

        $("#search_box").show();
        var search_index = {};
        $.ajax({
          url: "search_index.xml",
          dataType: ($.browser.msie) ? "text" : "xml",
          error: function(data) {
            alert('An error occurred using the search data');
          },
          success: function( data ) {
            var xml;
            if (typeof data == "string") {
              xml = new ActiveXObject("Microsoft.XMLDOM");
              xml.async = false;
              xml.loadXML(data);
            } else {
              xml = data;
            }

            search_index = $("node", xml).map(function() {
              type = $("type", this).text();
              return {
                value: $("value", this).text(),
                label: '<img src="images/icons/'+type+'.png" align="absmiddle">'+$("value", this).text(),
                id: $("id", this).text(),
              };
            }).get();

            $("#search_box").autocomplete({
              source: search_index,
              select: function(event, ui) {
                // redirect to the documentation
                if ((parent) && (parent.content))
                {
                  parent.content.document.location = ''+ui.item.id;
                }
                else
                {
                  jQuery(document).location = ''+ui.item.id;
                }
                applySearchHash();
              }
            });
          }
        });
      });
    </script><input id="search_box"></input><div class="section">
<h1>Namespaces</h1>
<ul id="namespaces-" class="filetree">
<li class="closed">
<span class="folder">OpenCloud</span><ul>
<li><span class="class"><a href="exceptions.inc.html#AttributeError">AttributeError</a><br><small>General Exceptions</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#AuthenticationError">AuthenticationError</a><br><small></small></span></li>
<li><span class="class"><a href="base.inc.html#Base">Base</a><br><small>The Base class is the root class for all other objects used or defined by
this SDK.</small></span></li>
<li><span class="class"><a href="http.inc.html#BlankResponse">BlankResponse</a><br><small>This is a stubbed-out variant of HttpResponse for unit testing</small></span></li>
<li><span class="class"><a href="collection.inc.html#Collection">Collection</a><br><small>Provides an abstraction for working with ordered sets of objects</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#CollectionError">CollectionError</a><br><small></small></span></li>
<li><span class="class"><a href="compute.inc.html#Compute">Compute</a><br><small>The Compute class represents the OpenStack Nova service.</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#CreateError">CreateError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#CredentialError">CredentialError</a><br><small></small></span></li>
<li><span class="class"><a href="http.inc.html#CurlRequest">CurlRequest</a><br><small>The CurlRequest class is a simple wrapper to CURL functions.</small></span></li>
<li><span class="class"><a href="dbservice.inc.html#DbService">DbService</a><br><small>The Rackspace Database As A Service (aka "Red Dwarf")</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#DeleteError">DeleteError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#DocumentError">DocumentError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#DomainError">DomainError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#EmptyResponseError">EmptyResponseError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#EndpointError">EndpointError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#HttpError">HttpError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#HttpForbiddenError">HttpForbiddenError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#HttpOverLimitError">HttpOverLimitError</a><br><small></small></span></li>
<li><span class="interface"><a href="http.inc.html#HttpRequest">HttpRequest</a><br><small>The HttpRequest interface defines methods for wrapping CURL; this allows
those methods to be stubbed out for unit testing, thus allowing us to
test without actually making live calls.</small></span></li>
<li><span class="class"><a href="http.inc.html#HttpResponse">HttpResponse</a><br><small>The HttpResponse returns an object with status information, separated
headers, and any response body necessary.</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#HttpRetryError">HttpRetryError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#HttpTimeoutError">HttpTimeoutError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#HttpUnauthorizedError">HttpUnauthorizedError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#HttpUrlError">HttpUrlError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#IdRequiredError">IdRequiredError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#InstanceNotFound">InstanceNotFound</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#JsonError">JsonError</a><br><small></small></span></li>
<li><span class="class"><a href="lbservice.inc.html#LoadBalancerService">LoadBalancerService</a><br><small>The Rackspace Cloud Load Balancers</small></span></li>
<li><span class="class"><a href="metadata.inc.html#Metadata">Metadata</a><br><small>The Metadata class represents either Server or Image metadata</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#NameError">NameError</a><br><small></small></span></li>
<li><span class="class"><a href="nova.inc.html#Nova">Nova</a><br><small>Nova is an abstraction layer for the OpenStack compute service.</small></span></li>
<li><span class="class"><a href="objectstore.inc.html#ObjectStore">ObjectStore</a><br><small>ObjectStore - this defines the object-store (Cloud Files) service.</small></span></li>
<li><span class="class"><a href="objectstore.inc.html#ObjectStoreBase">ObjectStoreBase</a><br><small>A base class for common code shared between the ObjectStore and ObjectStoreCDN
objects</small></span></li>
<li><span class="class"><a href="objectstore.inc.html#ObjectStoreCDN">ObjectStoreCDN</a><br><small>This is the CDN related to the ObjectStore</small></span></li>
<li><span class="class"><a href="openstack.inc.html#OpenStack">OpenStack</a><br><small>The OpenStack class represents a relationship (or "connection")
between a user and a service.</small></span></li>
<li><span class="class"><a href="persistentobject.inc.html#PersistentObject">PersistentObject</a><br><small>represents an object that has the ability to be
retrieved, created, updated, and deleted.</small></span></li>
<li><span class="class"><a href="rackspace.inc.html#Rackspace">Rackspace</a><br><small>Rackspace extends the OpenStack class with support for Rackspace&#39;s
API key and tenant requirements.</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#ServerActionError">ServerActionError</a><br><small></small></span></li>
<li><span class="class"><a href="service.inc.html#Service">Service</a><br><small>This class defines a "service"—a relationship between a specific OpenStack
and a provided service, represented by a URL in the service catalog.</small></span></li>
<li><span class="class"><a href="openstack.inc.html#ServiceCatalogItem">ServiceCatalogItem</a><br><small>Holds information on a single service from the Service Catalog</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#ServiceValueError">ServiceValueError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#UnknownError">UnknownError</a><br><small>catch-all</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#UnrecognizedServiceError">UnrecognizedServiceError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#UnsupportedExtensionError">UnsupportedExtensionError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#UpdateError">UpdateError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#UrlError">UrlError</a><br><small></small></span></li>
<li><span class="class"><a href="volumeservice.inc.html#VolumeService">VolumeService</a><br><small>Nova is an abstraction layer for the OpenStack compute service.</small></span></li>
<li class="closed">
<span class="folder">Compute</span><ul>
<li><span class="class"><a href="flavor.inc.html#Flavor">Flavor</a><br><small>The Flavor class represents a flavor defined by the Compute service</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#FlavorError">FlavorError</a><br><small></small></span></li>
<li><span class="class"><a href="image.inc.html#Image">Image</a><br><small>The Image class represents a stored machine image returned by the
Compute service.</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#ImageError">ImageError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#InvalidArgumentError">InvalidArgumentError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#InvalidIpTypeError">InvalidIpTypeError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#InvalidParameterError">InvalidParameterError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#InvalidRequestError">InvalidRequestError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#MetadataCreateError">MetadataCreateError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#MetadataDeleteError">MetadataDeleteError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#MetadataError">MetadataError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#MetadataJsonError">MetadataJsonError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#MetadataKeyError">MetadataKeyError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#MetadataUpdateError">MetadataUpdateError</a><br><small></small></span></li>
<li><span class="class"><a href="network.inc.html#Network">Network</a><br><small>The Network class represents a single virtual network</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#NetworkCreateError">NetworkCreateError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#NetworkDeleteError">NetworkDeleteError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#NetworkError">NetworkError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#NetworkUpdateError">NetworkUpdateError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#NetworkUrlError">NetworkUrlError</a><br><small></small></span></li>
<li><span class="class"><a href="server.inc.html#Server">Server</a><br><small>The Server class represents a single server node.</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#ServerCreateError">ServerCreateError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#ServerDeleteError">ServerDeleteError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#ServerIpsError">ServerIpsError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#ServerJsonError">ServerJsonError</a><br><small></small></span></li>
<li><span class="class"><a href="servermetadata.inc.html#ServerMetadata">ServerMetadata</a><br><small>This class handles server metadata</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#ServerUpdateError">ServerUpdateError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#ServerUrlError">ServerUrlError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#UnsupportedFeatureExtension">UnsupportedFeatureExtension</a><br><small></small></span></li>
<li><span class="class"><a href="volumeattachment.inc.html#VolumeAttachment">VolumeAttachment</a><br><small>The VolumeAttachment class represents a volume that is attached
to a server.</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#VolumeError">VolumeError</a><br><small></small></span></li>
</ul>
</li>
<li class="closed">
<span class="folder">DbService</span><ul>
<li><span class="class"><a href="database.inc.html#Database">Database</a><br><small>This class represents a Database in the Rackspace "Red Dwarf"
database-as-a-service product.</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#DatabaseCreateError">DatabaseCreateError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#DatabaseDeleteError">DatabaseDeleteError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#DatabaseListError">DatabaseListError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#DatabaseNameError">DatabaseNameError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#DatabaseUpdateError">DatabaseUpdateError</a><br><small></small></span></li>
<li><span class="class"><a href="instance.inc.html#Instance">Instance</a><br><small>Instance represents an instance of DbService, similar to a Server in a
Compute service</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#InstanceCreateError">InstanceCreateError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#InstanceDeleteError">InstanceDeleteError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#InstanceError">InstanceError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#InstanceFlavorError">InstanceFlavorError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#InstanceUpdateError">InstanceUpdateError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#InvalidIdTypeError">InvalidIdTypeError</a><br><small></small></span></li>
<li><span class="class"><a href="user.inc.html#User">User</a><br><small>This class represents a User in the Rackspace "Red Dwarf"
database-as-a-service product.</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#UserCreateError">UserCreateError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#UserDeleteError">UserDeleteError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#UserListError">UserListError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#UserNameError">UserNameError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#UserUpdateError">UserUpdateError</a><br><small></small></span></li>
</ul>
</li>
<li class="closed">
<span class="folder">LoadBalancerService</span><ul>
<li><span class="class"><a href="lbresources.inc.html#Access">Access</a><br><small>sub-resource to manage access lists</small></span></li>
<li><span class="class"><a href="lbresources.inc.html#Algorithm">Algorithm</a><br><small>sub-resource to manage algorithms (read-only)</small></span></li>
<li><span class="class"><a href="lbresources.inc.html#AllowedDomain">AllowedDomain</a><br><small>sub-resource to manage allowed domains</small></span></li>
<li><span class="class"><a href="lbresources.inc.html#BillableLoadBalancer">BillableLoadBalancer</a><br><small>used to get a list of billable load balancers for a specific date range</small></span></li>
<li><span class="class"><a href="lbresources.inc.html#ConnectionLogging">ConnectionLogging</a><br><small>sub-resource to manage connection logging</small></span></li>
<li><span class="class"><a href="lbresources.inc.html#ConnectionThrottle">ConnectionThrottle</a><br><small>sub-resource to manage connection throttling</small></span></li>
<li><span class="class"><a href="lbresources.inc.html#ContentCaching">ContentCaching</a><br><small>sub-resource to manage content caching</small></span></li>
<li><span class="class"><a href="lbresources.inc.html#ErrorPage">ErrorPage</a><br><small>The /loadbalancer/{id}/errorpage manages the error page for the load
balancer.</small></span></li>
<li><span class="class"><a href="lbresources.inc.html#HealthMonitor">HealthMonitor</a><br><small>sub-resource to read health monitor info</small></span></li>
<li><span class="class"><a href="loadbalancer.inc.html#LoadBalancer">LoadBalancer</a><br><small>The LoadBalancer class represents a single load balancer</small></span></li>
<li><span class="class"><a href="lbresources.inc.html#Metadata">Metadata</a><br><small>sub-resource to manage Metadata</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#MissingValueError">MissingValueError</a><br><small></small></span></li>
<li><span class="class"><a href="lbresources.inc.html#Node">Node</a><br><small>information on a single node in the load balancer</small></span></li>
<li><span class="class"><a href="lbresources.inc.html#NodeEvent">NodeEvent</a><br><small>a single node event, usually called as part of a Collection</small></span></li>
<li><span class="class"><a href="lbresources.inc.html#Protocol">Protocol</a><br><small>sub-resource to manage protocols (read-only)</small></span></li>
<li><span class="class"><a href="lbresources.inc.html#ReadonlySubResource">ReadonlySubResource</a><br><small>This defines a read-only SubResource - one that cannot be created, updated,
or deleted.</small></span></li>
<li><span class="class"><a href="lbresources.inc.html#SSLTermination">SSLTermination</a><br><small>sub-resource to manage SSL termination</small></span></li>
<li><span class="class"><a href="lbresources.inc.html#SessionPersistence">SessionPersistence</a><br><small>sub-resource to manage session persistence setting</small></span></li>
<li><span class="class"><a href="lbresources.inc.html#Stats">Stats</a><br><small>Stats returns statistics about the load balancer</small></span></li>
<li><span class="class"><a href="lbresources.inc.html#SubResource">SubResource</a><br><small>SubResource is an abstract class that handles subresources of a
LoadBalancer object; for example, the
`/loadbalancers/{id}/errorpage`.</small></span></li>
<li><span class="class"><a href="lbresources.inc.html#Usage">Usage</a><br><small>used to get usage data for a load balancer</small></span></li>
<li><span class="class"><a href="lbresources.inc.html#VirtualIp">VirtualIp</a><br><small>VirtualIp represents a single virtual IP (usually returned in a Collection)</small></span></li>
</ul>
</li>
<li class="closed">
<span class="folder">ObjectStore</span><ul>
<li><span class="class"><a href="container.inc.html#CDNContainer">CDNContainer</a><br><small>A simple container for the CDN Service</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#CdnError">CdnError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#CdnHttpError">CdnHttpError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#CdnNotAvailableError">CdnNotAvailableError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#CdnTtlError">CdnTtlError</a><br><small></small></span></li>
<li><span class="class"><a href="container.inc.html#Container">Container</a><br><small>A regular container with a (potentially) CDN container</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#ContainerCreateError">ContainerCreateError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#ContainerDeleteError">ContainerDeleteError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#ContainerError">ContainerError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#ContainerNameError">ContainerNameError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#ContainerNotEmptyError">ContainerNotEmptyError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#ContainerNotFoundError">ContainerNotFoundError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#CreateUpdateError">CreateUpdateError</a><br><small></small></span></li>
<li><span class="class"><a href="dataobject.inc.html#DataObject">DataObject</a><br><small>A DataObject is an object in the ObjectStore</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#DeleteError">DeleteError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#IOError">IOError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#MetadataPrefixError">MetadataPrefixError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#MisMatchedChecksumError">MisMatchedChecksumError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#NoContentTypeError">NoContentTypeError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#NoNameError">NoNameError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#ObjFetchError">ObjFetchError</a><br><small></small></span></li>
<li><span class="class"><a href="objstorebase.inc.html#ObjStoreBase">ObjStoreBase</a><br><small>Intermediate (abstract) class to implement shared
features of all object-storage classes</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#ObjectCopyError">ObjectCopyError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#ObjectError">ObjectError</a><br><small></small></span></li>
<li><span class="class"><a href="exceptions.inc.html#UnknownParameterError">UnknownParameterError</a><br><small></small></span></li>
</ul>
</li>
<li class="closed">
<span class="folder">VolumeService</span><ul>
<li><span class="class"><a href="snapshot.inc.html#Snapshot">Snapshot</a><br><small>The Snapshot class represents a single block storage snapshot</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#SnapshotError">SnapshotError</a><br><small></small></span></li>
<li><span class="class"><a href="volume.inc.html#Volume">Volume</a><br><small>The Volume class represents a single block storage volume</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#VolumeError">VolumeError</a><br><small></small></span></li>
<li><span class="class"><a href="volumetype.inc.html#VolumeType">VolumeType</a><br><small>The VolumeType class represents a single block storage volume type</small></span></li>
<li><span class="class"><a href="exceptions.inc.html#VolumeTypeError">VolumeTypeError</a><br><small></small></span></li>
</ul>
</li>
</ul>
</li>
<li class="closed">
<span class="folder">global</span><ul></ul>
</li>
</ul>
</div><div class="section">
<h1>Packages</h1>
<ul id="packages-" class="filetree">
<li class="closed">
<span class="folder">Default</span><ul id="packages_Default" class="filetree"></ul>
</li>
<li class="closed">
<span class="folder">phpOpenCloud</span><ul id="packages_phpOpenCloud" class="filetree"></ul>
</li>
</ul>
</div>
</div></div><div id="footer"><div class="padder"></div></div></div></body></html>
Return current item: php-opencloud