updated docs

Author: gecampbell

docs/api/collection.inc.html

@@ -92,9 +92,11 @@ <h4>Methods</h4>
       <a style="font-style: italic;" href="#Collection::GetHttpRequestObject()">GetHttpRequestObject</a>,
       <a style="font-style: italic;" href="#Collection::MakeQueryString()">MakeQueryString</a>,
       <a style="font-style: italic;" href="#Collection::Next()">Next</a>,
+      <a style="font-style: italic;" href="#Collection::NextPage()">NextPage</a>,
       <a style="font-style: italic;" href="#Collection::Reset()">Reset</a>,
       <a style="font-style: italic;" href="#Collection::Select()">Select</a>,
       <a style="font-style: italic;" href="#Collection::Service()">Service</a>,
+      <a style="font-style: italic;" href="#Collection::SetNextPageCallback()">SetNextPageCallback</a>,
       <a style="font-style: italic;" href="#Collection::SetProperty()">SetProperty</a>,
       <a style="font-style: italic;" href="#Collection::Size()">Size</a>,
       <a style="font-style: italic;" href="#Collection::Sort()">Sort</a>,
@@ -220,8 +222,8 @@ <h4>Tags</h4>
         <span class="nb-faded-text">\OpenCloud\Base</span>
 </h3>
 <h4>Description</h4>
-<em>Resets the collection pointer back to the first item in the set
-and returns it</em><br><small><p>This is useful if you're only interested in the first item in the set.</p></small><br><h4>Return value</h4>
+<em>Resets the collection pointer back to the first item in the page
+and returns it</em><br><small><p>This is useful if you're only interested in the first item in the page.</p></small><br><h4>Return value</h4>
 <table>
 <thead><tr>
 <th>Type</th>
@@ -366,15 +368,57 @@ <h4>Tags</h4>
         <span class="nb-faded-text">\OpenCloud\Base</span>
 </h3>
 <h4>Description</h4>
-<em>Returns the next item in the set</em><br><h4>Return value</h4>
+<em>Returns the next item in the page</em><br><h4>Return value</h4>
 <table>
 <thead><tr>
 <th>Type</th>
 <th>Description</th>
 </tr></thead>
 <tbody><tr>
 <td>\OpenCloud\Base</td>
-<td>the next item or FALSE if at the end of the set</td>
+<td>the next item or FALSE if at the end of the page</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="Collection::NextPage()"></a><h3>NextPage<span class="nb-faded-text">(
+          
+          )
+        </span>
+        :
+        <span class="nb-faded-text">\OpenCloud\Collection</span>
+</h3>
+<h4>Description</h4>
+<em>returns the Collection object for the next page of results, or
+FALSE if there are no more pages</em><br><small><p>Generally, the structure for a multi-page collection will look like
+this:</p>
+
+<pre><code>$coll = $obj-&gt;Collection();
+do {
+    while($item = $coll-&gt;Next()) {
+        // do something with the item
+    |
+} while ($coll = $coll-&gt;NextPage());
+</code></pre></small><br><h4>Return value</h4>
+<table>
+<thead><tr>
+<th>Type</th>
+<th>Description</th>
+</tr></thead>
+<tbody><tr>
+<td>\OpenCloud\Collection</td>
+<td>if there are more pages of results, otherwise FALSE</td>
 </tr></tbody>
 </table>
 <h4>Tags</h4>
@@ -528,6 +572,64 @@ <h4>Description</h4>
 </table>
 </div>
 <div class="method">
+<a id="Collection::SetNextPageCallback()"></a><h3>SetNextPageCallback<span class="nb-faded-text">(
+          callable
+             
+            $callback,
+          string
+             
+            $url,
+          
+          )
+        </span>
+        :
+        <span class="nb-faded-text">void</span>
+</h3>
+<h4>Description</h4>
+<em>for paginated collection, sets the callback function and URL for
+the next page</em><br><small><p>The callback function should have the signature:</p>
+
+<pre><code>function Whatever($class, $url, $parent)
+</code></pre>
+
+<p>and the <code>$url</code> should be the URL of the next page of results</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;">callable</td>
+<td><p>the name of the function (or array of
+    object, function name)</p>
+</td>
+<td></td>
+</tr>
+<tr>
+<td>$url</td>
+<td style="white-space: normal;">string</td>
+<td><p>the URL of the next page of results</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>
+</div>
+<div class="method">
 <a id="Collection::SetProperty()"></a><h3>SetProperty<span class="nb-faded-text">(
           string
 
@@ -616,7 +718,9 @@ <h4>Tags</h4>
         <span class="nb-faded-text">integer</span>
 </h3>
 <h4>Description</h4>
-<em>Returns the number of items in the collection</em><br><h4>Return value</h4>
+<em>Returns the number of items in the page</em><br><small><p>For most services, this is the total number of items. If the Collection
+is paginated, however, this only returns the count of items in the
+current page of data.</p></small><br><h4>Return value</h4>
 <table>
 <thead><tr>
 <th>Type</th>
@@ -652,7 +756,9 @@ <h4>Tags</h4>
         <span class="nb-faded-text">void</span>
 </h3>
 <h4>Description</h4>
-<em>sorts the collection on a specified key</em><br><small><p>Note: only top-level keys can be used as the sort key</p></small><br><h4>Arguments</h4>
+<em>sorts the collection on a specified key</em><br><small><p>Note: only top-level keys can be used as the sort key. Note that this
+only sorts the data in the current page of the Collection (for
+multi-page data).</p></small><br><h4>Arguments</h4>
 <table>
 <thead><tr>
 <th>Name</th>
@@ -1084,6 +1190,9 @@ <h4>Properties</h4>
       <a href="#Collection::%24http_headers">$http_headers</a>,
       <a href="#Collection::%24itemclass">$itemclass</a>,
       <a href="#Collection::%24itemlist">$itemlist</a>,
+      <a href="#Collection::%24next_page_callback">$next_page_callback</a>,
+      <a href="#Collection::%24next_page_class">$next_page_class</a>,
+      <a href="#Collection::%24next_page_url">$next_page_url</a>,
       <a href="#Collection::%24pointer">$pointer</a>,
       <a href="#Collection::%24service">$service</a>,
       <a href="#Collection::%24sortkey">$sortkey</a>,
@@ -1124,6 +1233,33 @@ <h4>Properties</h4>
 <em></em><br>
 </div>
 <div class="method">
+<a id="Collection::$next_page_callback"></a><h3>
+<span class="nb-faded-text"> 
+          private 
+          </span>$next_page_callback
+          =
+          </h3>
+<em></em><br>
+</div>
+<div class="method">
+<a id="Collection::$next_page_class"></a><h3>
+<span class="nb-faded-text"> 
+          private 
+          </span>$next_page_class
+          =
+          </h3>
+<em></em><br>
+</div>
+<div class="method">
+<a id="Collection::$next_page_url"></a><h3>
+<span class="nb-faded-text"> 
+          private 
+          </span>$next_page_url
+          =
+          </h3>
+<em></em><br>
+</div>
+<div class="method">
 <a id="Collection::$pointer"></a><h3>
 <span class="nb-faded-text"> 
           private 

docs/api/openstack.inc.html

@@ -114,6 +114,7 @@ <h4>Methods</h4>
       <a style="font-style: italic;" href="#OpenStack::CheckJsonError()">CheckJsonError</a>,
       <a style="font-style: italic;" href="#OpenStack::Compute()">Compute</a>,
       <a style="font-style: italic;" href="#OpenStack::Credentials()">Credentials</a>,
+      <a style="font-style: italic;" href="#OpenStack::Expiration()">Expiration</a>,
       <a style="font-style: italic;" href="#OpenStack::ExportCredentials()">ExportCredentials</a>,
       <a style="font-style: italic;" href="#OpenStack::GetHttpRequestObject()">GetHttpRequestObject</a>,
       <a style="font-style: italic;" href="#OpenStack::ImportCredentials()">ImportCredentials</a>,
@@ -435,6 +436,39 @@ <h4>Description</h4>
 </table>
 </div>
 <div class="method">
+<a id="OpenStack::Expiration()"></a><h3>Expiration<span class="nb-faded-text">(
+          
+          )
+        </span>
+        :
+        <span class="nb-faded-text">string</span>
+</h3>
+<h4>Description</h4>
+<em>Returns the cached expiration time;
+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></tbody>
+</table>
+</div>
+<div class="method">
 <a id="OpenStack::ExportCredentials()"></a><h3>ExportCredentials<span class="nb-faded-text">(
 
           )

docs/api/parse_markers.html

@@ -86,7 +86,7 @@ <h3><a href="#">base.inc<small>4</small></a></h3>
 <td>Argument $method is missing from the Docblock of GetHttpRequestObject()</td>
 </tr>
 </table></div>
-<h3><a href="#">collection.inc<small>7</small></a></h3>
+<h3><a href="#">collection.inc<small>10</small></a></h3>
 <div><table>
 <tr>
 <th>Type</th>
@@ -120,12 +120,27 @@ <h3><a href="#">collection.inc<small>7</small></a></h3>
 </tr>
 <tr>
 <td>error</td>
-<td>177</td>
+<td>34</td>
+<td>No DocBlock was found for property $next_page_class</td>
+</tr>
+<tr>
+<td>error</td>
+<td>35</td>
+<td>No DocBlock was found for property $next_page_callback</td>
+</tr>
+<tr>
+<td>error</td>
+<td>36</td>
+<td>No DocBlock was found for property $next_page_url</td>
+</tr>
+<tr>
+<td>error</td>
+<td>234</td>
 <td>Argument $a is missing from the Docblock of sortCompare()</td>
 </tr>
 <tr>
 <td>error</td>
-<td>177</td>
+<td>234</td>
 <td>Argument $b is missing from the Docblock of sortCompare()</td>
 </tr>
 </table></div>
@@ -1218,12 +1233,12 @@ <h3><a href="#">instance.inc<small>16</small></a></h3>
 </tr>
 <tr>
 <td>error</td>
-<td>277</td>
+<td>280</td>
 <td>Argument $flavorRef is missing from the Docblock of ResizeJson()</td>
 </tr>
 <tr>
 <td>error</td>
-<td>287</td>
+<td>290</td>
 <td>Argument $size is missing from the Docblock of ResizeVolumeJson()</td>
 </tr>
 </table></div>
@@ -2415,17 +2430,17 @@ <h3><a href="#">openstack.inc<small>20</small></a></h3>
 </tr>
 <tr>
 <td>error</td>
-<td>601</td>
+<td>614</td>
 <td>Argument $values is missing from the Docblock of ImportCredentials()</td>
 </tr>
 <tr>
 <td>error</td>
-<td>708</td>
+<td>721</td>
 <td>Argument $info is missing from the Docblock of ServiceCatalogItem()</td>
 </tr>
 <tr>
 <td>error</td>
-<td>723</td>
+<td>736</td>
 <td>No DocBlock was found for method __construct()</td>
 </tr>
 </table></div>

docs/api/rackspace.inc.html

@@ -109,6 +109,7 @@ <h4>Methods</h4>
       <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::Expiration()">Expiration</a>,
       <a style="font-style: italic;" href="#Rackspace::ExportCredentials()">ExportCredentials</a>,
       <a style="font-style: italic;" href="#Rackspace::GetHttpRequestObject()">GetHttpRequestObject</a>,
       <a style="font-style: italic;" href="#Rackspace::ImportCredentials()">ImportCredentials</a>,
@@ -521,6 +522,45 @@ <h4>Return value</h4>
 </table>
 </div>
 <div class="method">
+<a id="Rackspace::Expiration()"></a><h3>Expiration<span class="nb-faded-text">(
+          
+          )
+        </span>
+        :
+        <span class="nb-faded-text">string</span>
+</h3>
+<h4>Description</h4>
+<em>Returns the cached expiration time;
+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::Expiration()"><small>\OpenCloud\OpenStack::Expiration()</small></a></td>
+</tr>
+</tbody>
+</table>
+</div>
+<div class="method">
 <a id="Rackspace::ExportCredentials()"></a><h3>ExportCredentials<span class="nb-faded-text">(
 
           )