/usr/share/doc/php-opencloud/api/source-class-OpenCloud.Common.Service.AbstractService.html is in php-opencloud-doc 1.10.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 | <!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<meta name="generator" content="ApiGen 2.8.0">
<meta name="robots" content="noindex">
<title>File OpenCloud/Common/Service/AbstractService.php | PHP OpenCloud API</title>
<script type="text/javascript" src="resources/combined.js?117538352"></script>
<script type="text/javascript" src="elementlist.js?4292216789"></script>
<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360">
</head>
<body>
<div id="left">
<div id="menu">
<a href="index.html" title="Overview"><span>Overview</span></a>
<div id="groups">
<h3>Namespaces</h3>
<ul>
<li class="active"><a href="namespace-OpenCloud.html">OpenCloud<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Autoscale.html">Autoscale<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Autoscale.Resource.html">Resource</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.CloudMonitoring.html">CloudMonitoring<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.CloudMonitoring.Exception.html">Exception</a>
</li>
<li><a href="namespace-OpenCloud.CloudMonitoring.Resource.html">Resource</a>
</li>
</ul></li>
<li class="active"><a href="namespace-OpenCloud.Common.html">Common<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Common.Collection.html">Collection</a>
</li>
<li><a href="namespace-OpenCloud.Common.Constants.html">Constants</a>
</li>
<li><a href="namespace-OpenCloud.Common.Exceptions.html">Exceptions</a>
</li>
<li><a href="namespace-OpenCloud.Common.Http.html">Http<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Common.Http.Message.html">Message</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.Common.Log.html">Log</a>
</li>
<li><a href="namespace-OpenCloud.Common.Resource.html">Resource</a>
</li>
<li class="active"><a href="namespace-OpenCloud.Common.Service.html">Service</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.Compute.html">Compute<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Compute.Constants.html">Constants</a>
</li>
<li><a href="namespace-OpenCloud.Compute.Exception.html">Exception</a>
</li>
<li><a href="namespace-OpenCloud.Compute.Resource.html">Resource</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.Database.html">Database<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Database.Resource.html">Resource</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.DNS.html">DNS<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.DNS.Collection.html">Collection</a>
</li>
<li><a href="namespace-OpenCloud.DNS.Resource.html">Resource</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.Identity.html">Identity<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Identity.Constants.html">Constants</a>
</li>
<li><a href="namespace-OpenCloud.Identity.Resource.html">Resource</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.Image.html">Image<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Image.Enum.html">Enum</a>
</li>
<li><a href="namespace-OpenCloud.Image.Resource.html">Resource<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Image.Resource.JsonPatch.html">JsonPatch</a>
</li>
<li><a href="namespace-OpenCloud.Image.Resource.Schema.html">Schema</a>
</li>
</ul></li></ul></li>
<li><a href="namespace-OpenCloud.LoadBalancer.html">LoadBalancer<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.LoadBalancer.Enum.html">Enum</a>
</li>
<li><a href="namespace-OpenCloud.LoadBalancer.Resource.html">Resource</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.ObjectStore.html">ObjectStore<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.ObjectStore.Constants.html">Constants</a>
</li>
<li><a href="namespace-OpenCloud.ObjectStore.Exception.html">Exception</a>
</li>
<li><a href="namespace-OpenCloud.ObjectStore.Resource.html">Resource</a>
</li>
<li><a href="namespace-OpenCloud.ObjectStore.Upload.html">Upload</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.Orchestration.html">Orchestration</a>
</li>
<li><a href="namespace-OpenCloud.Queues.html">Queues<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Queues.Exception.html">Exception</a>
</li>
<li><a href="namespace-OpenCloud.Queues.Resource.html">Resource</a>
</li>
</ul></li>
<li><a href="namespace-OpenCloud.Volume.html">Volume<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Volume.Resource.html">Resource</a>
</li>
</ul></li></ul></li>
<li><a href="namespace-PHP.html">PHP</a>
</li>
</ul>
</div>
<hr>
<div id="elements">
<h3>Classes</h3>
<ul>
<li class="active"><a href="class-OpenCloud.Common.Service.AbstractService.html">AbstractService</a></li>
<li><a href="class-OpenCloud.Common.Service.Catalog.html">Catalog</a></li>
<li><a href="class-OpenCloud.Common.Service.CatalogItem.html">CatalogItem</a></li>
<li><a href="class-OpenCloud.Common.Service.CatalogService.html">CatalogService</a></li>
<li><a href="class-OpenCloud.Common.Service.Endpoint.html">Endpoint</a></li>
<li><a href="class-OpenCloud.Common.Service.NovaService.html">NovaService</a></li>
<li><a href="class-OpenCloud.Common.Service.ServiceBuilder.html">ServiceBuilder</a></li>
</ul>
<h3>Interfaces</h3>
<ul>
<li><a href="class-OpenCloud.Common.Service.ServiceInterface.html">ServiceInterface</a></li>
</ul>
</div>
</div>
</div>
<div id="splitter"></div>
<div id="right">
<div id="rightInner">
<form id="search">
<input type="hidden" name="cx" value="">
<input type="hidden" name="ie" value="UTF-8">
<input type="text" name="q" class="text">
<input type="submit" value="Search">
</form>
<div id="navigation">
<ul>
<li>
<a href="index.html" title="Overview"><span>Overview</span></a>
</li>
<li>
<a href="namespace-OpenCloud.Common.Service.html" title="Summary of OpenCloud\Common\Service"><span>Namespace</span></a>
</li>
<li>
<a href="class-OpenCloud.Common.Service.AbstractService.html" title="Summary of OpenCloud\Common\Service\AbstractService"><span>Class</span></a>
</li>
</ul>
<ul>
<li>
<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
</li>
</ul>
<ul>
<li>
<a href="php-opencloud-api-api-documentation.zip" title="Download documentation as ZIP archive"><span>Download</span></a>
</li>
</ul>
</div>
<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang"><?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a><span class="php-comment">/**
</span></span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-comment"> * Copyright 2012-2014 Rackspace US, Inc.
</span></span><span id="4" class="l"><a class="l" href="#4"> 4: </a><span class="php-comment"> *
</span></span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-comment"> * Licensed under the Apache License, Version 2.0 (the "License");
</span></span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-comment"> * you may not use this file except in compliance with the License.
</span></span><span id="7" class="l"><a class="l" href="#7"> 7: </a><span class="php-comment"> * You may obtain a copy of the License at
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment"> *
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * http://www.apache.org/licenses/LICENSE-2.0
</span></span><span id="10" class="l"><a class="l" href="#10"> 10: </a><span class="php-comment"> *
</span></span><span id="11" class="l"><a class="l" href="#11"> 11: </a><span class="php-comment"> * Unless required by applicable law or agreed to in writing, software
</span></span><span id="12" class="l"><a class="l" href="#12"> 12: </a><span class="php-comment"> * distributed under the License is distributed on an "AS IS" BASIS,
</span></span><span id="13" class="l"><a class="l" href="#13"> 13: </a><span class="php-comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
</span></span><span id="14" class="l"><a class="l" href="#14"> 14: </a><span class="php-comment"> * See the License for the specific language governing permissions and
</span></span><span id="15" class="l"><a class="l" href="#15"> 15: </a><span class="php-comment"> * limitations under the License.
</span></span><span id="16" class="l"><a class="l" href="#16"> 16: </a><span class="php-comment"> */</span>
</span><span id="17" class="l"><a class="l" href="#17"> 17: </a>
</span><span id="18" class="l"><a class="l" href="#18"> 18: </a><span class="php-keyword1">namespace</span> OpenCloud\Common\Service;
</span><span id="19" class="l"><a class="l" href="#19"> 19: </a>
</span><span id="20" class="l"><a class="l" href="#20"> 20: </a><span class="php-keyword1">use</span> Guzzle\Http\ClientInterface;
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-keyword1">use</span> OpenCloud\Common\Base;
</span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-keyword1">use</span> OpenCloud\Common\Collection\PaginatedIterator;
</span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-keyword1">use</span> OpenCloud\Common\Exceptions;
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a>
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-comment">/**
</span></span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment"> * This class defines a cloud service; a relationship between a specific OpenStack
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * and a provided service, represented by a URL in the service catalog.
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> *
</span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> * Because Service is an abstract class, it cannot be called directly. Provider
</span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> * services such as Rackspace Cloud Servers or OpenStack Swift are each
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * subclassed from Service.
</span></span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-comment"> */</span>
</span><span id="33" class="l"><a class="l" href="#33"> 33: </a><span class="php-keyword1">abstract</span> <span class="php-keyword1">class</span> <a id="AbstractService" href="#AbstractService">AbstractService</a> <span class="php-keyword1">extends</span> Base <span class="php-keyword1">implements</span> ServiceInterface
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a>{
</span><span id="35" class="l"><a class="l" href="#35"> 35: </a> <span class="php-comment">/**
</span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> * @var \OpenCloud\Common\Http\Client The client which interacts with the API.
</span></span><span id="37" class="l"><a class="l" href="#37"> 37: </a><span class="php-comment"> */</span>
</span><span id="38" class="l"><a class="l" href="#38"> 38: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$client" href="#$client">$client</a></span>;
</span><span id="39" class="l"><a class="l" href="#39"> 39: </a>
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a> <span class="php-comment">/**
</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> * @var \OpenCloud\Common\Service\Endpoint The endpoint for this service.
</span></span><span id="42" class="l"><a class="l" href="#42"> 42: </a><span class="php-comment"> */</span>
</span><span id="43" class="l"><a class="l" href="#43"> 43: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$endpoint" href="#$endpoint">$endpoint</a></span>;
</span><span id="44" class="l"><a class="l" href="#44"> 44: </a>
</span><span id="45" class="l"><a class="l" href="#45"> 45: </a> <span class="php-comment">/**
</span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment"> * @var array A collection of resource models that this service has control over.
</span></span><span id="47" class="l"><a class="l" href="#47"> 47: </a><span class="php-comment"> */</span>
</span><span id="48" class="l"><a class="l" href="#48"> 48: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$resources" href="#$resources">$resources</a></span> = <span class="php-keyword1">array</span>();
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a>
</span><span id="50" class="l"><a class="l" href="#50"> 50: </a> <span class="php-comment">/**
</span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment"> * @var array Namespaces for this service.
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> */</span>
</span><span id="53" class="l"><a class="l" href="#53"> 53: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$namespaces" href="#$namespaces">$namespaces</a></span> = <span class="php-keyword1">array</span>();
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a>
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a> <span class="php-comment">/**
</span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment"> * @param ClientInterface $client
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> */</span>
</span><span id="58" class="l"><a class="l" href="#58"> 58: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_setClient" href="#_setClient">setClient</a>(ClientInterface <span class="php-var">$client</span>)
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a> {
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a> <span class="php-var">$this</span>->client = <span class="php-var">$client</span>;
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a> }
</span><span id="62" class="l"><a class="l" href="#62"> 62: </a>
</span><span id="63" class="l"><a class="l" href="#63"> 63: </a> <span class="php-comment">/**
</span></span><span id="64" class="l"><a class="l" href="#64"> 64: </a><span class="php-comment"> * @return \OpenCloud\Common\Http\Client
</span></span><span id="65" class="l"><a class="l" href="#65"> 65: </a><span class="php-comment"> */</span>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getClient" href="#_getClient">getClient</a>()
</span><span id="67" class="l"><a class="l" href="#67"> 67: </a> {
</span><span id="68" class="l"><a class="l" href="#68"> 68: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->client;
</span><span id="69" class="l"><a class="l" href="#69"> 69: </a> }
</span><span id="70" class="l"><a class="l" href="#70"> 70: </a>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a> <span class="php-comment">/**
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * @param Endpoint $endpoint
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> */</span>
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_setEndpoint" href="#_setEndpoint">setEndpoint</a>(<span class="php-var">$endpoint</span>)
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a> {
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a> <span class="php-var">$this</span>->endpoint = <span class="php-var">$endpoint</span>;
</span><span id="77" class="l"><a class="l" href="#77"> 77: </a> }
</span><span id="78" class="l"><a class="l" href="#78"> 78: </a>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a> <span class="php-comment">/**
</span></span><span id="80" class="l"><a class="l" href="#80"> 80: </a><span class="php-comment"> * @return \OpenCloud\Common\Service\Endpoint
</span></span><span id="81" class="l"><a class="l" href="#81"> 81: </a><span class="php-comment"> */</span>
</span><span id="82" class="l"><a class="l" href="#82"> 82: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getEndpoint" href="#_getEndpoint">getEndpoint</a>()
</span><span id="83" class="l"><a class="l" href="#83"> 83: </a> {
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->endpoint;
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a> }
</span><span id="86" class="l"><a class="l" href="#86"> 86: </a>
</span><span id="87" class="l"><a class="l" href="#87"> 87: </a> <span class="php-comment">/**
</span></span><span id="88" class="l"><a class="l" href="#88"> 88: </a><span class="php-comment"> * Get all associated resources for this service.
</span></span><span id="89" class="l"><a class="l" href="#89"> 89: </a><span class="php-comment"> *
</span></span><span id="90" class="l"><a class="l" href="#90"> 90: </a><span class="php-comment"> * @access public
</span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> * @return array
</span></span><span id="92" class="l"><a class="l" href="#92"> 92: </a><span class="php-comment"> */</span>
</span><span id="93" class="l"><a class="l" href="#93"> 93: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getResources" href="#_getResources">getResources</a>()
</span><span id="94" class="l"><a class="l" href="#94"> 94: </a> {
</span><span id="95" class="l"><a class="l" href="#95"> 95: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->resources;
</span><span id="96" class="l"><a class="l" href="#96"> 96: </a> }
</span><span id="97" class="l"><a class="l" href="#97"> 97: </a>
</span><span id="98" class="l"><a class="l" href="#98"> 98: </a> <span class="php-comment">/**
</span></span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-comment"> * Internal method for accessing child namespace from parent scope.
</span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment"> *
</span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment"> * @return type
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> */</span>
</span><span id="103" class="l"><a class="l" href="#103">103: </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">function</span> <a id="_getCurrentNamespace" href="#_getCurrentNamespace">getCurrentNamespace</a>()
</span><span id="104" class="l"><a class="l" href="#104">104: </a> {
</span><span id="105" class="l"><a class="l" href="#105">105: </a> <span class="php-var">$namespace</span> = <span class="php-keyword2">get_class</span>(<span class="php-var">$this</span>);
</span><span id="106" class="l"><a class="l" href="#106">106: </a>
</span><span id="107" class="l"><a class="l" href="#107">107: </a> <span class="php-keyword1">return</span> <span class="php-keyword2">substr</span>(<span class="php-var">$namespace</span>, <span class="php-num">0</span>, <span class="php-keyword2">strrpos</span>(<span class="php-var">$namespace</span>, <span class="php-quote">'\\'</span>));
</span><span id="108" class="l"><a class="l" href="#108">108: </a> }
</span><span id="109" class="l"><a class="l" href="#109">109: </a>
</span><span id="110" class="l"><a class="l" href="#110">110: </a> <span class="php-comment">/**
</span></span><span id="111" class="l"><a class="l" href="#111">111: </a><span class="php-comment"> * Resolves FQCN for local resource.
</span></span><span id="112" class="l"><a class="l" href="#112">112: </a><span class="php-comment"> *
</span></span><span id="113" class="l"><a class="l" href="#113">113: </a><span class="php-comment"> * @param $resourceName
</span></span><span id="114" class="l"><a class="l" href="#114">114: </a><span class="php-comment"> * @return string
</span></span><span id="115" class="l"><a class="l" href="#115">115: </a><span class="php-comment"> * @throws \OpenCloud\Common\Exceptions\UnrecognizedServiceError
</span></span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment"> */</span>
</span><span id="117" class="l"><a class="l" href="#117">117: </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">function</span> <a id="_resolveResourceClass" href="#_resolveResourceClass">resolveResourceClass</a>(<span class="php-var">$resourceName</span>)
</span><span id="118" class="l"><a class="l" href="#118">118: </a> {
</span><span id="119" class="l"><a class="l" href="#119">119: </a> <span class="php-var">$className</span> = <span class="php-keyword2">substr_count</span>(<span class="php-var">$resourceName</span>, <span class="php-quote">'\\'</span>)
</span><span id="120" class="l"><a class="l" href="#120">120: </a> ? <span class="php-var">$resourceName</span>
</span><span id="121" class="l"><a class="l" href="#121">121: </a> : <span class="php-var">$this</span>->getCurrentNamespace() . <span class="php-quote">'\\Resource\\'</span> . <span class="php-keyword2">ucfirst</span>(<span class="php-var">$resourceName</span>);
</span><span id="122" class="l"><a class="l" href="#122">122: </a>
</span><span id="123" class="l"><a class="l" href="#123">123: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">class_exists</span>(<span class="php-var">$className</span>)) {
</span><span id="124" class="l"><a class="l" href="#124">124: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Exceptions\UnrecognizedServiceError(<span class="php-keyword2">sprintf</span>(
</span><span id="125" class="l"><a class="l" href="#125">125: </a> <span class="php-quote">'%s resource does not exist, please try one of the following: %s'</span>,
</span><span id="126" class="l"><a class="l" href="#126">126: </a> <span class="php-var">$resourceName</span>,
</span><span id="127" class="l"><a class="l" href="#127">127: </a> <span class="php-keyword2">implode</span>(<span class="php-quote">', '</span>, <span class="php-var">$this</span>->getResources())
</span><span id="128" class="l"><a class="l" href="#128">128: </a> ));
</span><span id="129" class="l"><a class="l" href="#129">129: </a> }
</span><span id="130" class="l"><a class="l" href="#130">130: </a>
</span><span id="131" class="l"><a class="l" href="#131">131: </a> <span class="php-keyword1">return</span> <span class="php-var">$className</span>;
</span><span id="132" class="l"><a class="l" href="#132">132: </a> }
</span><span id="133" class="l"><a class="l" href="#133">133: </a>
</span><span id="134" class="l"><a class="l" href="#134">134: </a> <span class="php-comment">/**
</span></span><span id="135" class="l"><a class="l" href="#135">135: </a><span class="php-comment"> * Factory method for instantiating resource objects.
</span></span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment"> *
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> * @param string $resourceName
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> * @param mixed $info (default: null)
</span></span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-comment"> * @param mixed $parent The parent object
</span></span><span id="140" class="l"><a class="l" href="#140">140: </a><span class="php-comment"> * @return object
</span></span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment"> */</span>
</span><span id="142" class="l"><a class="l" href="#142">142: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_resource" href="#_resource">resource</a>(<span class="php-var">$resourceName</span>, <span class="php-var">$info</span> = <span class="php-keyword1">null</span>, <span class="php-var">$parent</span> = <span class="php-keyword1">null</span>)
</span><span id="143" class="l"><a class="l" href="#143">143: </a> {
</span><span id="144" class="l"><a class="l" href="#144">144: </a> <span class="php-var">$className</span> = <span class="php-var">$this</span>->resolveResourceClass(<span class="php-var">$resourceName</span>);
</span><span id="145" class="l"><a class="l" href="#145">145: </a>
</span><span id="146" class="l"><a class="l" href="#146">146: </a> <span class="php-var">$resource</span> = <span class="php-keyword1">new</span> <span class="php-var">$className</span>(<span class="php-var">$this</span>);
</span><span id="147" class="l"><a class="l" href="#147">147: </a>
</span><span id="148" class="l"><a class="l" href="#148">148: </a> <span class="php-keyword1">if</span> (<span class="php-var">$parent</span>) {
</span><span id="149" class="l"><a class="l" href="#149">149: </a> <span class="php-var">$resource</span>->setParent(<span class="php-var">$parent</span>);
</span><span id="150" class="l"><a class="l" href="#150">150: </a> }
</span><span id="151" class="l"><a class="l" href="#151">151: </a>
</span><span id="152" class="l"><a class="l" href="#152">152: </a> <span class="php-var">$resource</span>->populate(<span class="php-var">$info</span>);
</span><span id="153" class="l"><a class="l" href="#153">153: </a>
</span><span id="154" class="l"><a class="l" href="#154">154: </a> <span class="php-keyword1">return</span> <span class="php-var">$resource</span>;
</span><span id="155" class="l"><a class="l" href="#155">155: </a> }
</span><span id="156" class="l"><a class="l" href="#156">156: </a>
</span><span id="157" class="l"><a class="l" href="#157">157: </a> <span class="php-comment">/**
</span></span><span id="158" class="l"><a class="l" href="#158">158: </a><span class="php-comment"> * Factory method for instantiating a resource collection.
</span></span><span id="159" class="l"><a class="l" href="#159">159: </a><span class="php-comment"> *
</span></span><span id="160" class="l"><a class="l" href="#160">160: </a><span class="php-comment"> * @param string $resourceName
</span></span><span id="161" class="l"><a class="l" href="#161">161: </a><span class="php-comment"> * @param string|null $url
</span></span><span id="162" class="l"><a class="l" href="#162">162: </a><span class="php-comment"> * @param string|null $parent
</span></span><span id="163" class="l"><a class="l" href="#163">163: </a><span class="php-comment"> * @return PaginatedIterator
</span></span><span id="164" class="l"><a class="l" href="#164">164: </a><span class="php-comment"> */</span>
</span><span id="165" class="l"><a class="l" href="#165">165: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_resourceList" href="#_resourceList">resourceList</a>(<span class="php-var">$resourceName</span>, <span class="php-var">$url</span> = <span class="php-keyword1">null</span>, <span class="php-var">$parent</span> = <span class="php-keyword1">null</span>)
</span><span id="166" class="l"><a class="l" href="#166">166: </a> {
</span><span id="167" class="l"><a class="l" href="#167">167: </a> <span class="php-var">$className</span> = <span class="php-var">$this</span>->resolveResourceClass(<span class="php-var">$resourceName</span>);
</span><span id="168" class="l"><a class="l" href="#168">168: </a>
</span><span id="169" class="l"><a class="l" href="#169">169: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->collection(<span class="php-var">$className</span>, <span class="php-var">$url</span>, <span class="php-var">$parent</span>);
</span><span id="170" class="l"><a class="l" href="#170">170: </a> }
</span><span id="171" class="l"><a class="l" href="#171">171: </a>
</span><span id="172" class="l"><a class="l" href="#172">172: </a> <span class="php-comment">/**
</span></span><span id="173" class="l"><a class="l" href="#173">173: </a><span class="php-comment"> * @codeCoverageIgnore
</span></span><span id="174" class="l"><a class="l" href="#174">174: </a><span class="php-comment"> */</span>
</span><span id="175" class="l"><a class="l" href="#175">175: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_collection" href="#_collection">collection</a>(<span class="php-var">$class</span>, <span class="php-var">$url</span> = <span class="php-keyword1">null</span>, <span class="php-var">$parent</span> = <span class="php-keyword1">null</span>, <span class="php-var">$data</span> = <span class="php-keyword1">null</span>)
</span><span id="176" class="l"><a class="l" href="#176">176: </a> {
</span><span id="177" class="l"><a class="l" href="#177">177: </a> <span class="php-keyword1">if</span> (!<span class="php-var">$parent</span>) {
</span><span id="178" class="l"><a class="l" href="#178">178: </a> <span class="php-var">$parent</span> = <span class="php-var">$this</span>;
</span><span id="179" class="l"><a class="l" href="#179">179: </a> }
</span><span id="180" class="l"><a class="l" href="#180">180: </a>
</span><span id="181" class="l"><a class="l" href="#181">181: </a> <span class="php-keyword1">if</span> (!<span class="php-var">$url</span>) {
</span><span id="182" class="l"><a class="l" href="#182">182: </a> <span class="php-var">$resource</span> = <span class="php-var">$this</span>->resolveResourceClass(<span class="php-var">$class</span>);
</span><span id="183" class="l"><a class="l" href="#183">183: </a> <span class="php-var">$url</span> = <span class="php-var">$parent</span>->getUrl(<span class="php-var">$resource</span>::resourceName());
</span><span id="184" class="l"><a class="l" href="#184">184: </a> }
</span><span id="185" class="l"><a class="l" href="#185">185: </a>
</span><span id="186" class="l"><a class="l" href="#186">186: </a> <span class="php-var">$options</span> = <span class="php-var">$this</span>->makeResourceIteratorOptions(<span class="php-var">$this</span>->resolveResourceClass(<span class="php-var">$class</span>));
</span><span id="187" class="l"><a class="l" href="#187">187: </a> <span class="php-var">$options</span>[<span class="php-quote">'baseUrl'</span>] = <span class="php-var">$url</span>;
</span><span id="188" class="l"><a class="l" href="#188">188: </a>
</span><span id="189" class="l"><a class="l" href="#189">189: </a> <span class="php-keyword1">return</span> PaginatedIterator::factory(<span class="php-var">$parent</span>, <span class="php-var">$options</span>, <span class="php-var">$data</span>);
</span><span id="190" class="l"><a class="l" href="#190">190: </a> }
</span><span id="191" class="l"><a class="l" href="#191">191: </a>
</span><span id="192" class="l"><a class="l" href="#192">192: </a> <span class="php-comment">/**
</span></span><span id="193" class="l"><a class="l" href="#193">193: </a><span class="php-comment"> * @deprecated
</span></span><span id="194" class="l"><a class="l" href="#194">194: </a><span class="php-comment"> */</span>
</span><span id="195" class="l"><a class="l" href="#195">195: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_namespaces" href="#_namespaces">namespaces</a>()
</span><span id="196" class="l"><a class="l" href="#196">196: </a> {
</span><span id="197" class="l"><a class="l" href="#197">197: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->getNamespaces();
</span><span id="198" class="l"><a class="l" href="#198">198: </a> }
</span><span id="199" class="l"><a class="l" href="#199">199: </a>
</span><span id="200" class="l"><a class="l" href="#200">200: </a> <span class="php-comment">/**
</span></span><span id="201" class="l"><a class="l" href="#201">201: </a><span class="php-comment"> * Returns a list of supported namespaces
</span></span><span id="202" class="l"><a class="l" href="#202">202: </a><span class="php-comment"> *
</span></span><span id="203" class="l"><a class="l" href="#203">203: </a><span class="php-comment"> * @return array
</span></span><span id="204" class="l"><a class="l" href="#204">204: </a><span class="php-comment"> */</span>
</span><span id="205" class="l"><a class="l" href="#205">205: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getNamespaces" href="#_getNamespaces">getNamespaces</a>()
</span><span id="206" class="l"><a class="l" href="#206">206: </a> {
</span><span id="207" class="l"><a class="l" href="#207">207: </a> <span class="php-keyword1">return</span> (<span class="php-keyword1">isset</span>(<span class="php-var">$this</span>->namespaces) && <span class="php-keyword2">is_array</span>(<span class="php-var">$this</span>->namespaces))
</span><span id="208" class="l"><a class="l" href="#208">208: </a> ? <span class="php-var">$this</span>->namespaces
</span><span id="209" class="l"><a class="l" href="#209">209: </a> : <span class="php-keyword1">array</span>();
</span><span id="210" class="l"><a class="l" href="#210">210: </a> }
</span><span id="211" class="l"><a class="l" href="#211">211: </a>}
</span><span id="212" class="l"><a class="l" href="#212">212: </a></span></code></pre>
<div id="footer">
PHP OpenCloud API API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
</div>
</div>
</div>
</body>
</html>
|