You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
<td>if strict checks are on and the property prefix is not in the list of prefixes.</td>
349
+
<td>if strict checks are on and
350
+
the property prefix is not in the list of prefixes.</td>
350
351
</tr></tbody>
351
352
</table>
352
353
</div>
@@ -486,7 +487,8 @@ <h4>Description</h4>
486
487
<tr>
487
488
<td>$msg</td>
488
489
<tdstyle="white-space: normal;">string</td>
489
-
<td><p>The message string (required); can be in sprintf() format.</p>
490
+
<td><p>The message string (required); can be in
491
+
sprintf() format.</p>
490
492
</td>
491
493
<td></td>
492
494
</tr>
@@ -605,7 +607,7 @@ <h4>Properties</h4>
605
607
<divstyle="clear: both"></div>
606
608
</div>
607
609
</div>
608
-
<smallxmlns="" class="footer">Documentation was generated by <ahref="http://www.phpdoc.org">phpDocumentor 2.0.0a8</a>.</small></div><divid="index"><divclass="padder"><scriptxmlns="" type="text/javascript">
610
+
<smallxmlns="" class="footer">Documentation was generated by <ahref="http://www.phpdoc.org">phpDocumentor 2.0.0a12</a>.</small></div><divid="index"><divclass="padder"><scriptxmlns="" type="text/javascript">
Copy file name to clipboardExpand all lines: docs/api/cloud.inc.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -61,7 +61,7 @@ <h1>Properties</h1>
61
61
</div>
62
62
<h2>Description</h2>A convenience file that loads all the other components<br><br><aname="includes"></a><h2>Includes</h2>rackspace.inc <spanclass="nb-faded-text">(Require Once)</span><br>compute.inc <spanclass="nb-faded-text">(Require Once)</span><br>objectstore.inc <spanclass="nb-faded-text">(Require Once)</span><br>dbservice.inc <spanclass="nb-faded-text">(Require Once)</span><br>
63
63
</div>
64
-
<smallxmlns="" class="footer">Documentation was generated by <ahref="http://www.phpdoc.org">phpDocumentor 2.0.0a8</a>.</small></div><divid="index"><divclass="padder"><scriptxmlns="" type="text/javascript">
64
+
<smallxmlns="" class="footer">Documentation was generated by <ahref="http://www.phpdoc.org">phpDocumentor 2.0.0a12</a>.</small></div><divid="index"><divclass="padder"><scriptxmlns="" type="text/javascript">
<td><p>a callback function that is passed each item in turn. Note that <code>Select()</code> performs an explicit test for <code>FALSE</code>, so functions like <code>strpos()</code> need to be cast into a boolean value (and not just return the integer).</p>
467
+
<tdstyle="white-space: normal;">callable</td>
468
+
<td><p>a callback function that is passed each item
469
+
in turn. Note that <code>Select()</code> performs an explicit test for
470
+
<code>FALSE</code>, so functions like <code>strpos()</code> need to be cast into a
471
+
boolean value (and not just return the integer).</p>
469
472
</td>
470
473
<td></td>
471
474
</tr></tbody>
@@ -594,7 +597,8 @@ <h4>Tags</h4>
594
597
<tbody>
595
598
<tr>
596
599
<td>throws</td>
597
-
<td>if strict checks are on and the property prefix is not in the list of prefixes.</td>
600
+
<td>if strict checks are on and
601
+
the property prefix is not in the list of prefixes.</td>
598
602
</tr>
599
603
<tr>
600
604
<td>inherited_from</td>
@@ -766,7 +770,8 @@ <h4>Description</h4>
766
770
<td>$itemclass</td>
767
771
<tdstyle="white-space: normal;">string</td>
768
772
<td><ul>
769
-
<li>the Class of each item in the collection (assumed to be the name of the factory method)</li>
773
+
<li>the Class of each item in the collection
774
+
(assumed to be the name of the factory method)</li>
770
775
</ul>
771
776
</td>
772
777
<td></td>
@@ -907,7 +912,8 @@ <h4>Description</h4>
907
912
<tr>
908
913
<td>$msg</td>
909
914
<tdstyle="white-space: normal;">string</td>
910
-
<td><p>The message string (required); can be in sprintf() format.</p>
915
+
<td><p>The message string (required); can be in
916
+
sprintf() format.</p>
911
917
</td>
912
918
<td></td>
913
919
</tr>
@@ -1148,7 +1154,7 @@ <h4>Properties</h4>
1148
1154
<divstyle="clear: both"></div>
1149
1155
</div>
1150
1156
</div>
1151
-
<smallxmlns="" class="footer">Documentation was generated by <ahref="http://www.phpdoc.org">phpDocumentor 2.0.0a8</a>.</small></div><divid="index"><divclass="padder"><scriptxmlns="" type="text/javascript">
1157
+
<smallxmlns="" class="footer">Documentation was generated by <ahref="http://www.phpdoc.org">phpDocumentor 2.0.0a12</a>.</small></div><divid="index"><divclass="padder"><scriptxmlns="" type="text/javascript">
Copy file name to clipboardExpand all lines: docs/api/compute.inc.html
+45-19Lines changed: 45 additions & 19 deletions
Original file line number
Diff line number
Diff line change
@@ -310,7 +310,8 @@ <h4>Description</h4>
310
310
<tr>
311
311
<td>$parm</td>
312
312
<tdstyle="white-space: normal;">array</td>
313
-
<td><p>(optional) array of key/value pairs to use as query strings</p>
313
+
<td><p>(optional) array of key/value pairs to use as
314
+
query strings</p>
314
315
</td>
315
316
<td>array()</td>
316
317
</tr>
@@ -413,7 +414,8 @@ <h4>Description</h4>
413
414
<td>$id</td>
414
415
<tdstyle="white-space: normal;">string</td>
415
416
<td><ul>
416
-
<li>if supplied, the Flavor identified by this is retrieved</li>
417
+
<li>if supplied, the Flavor identified by this is
418
+
retrieved</li>
417
419
</ul>
418
420
</td>
419
421
<td>NULL</td>
@@ -479,7 +481,9 @@ <h4>Description</h4>
479
481
<td>$details</td>
480
482
<tdstyle="white-space: normal;">boolean</td>
481
483
<td><ul>
482
-
<li>if TRUE (the default), returns full details. Set to FALSE to retrieve minimal details and possibly improve performance.</li>
484
+
<li>if TRUE (the default), returns full details.
485
+
Set to FALSE to retrieve minimal details and possibly improve
486
+
performance.</li>
483
487
</ul>
484
488
</td>
485
489
<td>TRUE</td>
@@ -488,7 +492,8 @@ <h4>Description</h4>
488
492
<td>$filter</td>
489
493
<tdstyle="white-space: normal;">array</td>
490
494
<td><ul>
491
-
<li>optional key/value pairs for creating query strings</li>
495
+
<li>optional key/value pairs for creating query
496
+
strings</li>
492
497
</ul>
493
498
</td>
494
499
<td>array()</td>
@@ -620,7 +625,8 @@ <h4>Description</h4>
620
625
<tbody><tr>
621
626
<td>$resource</td>
622
627
<tdstyle="white-space: normal;">string</td>
623
-
<td><p>The resource requested; should NOT have slashes at the beginning or end</p></td>
628
+
<td><p>The resource requested; should NOT have slashes
629
+
at the beginning or end</p></td>
624
630
<td></td>
625
631
</tr></tbody>
626
632
</table>
@@ -739,7 +745,9 @@ <h4>Description</h4>
739
745
<td>$details</td>
740
746
<tdstyle="white-space: normal;">boolean</td>
741
747
<td><ul>
742
-
<li>if TRUE (the default), returns complete image details. Set to FALSE to improve performance, but only return a minimal set of data</li>
748
+
<li>if TRUE (the default), returns complete image
749
+
details. Set to FALSE to improve performance, but only return a
750
+
minimal set of data</li>
743
751
</ul>
744
752
</td>
745
753
<td>TRUE</td>
@@ -748,7 +756,11 @@ <h4>Description</h4>
748
756
<td>$filter</td>
749
757
<tdstyle="white-space: normal;">array</td>
750
758
<td><ul>
751
-
<li>key/value pairs to pass to the images resource. The actual values available here are determined by the OpenStack code and any extensions installed by your cloud provider; see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Images-d1e4435.html for current filters available.</li>
759
+
<li>key/value pairs to pass to the images resource.
760
+
The actual values available here are determined by the OpenStack
761
+
code and any extensions installed by your cloud provider;
762
+
see http://docs.rackspace.com/servers/api/v2/cs-devguide/content/List_Images-d1e4435.html
763
+
for current filters available.</li>
752
764
</ul>
753
765
</td>
754
766
<td>array()</td>
@@ -1082,7 +1094,8 @@ <h4>Description</h4>
1082
1094
<td>$headers</td>
1083
1095
<tdstyle="white-space: normal;">array</td>
1084
1096
<td><ul>
1085
-
<li>an associative array of headers to pass to the request</li>
1097
+
<li>an associative array of headers to pass to
1098
+
the request</li>
1086
1099
</ul>
1087
1100
</td>
1088
1101
<td>array()</td>
@@ -1215,7 +1228,10 @@ <h4>Description</h4>
1215
1228
<td>$details</td>
1216
1229
<tdstyle="white-space: normal;">boolean</td>
1217
1230
<td><ul>
1218
-
<li>if TRUE, full server details are returned; if FALSE, just the minimal set of info is listed. Defaults to TRUE; you might set this to FALSE to improve performance at the risk of not having all the information you need.</li>
1231
+
<li>if TRUE, full server details are returned; if
1232
+
FALSE, just the minimal set of info is listed. Defaults to TRUE;
1233
+
you might set this to FALSE to improve performance at the risk of
1234
+
not having all the information you need.</li>
1219
1235
</ul>
1220
1236
</td>
1221
1237
<td>TRUE</td>
@@ -1224,7 +1240,8 @@ <h4>Description</h4>
1224
1240
<td>$filter</td>
1225
1241
<tdstyle="white-space: normal;">array</td>
1226
1242
<td><ul>
1227
-
<li>a set of key/value pairs that is passed to the servers list for filtering</li>
1243
+
<li>a set of key/value pairs that is passed to the
1244
+
servers list for filtering</li>
1228
1245
</ul>
1229
1246
</td>
1230
1247
<td>array()</td>
@@ -1330,7 +1347,8 @@ <h4>Tags</h4>
1330
1347
<tbody>
1331
1348
<tr>
1332
1349
<td>throws</td>
1333
-
<td>if strict checks are on and the property prefix is not in the list of prefixes.</td>
1350
+
<td>if strict checks are on and
1351
+
the property prefix is not in the list of prefixes.</td>
1334
1352
</tr>
1335
1353
<tr>
1336
1354
<td>inherited_from</td>
@@ -1379,15 +1397,18 @@ <h4>Description</h4>
1379
1397
<td>$resource</td>
1380
1398
<tdstyle="white-space: normal;">string</td>
1381
1399
<td><ul>
1382
-
<li>an optional child resource. For example, passing 'details' would return .../servers/details. Should <em>not</em> be prefixed with a slash (/).</li>
1400
+
<li>an optional child resource. For example,
1401
+
passing 'details' would return .../servers/details. Should <em>not</em> be
1402
+
prefixed with a slash (/).</li>
1383
1403
</ul>
1384
1404
</td>
1385
1405
<td>'servers'</td>
1386
1406
</tr>
1387
1407
<tr>
1388
1408
<td>$args</td>
1389
1409
<tdstyle="white-space: normal;">array</td>
1390
-
<td><p>(optional) an array of key-value pairs for query strings to append to the URL</p>
1410
+
<td><p>(optional) an array of key-value pairs for query
1411
+
strings to append to the URL</p>
1391
1412
</td>
1392
1413
<td>array()</td>
1393
1414
</tr>
@@ -1468,7 +1489,8 @@ <h4>Description</h4>
1468
1489
<td>$serviceName</td>
1469
1490
<tdstyle="white-space: normal;">string</td>
1470
1491
<td><ul>
1471
-
<li>identifies the name of the service in the catalog</li>
1492
+
<li>identifies the name of the service in the
1493
+
catalog</li>
1472
1494
</ul>
1473
1495
</td>
1474
1496
<td></td>
@@ -1477,7 +1499,8 @@ <h4>Description</h4>
1477
1499
<td>$serviceRegion</td>
1478
1500
<tdstyle="white-space: normal;">string</td>
1479
1501
<td><ul>
1480
-
<li>identifies the region of this Compute service</li>
1502
+
<li>identifies the region of this Compute
1503
+
service</li>
1481
1504
</ul>
1482
1505
</td>
1483
1506
<td></td>
@@ -1486,7 +1509,8 @@ <h4>Description</h4>
1486
1509
<td>$urltype</td>
1487
1510
<tdstyle="white-space: normal;">string</td>
1488
1511
<td><ul>
1489
-
<li>identifies the URL type ("publicURL", "privateURL")</li>
1512
+
<li>identifies the URL type ("publicURL",
1513
+
"privateURL")</li>
1490
1514
</ul>
1491
1515
</td>
1492
1516
<td></td>
@@ -1628,7 +1652,8 @@ <h4>Description</h4>
1628
1652
<tr>
1629
1653
<td>$msg</td>
1630
1654
<tdstyle="white-space: normal;">string</td>
1631
-
<td><p>The message string (required); can be in sprintf() format.</p>
1655
+
<td><p>The message string (required); can be in
1656
+
sprintf() format.</p>
1632
1657
</td>
1633
1658
<td></td>
1634
1659
</tr>
@@ -1740,7 +1765,8 @@ <h4>Description</h4>
1740
1765
<tr>
1741
1766
<td>$type</td>
1742
1767
<tdstyle="white-space: normal;">string</td>
1743
-
<td><p>The OpenStack service type ("compute" or "object-store", for example</p>
1768
+
<td><p>The OpenStack service type ("compute" or
1769
+
"object-store", for example</p>
1744
1770
</td>
1745
1771
<td></td>
1746
1772
</tr>
@@ -2015,7 +2041,7 @@ <h4>Properties</h4>
2015
2041
<divstyle="clear: both"></div>
2016
2042
</div>
2017
2043
</div>
2018
-
<smallxmlns="" class="footer">Documentation was generated by <ahref="http://www.phpdoc.org">phpDocumentor 2.0.0a8</a>.</small></div><divid="index"><divclass="padder"><scriptxmlns="" type="text/javascript">
2044
+
<smallxmlns="" class="footer">Documentation was generated by <ahref="http://www.phpdoc.org">phpDocumentor 2.0.0a12</a>.</small></div><divid="index"><divclass="padder"><scriptxmlns="" type="text/javascript">
0 commit comments