Location: PHPKode > projects > php-opencloud > php-opencloud-master/docs/api/rackspace.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>rackspace.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>The Rackspace cloud/connection class (which uses different authentication
than the pure OpenStack class)<br><br><a name="includes"></a><h2>Includes</h2>openstack.inc <span class="nb-faded-text">(Require Once)</span><br>dbservice.inc <span class="nb-faded-text">(Require Once)</span><br>lbservice.inc <span class="nb-faded-text">(Require Once)</span><br><a name="classes"></a><h2>Classes</h2>
<div id="Rackspace" class="class">
<h3>Rackspace</h3>
<div class="properties">
<h1>Properties</h1>
<label class="property-key">Extends</label><div class="property-value">
<a href="openstack.inc.html#%5COpenCloud%5COpenStack">\OpenCloud\OpenStack</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">version</label><div class="property-value">
<a title="">1.0</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>Rackspace extends the OpenStack class with support for Rackspace's
API key and tenant requirements.</em><br><p>The only difference between Rackspace and OpenStack is that the
Rackspace class generates credentials using the username
and API key, as required by the Rackspace authentication
service.</p>

<p>Example:</p>

<pre><code>$username = 'FRED';
$apiKey = '0900af093093788912388fc09dde090ffee09';
$conn = new Rackspace(
     'https://identity.api.rackspacecloud.com/v2.0/',
     array(
         'username' => $username,
         'apiKey' => $apiKey
     ));
</code></pre><br><div id="methods_Rackspace">
<h4>Methods</h4>
<a style="font-style: italic;" href="#Rackspace::AppendUserAgent()">AppendUserAgent</a>,
      <a style="font-style: italic;" href="#Rackspace::Authenticate()">Authenticate</a>,
      <a style="font-style: italic;" href="#Rackspace::CheckAttributePrefix()">CheckAttributePrefix</a>,
      <a style="font-style: italic;" href="#Rackspace::CheckJsonError()">CheckJsonError</a>,
      <a style="font-style: italic;" href="#Rackspace::Compute()">Compute</a>,
      <a style="font-style: italic;" href="#Rackspace::Credentials()">Credentials</a>,
      <a style="font-style: italic;" href="#Rackspace::DbService()">DbService</a>,
      <a style="font-style: italic;" href="#Rackspace::GetHttpRequestObject()">GetHttpRequestObject</a>,
      <a style="font-style: italic;" href="#Rackspace::LoadBalancerService()">LoadBalancerService</a>,
      <a style="font-style: italic;" href="#Rackspace::MakeQueryString()">MakeQueryString</a>,
      <a style="font-style: italic;" href="#Rackspace::ObjectStore()">ObjectStore</a>,
      <a style="font-style: italic;" href="#Rackspace::Request()">Request</a>,
      <a style="font-style: italic;" href="#Rackspace::Secret()">Secret</a>,
      <a style="font-style: italic;" href="#Rackspace::Service()">Service</a>,
      <a style="font-style: italic;" href="#Rackspace::ServiceCatalog()">ServiceCatalog</a>,
      <a style="font-style: italic;" href="#Rackspace::ServiceCatalogItem()">ServiceCatalogItem</a>,
      <a style="font-style: italic;" href="#Rackspace::ServiceList()">ServiceList</a>,
      <a style="font-style: italic;" href="#Rackspace::SetDefaults()">SetDefaults</a>,
      <a style="font-style: italic;" href="#Rackspace::SetDownloadProgressCallback()">SetDownloadProgressCallback</a>,
      <a style="font-style: italic;" href="#Rackspace::SetProperty()">SetProperty</a>,
      <a style="font-style: italic;" href="#Rackspace::SetTimeouts()">SetTimeouts</a>,
      <a style="font-style: italic;" href="#Rackspace::SetUploadProgressCallback()">SetUploadProgressCallback</a>,
      <a style="font-style: italic;" href="#Rackspace::Tenant()">Tenant</a>,
      <a style="font-style: italic;" href="#Rackspace::Token()">Token</a>,
      <a style="font-style: italic;" href="#Rackspace::Url()">Url</a>,
      <a style="font-style: italic;" href="#Rackspace::VolumeService()">VolumeService</a>,
      <a style="font-style: italic;" href="#Rackspace::__construct()">__construct</a>,
      <a style="font-style: italic;" href="#Rackspace::__set()">__set</a>,
      <a style="font-style: italic;" href="#Rackspace::_read_cb()">_read_cb</a>,
      <a style="font-style: italic;" href="#Rackspace::_write_cb()">_write_cb</a>,
      <a style="font-style: italic;" href="#Rackspace::debug()">debug</a>,
      <a style="font-style: italic;" href="#Rackspace::to_string()">to_string</a>,
      <div class="method">
<a id="Rackspace::AppendUserAgent()"></a><h3>AppendUserAgent<span class="nb-faded-text">(
          string
             
            $agent,
          
          )
        </span>
        :
        <span class="nb-faded-text">void</span>
</h3>
<h4>Description</h4>
<em>Allows the user to append a user agent string</em><br><small><p>Programs that are using these bindings are encouraged to add their
user agent to the one supplied by this SDK. This will permit cloud
providers to track users so that they can provide better service.</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>$agent</td>
<td style="white-space: normal;">string</td>
<td><p>an arbitrary user-agent string; e.g. "My Cloud App"</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>api</td>
<td></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="openstack.inc.html#%5COpenCloud%5COpenStack::AppendUserAgent()"><small>\OpenCloud\OpenStack::AppendUserAgent()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::Authenticate()"></a><h3>Authenticate<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">void</span>
</h3>
<h4>Description</h4>
<em>Authenticates using the supplied credentials</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>
<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></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="openstack.inc.html#%5COpenCloud%5COpenStack::Authenticate()"><small>\OpenCloud\OpenStack::Authenticate()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::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="openstack.inc.html#%5COpenCloud%5COpenStack::CheckAttributePrefix()"><small>\OpenCloud\OpenStack::CheckAttributePrefix()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::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="openstack.inc.html#%5COpenCloud%5COpenStack::CheckJsonError()"><small>\OpenCloud\OpenStack::CheckJsonError()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::Compute()"></a><h3>Compute<span class="nb-faded-text">(
          string
             
            $name
            = NULL,
          string
             
            $region
            = NULL,
          string
             
            $urltype
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">\OpenCloud\ObjectStore</span>
</h3>
<h4>Description</h4>
<em>Creates a new Compute object (Nova/Cloud Servers)</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 Compute service to attach to</p></td>
<td>NULL</td>
</tr>
<tr>
<td>$region</td>
<td style="white-space: normal;">string</td>
<td><p>the name of the region to use</p></td>
<td>NULL</td>
</tr>
<tr>
<td>$urltype</td>
<td style="white-space: normal;">string</td>
<td><p>the URL type (normally "publicURL")</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</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>inherited_from</td>
<td><a href="openstack.inc.html#%5COpenCloud%5COpenStack::Compute()"><small>\OpenCloud\OpenStack::Compute()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::Credentials()"></a><h3>Credentials<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">string</span>
</h3>
<h4>Description</h4>
<em>Generates Rackspace API key credentials</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>
</div>
<div class="method">
<a id="Rackspace::DbService()"></a><h3>DbService<span class="nb-faded-text">(
          string
             
            $name
            = NULL,
          string
             
            $region
            = NULL,
          string
             
            $urltype
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Creates a new DbService (Database as a Service) object</em><br><small><p>This is a factory method that is Rackspace-only (NOT part of OpenStack).</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>$name</td>
<td style="white-space: normal;">string</td>
<td><p>the name of the service (e.g., 'Cloud Databases')</p>
</td>
<td>NULL</td>
</tr>
<tr>
<td>$region</td>
<td style="white-space: normal;">string</td>
<td><p>the region (e.g., 'DFW')</p>
</td>
<td>NULL</td>
</tr>
<tr>
<td>$urltype</td>
<td style="white-space: normal;">string</td>
<td><p>the type of URL (e.g., 'publicURL');</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>
</div>
<div class="method">
<a id="Rackspace::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="openstack.inc.html#%5COpenCloud%5COpenStack::GetHttpRequestObject()"><small>\OpenCloud\OpenStack::GetHttpRequestObject()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::LoadBalancerService()"></a><h3>LoadBalancerService<span class="nb-faded-text">(
          string
             
            $name
            = NULL,
          string
             
            $region
            = NULL,
          string
             
            $urltype
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Creates a new LoadBalancerService object</em><br><small><p>This is a factory method that is Rackspace-only (NOT part of OpenStack).</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>$name</td>
<td style="white-space: normal;">string</td>
<td><p>the name of the service (e.g., 'Cloud Load Balancers')</p>
</td>
<td>NULL</td>
</tr>
<tr>
<td>$region</td>
<td style="white-space: normal;">string</td>
<td><p>the region (e.g., 'DFW')</p>
</td>
<td>NULL</td>
</tr>
<tr>
<td>$urltype</td>
<td style="white-space: normal;">string</td>
<td><p>the type of URL (e.g., 'publicURL');</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>
</div>
<div class="method">
<a id="Rackspace::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="openstack.inc.html#%5COpenCloud%5COpenStack::MakeQueryString()"><small>\OpenCloud\OpenStack::MakeQueryString()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::ObjectStore()"></a><h3>ObjectStore<span class="nb-faded-text">(
          string
             
            $name
            = NULL,
          string
             
            $region
            = NULL,
          string
             
            $urltype
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">\OpenCloud\ObjectStore</span>
</h3>
<h4>Description</h4>
<em>Creates a new ObjectStore object (Swift/Cloud Files)</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 Object Storage service to attach to</p></td>
<td>NULL</td>
</tr>
<tr>
<td>$region</td>
<td style="white-space: normal;">string</td>
<td><p>the name of the region to use</p></td>
<td>NULL</td>
</tr>
<tr>
<td>$urltype</td>
<td style="white-space: normal;">string</td>
<td><p>the URL type (normally "publicURL")</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</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>inherited_from</td>
<td><a href="openstack.inc.html#%5COpenCloud%5COpenStack::ObjectStore()"><small>\OpenCloud\OpenStack::ObjectStore()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::Request()"></a><h3>Request<span class="nb-faded-text">(
          string
             
            $url,
          string
             
            $method
            = 'GET',
          array
             
            $headers
            = array(),
          string
             
            $data
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">\OpenCloud\HttpResponse</span>
</h3>
<h4>Description</h4>
<em>Performs a single HTTP request</em><br><small><p>The request() method is one of the most frequently-used in the entire
library. It performs an HTTP request using the specified URL, method,
and with the supplied headers and body. It handles error and
exceptions for the request.</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;">string</td>
<td><p>url - the URL of the request</p>
</td>
<td></td>
</tr>
<tr>
<td>$method</td>
<td style="white-space: normal;">string</td>
<td><p>method - the HTTP method (defaults to GET)</p>
</td>
<td>'GET'</td>
</tr>
<tr>
<td>$headers</td>
<td style="white-space: normal;">array</td>
<td><p>headers - an associative array of headers</p>
</td>
<td>array()</td>
</tr>
<tr>
<td>$data</td>
<td style="white-space: normal;">string</td>
<td><p>data - either a string or a resource (file pointer) to use as the request body (for PUT or POST)</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\HttpResponse</td>
<td>object</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>HttpUnauthorizedError, HttpForbiddenError</td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="openstack.inc.html#%5COpenCloud%5COpenStack::Request()"><small>\OpenCloud\OpenStack::Request()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::Secret()"></a><h3>Secret<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">array</span>
</h3>
<h4>Description</h4>
<em>Returns the stored secret</em><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>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="openstack.inc.html#%5COpenCloud%5COpenStack::Secret()"><small>\OpenCloud\OpenStack::Secret()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::Service()"></a><h3>Service<span class="nb-faded-text">(
          string
             
            $class,
          string
             
            $name
            = NULL,
          string
             
            $region
            = NULL,
          string
             
            $urltype
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">\OpenCloud\Service</span>
</h3>
<h4>Description</h4>
<em>Generic Service factory method</em><br><small><p>Contains code reused by the other service factory methods.</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>$class</td>
<td style="white-space: normal;">string</td>
<td><p>the name of the Service class to produce</p></td>
<td></td>
</tr>
<tr>
<td>$name</td>
<td style="white-space: normal;">string</td>
<td><p>the name of the Compute service to attach to</p></td>
<td>NULL</td>
</tr>
<tr>
<td>$region</td>
<td style="white-space: normal;">string</td>
<td><p>the name of the region to use</p></td>
<td>NULL</td>
</tr>
<tr>
<td>$urltype</td>
<td style="white-space: normal;">string</td>
<td><p>the URL type (normally "publicURL")</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\Service</td>
<td>(or subclass such as Compute, ObjectStore)</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="openstack.inc.html#%5COpenCloud%5COpenStack::Service()"><small>\OpenCloud\OpenStack::Service()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::ServiceCatalog()"></a><h3>ServiceCatalog<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">\stdClass</span>
</h3>
<h4>Description</h4>
<em>Returns the service catalog object from the auth service</em><br><h4>Return value</h4>
<table>
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tbody><tr>
<td>\stdClass</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="openstack.inc.html#%5COpenCloud%5COpenStack::ServiceCatalog()"><small>\OpenCloud\OpenStack::ServiceCatalog()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::ServiceCatalogItem()"></a><h3>ServiceCatalogItem<span class="nb-faded-text">(
          
             
            $info
            = array(),
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>returns a service catalog item</em><br><small><p>This is a helper function used to list service catalog items easily</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>$info</td>
<td style="white-space: normal;">n/a</td>
<td></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>inherited_from</td>
<td><a href="openstack.inc.html#%5COpenCloud%5COpenStack::ServiceCatalogItem()"><small>\OpenCloud\OpenStack::ServiceCatalogItem()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::ServiceList()"></a><h3>ServiceList<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Returns a Collection of objects with information on services</em><br><small><p>Note that these are informational (read-only) and are not actually
'Service'-class objects.</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>inherited_from</td>
<td><a href="openstack.inc.html#%5COpenCloud%5COpenStack::ServiceList()"><small>\OpenCloud\OpenStack::ServiceList()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::SetDefaults()"></a><h3>SetDefaults<span class="nb-faded-text">(
          string
             
            $service,
          string
             
            $name
            = NULL,
          string
             
            $region
            = NULL,
          string
             
            $urltype
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">void</span>
</h3>
<h4>Description</h4>
<em>Sets default values for name, region, URL type for a service</em><br><small><p>Once these are set (and they can also be set by defining global
constants), then you do not need to specify these values when
creating new service objects.</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;">string</td>
<td><p>the name of a supported service; e.g. 'Compute'</p>
</td>
<td></td>
</tr>
<tr>
<td>$name</td>
<td style="white-space: normal;">string</td>
<td><p>the service name; e.g., 'cloudServersOpenStack'</p>
</td>
<td>NULL</td>
</tr>
<tr>
<td>$region</td>
<td style="white-space: normal;">string</td>
<td><p>the region name; e.g., 'LON'</p>
</td>
<td>NULL</td>
</tr>
<tr>
<td>$urltype</td>
<td style="white-space: normal;">string</td>
<td><p>the type of URL to use; e.g., 'internalURL'</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>api</td>
<td></td>
</tr>
<tr>
<td>throws</td>
<td></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="openstack.inc.html#%5COpenCloud%5COpenStack::SetDefaults()"><small>\OpenCloud\OpenStack::SetDefaults()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::SetDownloadProgressCallback()"></a><h3>SetDownloadProgressCallback<span class="nb-faded-text">(
          \OpenCloud\callable
             
            $callback,
          
          )
        </span>
        :
        <span class="nb-faded-text">void</span>
</h3>
<h4>Description</h4>
<em>Allows the user to define a function for tracking downloads</em><br><small><p>This can be used to implement a progress bar or similar function. The
callback function is called with a single parameter, the length of the
data that is being downloaded on this call.</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>$callback</td>
<td style="white-space: normal;">\OpenCloud\callable</td>
<td><p>the name of a global callback function, or an array($object, $functionname)</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="openstack.inc.html#%5COpenCloud%5COpenStack::SetDownloadProgressCallback()"><small>\OpenCloud\OpenStack::SetDownloadProgressCallback()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::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="openstack.inc.html#%5COpenCloud%5COpenStack::SetProperty()"><small>\OpenCloud\OpenStack::SetProperty()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::SetTimeouts()"></a><h3>SetTimeouts<span class="nb-faded-text">(
          integer
             
            $t_http,
          integer
             
            $t_conn
            = NULL,
          integer
             
            $t_overlimit
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">void</span>
</h3>
<h4>Description</h4>
<em>Sets the timeouts for the current connection</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>$t_http</td>
<td style="white-space: normal;">integer</td>
<td><p>the HTTP timeout value (the max period that the OpenStack object will wait for any HTTP request to complete). Value is in seconds.</p>
</td>
<td></td>
</tr>
<tr>
<td>$t_conn</td>
<td style="white-space: normal;">integer</td>
<td><p>the Connect timeout value (the max period that the OpenStack object will wait to establish an HTTP connection). Value is in seconds.</p>
</td>
<td>NULL</td>
</tr>
<tr>
<td>$t_overlimit</td>
<td style="white-space: normal;">integer</td>
<td><p>the overlimit timeout value (the max period that the OpenStack object will wait to retry on an overlimit condition). Value is in seconds.</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>api</td>
<td></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="openstack.inc.html#%5COpenCloud%5COpenStack::SetTimeouts()"><small>\OpenCloud\OpenStack::SetTimeouts()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::SetUploadProgressCallback()"></a><h3>SetUploadProgressCallback<span class="nb-faded-text">(
          \OpenCloud\callable
             
            $callback,
          
          )
        </span>
        :
        <span class="nb-faded-text">void</span>
</h3>
<h4>Description</h4>
<em>Allows the user to define a function for tracking uploads</em><br><small><p>This can be used to implement a progress bar or similar function. The
callback function is called with a single parameter, the length of the
data that is being uploaded on this call.</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>$callback</td>
<td style="white-space: normal;">\OpenCloud\callable</td>
<td><p>the name of a global callback function, or an array($object, $functionname)</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="openstack.inc.html#%5COpenCloud%5COpenStack::SetUploadProgressCallback()"><small>\OpenCloud\OpenStack::SetUploadProgressCallback()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::Tenant()"></a><h3>Tenant<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">string</span>
</h3>
<h4>Description</h4>
<em>Returns the tenant ID, re-authenticating if necessary</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>
<tr>
<td>inherited_from</td>
<td><a href="openstack.inc.html#%5COpenCloud%5COpenStack::Tenant()"><small>\OpenCloud\OpenStack::Tenant()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::Token()"></a><h3>Token<span class="nb-faded-text">(
          
          )
        </span>
        :
        <span class="nb-faded-text">string</span>
</h3>
<h4>Description</h4>
<em>Returns the cached token; if it has expired, then it re-authenticates</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>
<tr>
<td>inherited_from</td>
<td><a href="openstack.inc.html#%5COpenCloud%5COpenStack::Token()"><small>\OpenCloud\OpenStack::Token()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::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 this object</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>api</td>
<td></td>
</tr>
<tr>
<td>throws</td>
<td></td>
</tr>
<tr>
<td>inherited_from</td>
<td><a href="openstack.inc.html#%5COpenCloud%5COpenStack::Url()"><small>\OpenCloud\OpenStack::Url()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::VolumeService()"></a><h3>VolumeService<span class="nb-faded-text">(
          string
             
            $name
            = NULL,
          string
             
            $region
            = NULL,
          string
             
            $urltype
            = NULL,
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Creates a new VolumeService (cinder) service object</em><br><small><p>This is a factory method that is Rackspace-only (NOT part of OpenStack).</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>$name</td>
<td style="white-space: normal;">string</td>
<td><p>the name of the service (e.g., 'cloudBlockStorage')</p>
</td>
<td>NULL</td>
</tr>
<tr>
<td>$region</td>
<td style="white-space: normal;">string</td>
<td><p>the region (e.g., 'DFW')</p>
</td>
<td>NULL</td>
</tr>
<tr>
<td>$urltype</td>
<td style="white-space: normal;">string</td>
<td><p>the type of URL (e.g., 'publicURL');</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="openstack.inc.html#%5COpenCloud%5COpenStack::VolumeService()"><small>\OpenCloud\OpenStack::VolumeService()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::__construct()"></a><h3>__construct<span class="nb-faded-text">(
          string
             
            $url,
          array
             
            $secret,
          
          )
        </span>
        :
        <span class="nb-faded-text">n/a</span>
</h3>
<h4>Description</h4>
<em>Creates a new OpenStack object</em><br><small><p>The OpenStack object needs two bits of information: the URL to
authenticate against, and a "secret", which is an associative array
of name/value pairs. Usually, the secret will be a username and a
password, but other values may be required by different authentication
systems. For example, OpenStack Keystone requires a username and
password, but Rackspace uses a username, tenant ID, and API key.
(See OpenCloud\Rackspace for that.)</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;">string</td>
<td><ul>
<li>the authentication endpoint URL</li>
</ul>
</td>
<td></td>
</tr>
<tr>
<td>$secret</td>
<td style="white-space: normal;">array</td>
<td><ul>
<li>an associative array of auth information: * username * password</li>
</ul>
</td>
<td></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="openstack.inc.html#%5COpenCloud%5COpenStack::__construct()"><small>\OpenCloud\OpenStack::__construct()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::__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="openstack.inc.html#%5COpenCloud%5COpenStack::__set()"><small>\OpenCloud\OpenStack::__set()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::_read_cb()"></a><h3>_read_cb<span class="nb-faded-text">(
          resource
             
            $ch,
          resource
             
            $fd,
          integer
             
            $length,
          
          )
        </span>
        :
        <span class="nb-faded-text">string</span>
</h3>
<h4>Description</h4>
<em>Callback function to handle reads for file uploads</em><br><small><p>Internal function for handling file uploads. Note that, although this
function's visibility is public, this is only because it must be called
from the HttpRequest interface. This should NOT be called by users
directly.</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>$ch</td>
<td style="white-space: normal;">resource</td>
<td><p>a CURL handle</p></td>
<td></td>
</tr>
<tr>
<td>$fd</td>
<td style="white-space: normal;">resource</td>
<td><p>a file descriptor</p></td>
<td></td>
</tr>
<tr>
<td>$length</td>
<td style="white-space: normal;">integer</td>
<td><p>the amount of data to read</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>the data read</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="openstack.inc.html#%5COpenCloud%5COpenStack::_read_cb()"><small>\OpenCloud\OpenStack::_read_cb()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::_write_cb()"></a><h3>_write_cb<span class="nb-faded-text">(
          resource
             
            $ch,
          string
             
            $data,
          
          )
        </span>
        :
        <span class="nb-faded-text">integer</span>
</h3>
<h4>Description</h4>
<em>Callback function to handle writes for file downloads</em><br><small><p>Internal function for handling file downloads. Note that, although this
function's visibility is public, this is only because it must be called
via the HttpRequest interface. This should NOT be called by users
directly.</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>$ch</td>
<td style="white-space: normal;">resource</td>
<td><p>a CURL handle</p></td>
<td></td>
</tr>
<tr>
<td>$data</td>
<td style="white-space: normal;">string</td>
<td><p>the data to be written to a file</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>integer</td>
<td>the number of bytes written</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="openstack.inc.html#%5COpenCloud%5COpenStack::_write_cb()"><small>\OpenCloud\OpenStack::_write_cb()</small></a></td>
</tr></tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::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="openstack.inc.html#%5COpenCloud%5COpenStack::debug()"><small>\OpenCloud\OpenStack::debug()</small></a></td>
</tr>
</tbody>
</table>
</div>
<div class="method">
<a id="Rackspace::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="openstack.inc.html#%5COpenCloud%5COpenStack::to_string()"><small>\OpenCloud\OpenStack::to_string()</small></a></td>
</tr>
</tbody>
</table>
</div>
</div>
<div id="properties_Rackspace">
<h4>Properties</h4>
<a href="#Rackspace::%24ServiceCatalog">$ServiceCatalog</a>,
      <a href="#Rackspace::%24_errors">$_errors</a>,
      <a href="#Rackspace::%24_file_descriptors">$_file_descriptors</a>,
      <a href="#Rackspace::%24_user_read_progress_callback_func">$_user_read_progress_callback_func</a>,
      <a href="#Rackspace::%24_user_write_progress_callback_func">$_user_write_progress_callback_func</a>,
      <a href="#Rackspace::%24connect_timeout">$connect_timeout</a>,
      <a href="#Rackspace::%24defaults">$defaults</a>,
      <a href="#Rackspace::%24expiration">$expiration</a>,
      <a href="#Rackspace::%24http_headers">$http_headers</a>,
      <a href="#Rackspace::%24http_timeout">$http_timeout</a>,
      <a href="#Rackspace::%24overlimit_timeout">$overlimit_timeout</a>,
      <a href="#Rackspace::%24secret">$secret</a>,
      <a href="#Rackspace::%24template">$template</a>,
      <a href="#Rackspace::%24tenant">$tenant</a>,
      <a href="#Rackspace::%24token">$token</a>,
      <a href="#Rackspace::%24url">$url</a>,
      <a href="#Rackspace::%24useragent">$useragent</a>,
      <div class="method">
<a id="Rackspace::$ServiceCatalog"></a><h3>
<span class="nb-faded-text"> 
          protected 
          </span>$ServiceCatalog
          =
          </h3>
<em></em><br>
</div>
<div class="method">
<a id="Rackspace::$_errors"></a><h3>
<span class="nb-faded-text"> 
          private 
          </span>$_errors
          =
          array()</h3>
<em></em><br>
</div>
<div class="method">
<a id="Rackspace::$_file_descriptors"></a><h3>
<span class="nb-faded-text"> 
          private 
          </span>$_file_descriptors
          =
          array()</h3>
<em></em><br>
</div>
<div class="method">
<a id="Rackspace::$_user_read_progress_callback_func"></a><h3>
<span class="nb-faded-text"> 
          private 
          </span>$_user_read_progress_callback_func
          =
          </h3>
<em></em><br>
</div>
<div class="method">
<a id="Rackspace::$_user_write_progress_callback_func"></a><h3>
<span class="nb-faded-text"> 
          private 
          </span>$_user_write_progress_callback_func
          =
          </h3>
<em></em><br>
</div>
<div class="method">
<a id="Rackspace::$connect_timeout"></a><h3>
<span class="nb-faded-text"> 
          protected 
          </span>$connect_timeout
          =
          RAXSDK_CONNECTTIMEOUT</h3>
<em></em><br>
</div>
<div class="method">
<a id="Rackspace::$defaults"></a><h3>
<span class="nb-faded-text"> 
          protected 
          </span>$defaults
          =
          array('Compute' =&gt; array('name' =&gt; RAXSDK_COMPUTE_NAME, 'region' =&gt; RAXSDK_COMPUTE_REGION, 'urltype' =&gt; RAXSDK_COMPUTE_URLTYPE), 'ObjectStore' =&gt; array('name' =&gt; RAXSDK_OBJSTORE_NAME, 'region' =&gt; RAXSDK_OBJSTORE_REGION, 'urltype' =&gt; RAXSDK_OBJSTORE_URLTYPE), 'DbService' =&gt; array('name' =&gt; RAXSDK_DATABASE_NAME, 'region' =&gt; RAXSDK_DATABASE_REGION, 'urltype' =&gt; RAXSDK_DATABASE_URLTYPE), 'VolumeService' =&gt; array('name' =&gt; RAXSDK_VOLUME_NAME, 'region' =&gt; RAXSDK_VOLUME_REGION, 'urltype' =&gt; RAXSDK_VOLUME_URLTYPE), 'LoadBalancerService' =&gt; array('name' =&gt; RAXSDK_LBSERVICE_NAME, 'region' =&gt; RAXSDK_LBSERVICE_REGION, 'urltype' =&gt; RAXSDK_LBSERVICE_URLTYPE))</h3>
<em></em><br>
</div>
<div class="method">
<a id="Rackspace::$expiration"></a><h3>
<span class="nb-faded-text"> 
          protected 
          </span>$expiration
          =
          0</h3>
<em></em><br>
</div>
<div class="method">
<a id="Rackspace::$http_headers"></a><h3>
<span class="nb-faded-text"> 
          private 
          </span>$http_headers
          =
          array()</h3>
<em></em><br>
</div>
<div class="method">
<a id="Rackspace::$http_timeout"></a><h3>
<span class="nb-faded-text"> 
          protected 
          </span>$http_timeout
          =
          RAXSDK_TIMEOUT</h3>
<em></em><br>
</div>
<div class="method">
<a id="Rackspace::$overlimit_timeout"></a><h3>
<span class="nb-faded-text"> 
          protected 
          </span>$overlimit_timeout
          =
          RAXSDK_OVERLIMIT_TIMEOUT</h3>
<em></em><br>
</div>
<div class="method">
<a id="Rackspace::$secret"></a><h3>
<span class="nb-faded-text"> 
          protected 
          </span>$secret
          =
          array()</h3>
<em></em><br>
</div>
<div class="method">
<a id="Rackspace::$template"></a><h3>
<span class="nb-faded-text"> 
          private 
          </span>$template
          =
          </h3>
<em></em><br>
</div>
<div class="method">
<a id="Rackspace::$tenant"></a><h3>
<span class="nb-faded-text"> 
          protected 
          </span>$tenant
          =
          </h3>
<em></em><br>
</div>
<div class="method">
<a id="Rackspace::$token"></a><h3>
<span class="nb-faded-text"> 
          protected 
          </span>$token
          =
          </h3>
<em></em><br>
</div>
<div class="method">
<a id="Rackspace::$url"></a><h3>
<span class="nb-faded-text"> 
          protected 
          </span>$url
          =
          </h3>
<em></em><br>
</div>
<div class="method">
<a id="Rackspace::$useragent"></a><h3>
<span class="nb-faded-text"> 
          public 
          </span>$useragent
          =
          RAXSDK_USER_AGENT</h3>
<em></em><br>
</div>
</div>
<div id="constants_Rackspace">
<h4>Constants</h4>
<a id="Rackspace::APIKEYTEMPLATE"></a><div class="constant">
<h3>
<span class="nb-faded-text"> 
        </span>APIKEYTEMPLATE<span class="nb-faded-text">
         = </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