/usr/share/doc/php-opencloud/api/source-class-OpenCloud.Common.Base.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 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 | <!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/Base.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><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><a href="class-OpenCloud.Common.ArrayAccess.html">ArrayAccess</a></li>
<li class="active"><a href="class-OpenCloud.Common.Base.html">Base</a></li>
<li><a href="class-OpenCloud.Common.Lang.html">Lang</a></li>
<li><a href="class-OpenCloud.Common.Metadata.html">Metadata</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.html" title="Summary of OpenCloud\Common"><span>Namespace</span></a>
</li>
<li>
<a href="class-OpenCloud.Common.Base.html" title="Summary of OpenCloud\Common\Base"><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;
</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> OpenCloud\Common\Collection\ResourceIterator;
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-keyword1">use</span> OpenCloud\Common\Constants\<span class="php-keyword2">Header</span> <span class="php-keyword1">as</span> HeaderConst;
</span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-keyword1">use</span> OpenCloud\Common\Constants\Mime <span class="php-keyword1">as</span> MimeConst;
</span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-keyword1">use</span> OpenCloud\Common\Exceptions\JsonError;
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">use</span> Psr\<span class="php-keyword2">Log</span>\LoggerInterface;
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a>
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a><span class="php-comment">/**
</span></span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment"> * The root class for all other objects used or defined by this SDK.
</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"> * It contains common code for error handling as well as service functions that
</span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> * are useful. Because it is an abstract class, it cannot be called directly,
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> * and it has no publicly-visible properties.
</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="Base" href="#Base">Base</a>
</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"> * Holds all the properties added by overloading.
</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-comment"> * @var array
</span></span><span id="39" class="l"><a class="l" href="#39"> 39: </a><span class="php-comment"> */</span>
</span><span id="40" class="l"><a class="l" href="#40"> 40: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$properties" href="#$properties">$properties</a></span> = <span class="php-keyword1">array</span>();
</span><span id="41" class="l"><a class="l" href="#41"> 41: </a>
</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-comment"> * The logger instance
</span></span><span id="44" class="l"><a class="l" href="#44"> 44: </a><span class="php-comment"> *
</span></span><span id="45" class="l"><a class="l" href="#45"> 45: </a><span class="php-comment"> * @var LoggerInterface
</span></span><span id="46" class="l"><a class="l" href="#46"> 46: </a><span class="php-comment"> */</span>
</span><span id="47" class="l"><a class="l" href="#47"> 47: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$logger" href="#$logger">$logger</a></span>;
</span><span id="48" class="l"><a class="l" href="#48"> 48: </a>
</span><span id="49" class="l"><a class="l" href="#49"> 49: </a> <span class="php-comment">/**
</span></span><span id="50" class="l"><a class="l" href="#50"> 50: </a><span class="php-comment"> * The aliases configure for the properties of the instance.
</span></span><span id="51" class="l"><a class="l" href="#51"> 51: </a><span class="php-comment"> *
</span></span><span id="52" class="l"><a class="l" href="#52"> 52: </a><span class="php-comment"> * @var array
</span></span><span id="53" class="l"><a class="l" href="#53"> 53: </a><span class="php-comment"> */</span>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a> <span class="php-keyword1">protected</span> <span class="php-var"><a id="$aliases" href="#$aliases">$aliases</a></span> = <span class="php-keyword1">array</span>();
</span><span id="55" class="l"><a class="l" href="#55"> 55: </a>
</span><span id="56" class="l"><a class="l" href="#56"> 56: </a> <span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57"> 57: </a><span class="php-comment"> * @return static
</span></span><span id="58" class="l"><a class="l" href="#58"> 58: </a><span class="php-comment"> */</span>
</span><span id="59" class="l"><a class="l" href="#59"> 59: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_getInstance" href="#_getInstance">getInstance</a>()
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a> {
</span><span id="61" class="l"><a class="l" href="#61"> 61: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">new</span> <span class="php-keyword1">static</span>();
</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><span id="64" class="l"><a class="l" href="#64"> 64: </a> <span class="php-comment">/**
</span></span><span id="65" class="l"><a class="l" href="#65"> 65: </a><span class="php-comment"> * Intercept non-existent method calls for dynamic getter/setter functionality.
</span></span><span id="66" class="l"><a class="l" href="#66"> 66: </a><span class="php-comment"> *
</span></span><span id="67" class="l"><a class="l" href="#67"> 67: </a><span class="php-comment"> * @param $method
</span></span><span id="68" class="l"><a class="l" href="#68"> 68: </a><span class="php-comment"> * @param $args
</span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment"> * @throws Exceptions\RuntimeException
</span></span><span id="70" class="l"><a class="l" href="#70"> 70: </a><span class="php-comment"> */</span>
</span><span id="71" class="l"><a class="l" href="#71"> 71: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="___call" href="#___call">__call</a>(<span class="php-var">$method</span>, <span class="php-var">$args</span>)
</span><span id="72" class="l"><a class="l" href="#72"> 72: </a> {
</span><span id="73" class="l"><a class="l" href="#73"> 73: </a> <span class="php-var">$prefix</span> = <span class="php-keyword2">substr</span>(<span class="php-var">$method</span>, <span class="php-num">0</span>, <span class="php-num">3</span>);
</span><span id="74" class="l"><a class="l" href="#74"> 74: </a>
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a> <span class="php-comment">// Get property - convert from camel case to underscore</span>
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a> <span class="php-var">$property</span> = <span class="php-keyword2">lcfirst</span>(<span class="php-keyword2">substr</span>(<span class="php-var">$method</span>, <span class="php-num">3</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 class="php-comment">// Only do these methods on properties which exist</span>
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a> <span class="php-keyword1">if</span> (<span class="php-var">$this</span>->propertyExists(<span class="php-var">$property</span>) && <span class="php-var">$prefix</span> == <span class="php-quote">'get'</span>) {
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->getProperty(<span class="php-var">$property</span>);
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a> }
</span><span id="82" class="l"><a class="l" href="#82"> 82: </a>
</span><span id="83" class="l"><a class="l" href="#83"> 83: </a> <span class="php-comment">// Do setter</span>
</span><span id="84" class="l"><a class="l" href="#84"> 84: </a> <span class="php-keyword1">if</span> (<span class="php-var">$this</span>->propertyExists(<span class="php-var">$property</span>) && <span class="php-var">$prefix</span> == <span class="php-quote">'set'</span>) {
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->setProperty(<span class="php-var">$property</span>, <span class="php-var">$args</span>[<span class="php-num">0</span>]);
</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><span id="88" class="l"><a class="l" href="#88"> 88: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Exceptions\RuntimeException(<span class="php-keyword2">sprintf</span>(
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a> <span class="php-quote">'No method %s::%s()'</span>,
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a> <span class="php-keyword2">get_class</span>(<span class="php-var">$this</span>),
</span><span id="91" class="l"><a class="l" href="#91"> 91: </a> <span class="php-var">$method</span>
</span><span id="92" class="l"><a class="l" href="#92"> 92: </a> ));
</span><span id="93" class="l"><a class="l" href="#93"> 93: </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-comment">/**
</span></span><span id="96" class="l"><a class="l" href="#96"> 96: </a><span class="php-comment"> * We can set a property under three conditions:
</span></span><span id="97" class="l"><a class="l" href="#97"> 97: </a><span class="php-comment"> *
</span></span><span id="98" class="l"><a class="l" href="#98"> 98: </a><span class="php-comment"> * 1. If it has a concrete setter: setProperty()
</span></span><span id="99" class="l"><a class="l" href="#99"> 99: </a><span class="php-comment"> * 2. If the property exists
</span></span><span id="100" class="l"><a class="l" href="#100">100: </a><span class="php-comment"> * 3. If the property name's prefix is in an approved list
</span></span><span id="101" class="l"><a class="l" href="#101">101: </a><span class="php-comment"> *
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * @param mixed $property
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> * @param mixed $value
</span></span><span id="104" class="l"><a class="l" href="#104">104: </a><span class="php-comment"> * @return mixed
</span></span><span id="105" class="l"><a class="l" href="#105">105: </a><span class="php-comment"> */</span>
</span><span id="106" class="l"><a class="l" href="#106">106: </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">function</span> <a id="_setProperty" href="#_setProperty">setProperty</a>(<span class="php-var">$property</span>, <span class="php-var">$value</span>)
</span><span id="107" class="l"><a class="l" href="#107">107: </a> {
</span><span id="108" class="l"><a class="l" href="#108">108: </a> <span class="php-var">$setter</span> = <span class="php-quote">'set'</span> . <span class="php-var">$this</span>->toCamel(<span class="php-var">$property</span>);
</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-keyword1">if</span> (<span class="php-keyword2">method_exists</span>(<span class="php-var">$this</span>, <span class="php-var">$setter</span>)) {
</span><span id="111" class="l"><a class="l" href="#111">111: </a> <span class="php-keyword1">return</span> <span class="php-keyword2">call_user_func</span>(<span class="php-keyword1">array</span>(<span class="php-var">$this</span>, <span class="php-var">$setter</span>), <span class="php-var">$value</span>);
</span><span id="112" class="l"><a class="l" href="#112">112: </a> } <span class="php-keyword1">elseif</span> (<span class="php-keyword1">false</span> !== (<span class="php-var">$propertyVal</span> = <span class="php-var">$this</span>->propertyExists(<span class="php-var">$property</span>))) {
</span><span id="113" class="l"><a class="l" href="#113">113: </a>
</span><span id="114" class="l"><a class="l" href="#114">114: </a> <span class="php-comment">// Are we setting a public or private property?</span>
</span><span id="115" class="l"><a class="l" href="#115">115: </a> <span class="php-keyword1">if</span> (<span class="php-var">$this</span>->isAccessible(<span class="php-var">$propertyVal</span>)) {
</span><span id="116" class="l"><a class="l" href="#116">116: </a> <span class="php-var">$this</span>-><span class="php-var">$propertyVal</span> = <span class="php-var">$value</span>;
</span><span id="117" class="l"><a class="l" href="#117">117: </a> } <span class="php-keyword1">else</span> {
</span><span id="118" class="l"><a class="l" href="#118">118: </a> <span class="php-var">$this</span>->properties[<span class="php-var">$propertyVal</span>] = <span class="php-var">$value</span>;
</span><span id="119" class="l"><a class="l" href="#119">119: </a> }
</span><span id="120" class="l"><a class="l" href="#120">120: </a>
</span><span id="121" class="l"><a class="l" href="#121">121: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>;
</span><span id="122" class="l"><a class="l" href="#122">122: </a> } <span class="php-keyword1">else</span> {
</span><span id="123" class="l"><a class="l" href="#123">123: </a>
</span><span id="124" class="l"><a class="l" href="#124">124: </a> <span class="php-var">$this</span>->getLogger()->warning(
</span><span id="125" class="l"><a class="l" href="#125">125: </a> <span class="php-quote">'Attempted to set {property} with value {value}, but the'</span>
</span><span id="126" class="l"><a class="l" href="#126">126: </a> . <span class="php-quote">' property has not been defined. Please define first.'</span>,
</span><span id="127" class="l"><a class="l" href="#127">127: </a> <span class="php-keyword1">array</span>(
</span><span id="128" class="l"><a class="l" href="#128">128: </a> <span class="php-quote">'property'</span> => <span class="php-var">$property</span>,
</span><span id="129" class="l"><a class="l" href="#129">129: </a> <span class="php-quote">'value'</span> => <span class="php-keyword2">print_r</span>(<span class="php-var">$value</span>, <span class="php-keyword1">true</span>)
</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><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><span id="135" class="l"><a class="l" href="#135">135: </a> <span class="php-comment">/**
</span></span><span id="136" class="l"><a class="l" href="#136">136: </a><span class="php-comment"> * Basic check to see whether property exists.
</span></span><span id="137" class="l"><a class="l" href="#137">137: </a><span class="php-comment"> *
</span></span><span id="138" class="l"><a class="l" href="#138">138: </a><span class="php-comment"> * @param string $property The property name being investigated.
</span></span><span id="139" class="l"><a class="l" href="#139">139: </a><span class="php-comment"> * @param bool $allowRetry If set to TRUE, the check will try to format the name in underscores because
</span></span><span id="140" class="l"><a class="l" href="#140">140: </a><span class="php-comment"> * there are sometimes discrepancies between camelCaseNames and underscore_names.
</span></span><span id="141" class="l"><a class="l" href="#141">141: </a><span class="php-comment"> * @return bool
</span></span><span id="142" class="l"><a class="l" href="#142">142: </a><span class="php-comment"> */</span>
</span><span id="143" class="l"><a class="l" href="#143">143: </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">function</span> <a id="_propertyExists" href="#_propertyExists">propertyExists</a>(<span class="php-var">$property</span>, <span class="php-var">$allowRetry</span> = <span class="php-keyword1">true</span>)
</span><span id="144" class="l"><a class="l" href="#144">144: </a> {
</span><span id="145" class="l"><a class="l" href="#145">145: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword2">property_exists</span>(<span class="php-var">$this</span>, <span class="php-var">$property</span>) && !<span class="php-var">$this</span>->checkAttributePrefix(<span class="php-var">$property</span>)) {
</span><span id="146" class="l"><a class="l" href="#146">146: </a> <span class="php-comment">// Convert to under_score and retry</span>
</span><span id="147" class="l"><a class="l" href="#147">147: </a> <span class="php-keyword1">if</span> (<span class="php-var">$allowRetry</span>) {
</span><span id="148" class="l"><a class="l" href="#148">148: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->propertyExists(<span class="php-var">$this</span>->toUnderscores(<span class="php-var">$property</span>), <span class="php-keyword1">false</span>);
</span><span id="149" class="l"><a class="l" href="#149">149: </a> } <span class="php-keyword1">else</span> {
</span><span id="150" class="l"><a class="l" href="#150">150: </a> <span class="php-var">$property</span> = <span class="php-keyword1">false</span>;
</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><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">$property</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"> * Convert a string to camelCase format.
</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
</span></span><span id="161" class="l"><a class="l" href="#161">161: </a><span class="php-comment"> * @param bool $capitalise Optional flag which allows for word capitalization.
</span></span><span id="162" class="l"><a class="l" href="#162">162: </a><span class="php-comment"> * @return mixed
</span></span><span id="163" class="l"><a class="l" href="#163">163: </a><span class="php-comment"> */</span>
</span><span id="164" class="l"><a class="l" href="#164">164: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_toCamel" href="#_toCamel">toCamel</a>(<span class="php-var">$string</span>, <span class="php-var">$capitalise</span> = <span class="php-keyword1">true</span>)
</span><span id="165" class="l"><a class="l" href="#165">165: </a> {
</span><span id="166" class="l"><a class="l" href="#166">166: </a> <span class="php-keyword1">if</span> (<span class="php-var">$capitalise</span>) {
</span><span id="167" class="l"><a class="l" href="#167">167: </a> <span class="php-var">$string</span> = <span class="php-keyword2">ucfirst</span>(<span class="php-var">$string</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><span id="170" class="l"><a class="l" href="#170">170: </a> <span class="php-keyword1">return</span> <span class="php-keyword2">preg_replace_callback</span>(<span class="php-quote">'/_([a-z])/'</span>, <span class="php-keyword1">function</span> (<span class="php-var">$char</span>) {
</span><span id="171" class="l"><a class="l" href="#171">171: </a> <span class="php-keyword1">return</span> <span class="php-keyword2">strtoupper</span>(<span class="php-var">$char</span>[<span class="php-num">1</span>]);
</span><span id="172" class="l"><a class="l" href="#172">172: </a> }, <span class="php-var">$string</span>);
</span><span id="173" class="l"><a class="l" href="#173">173: </a> }
</span><span id="174" class="l"><a class="l" href="#174">174: </a>
</span><span id="175" class="l"><a class="l" href="#175">175: </a> <span class="php-comment">/**
</span></span><span id="176" class="l"><a class="l" href="#176">176: </a><span class="php-comment"> * Convert string to underscore format.
</span></span><span id="177" class="l"><a class="l" href="#177">177: </a><span class="php-comment"> *
</span></span><span id="178" class="l"><a class="l" href="#178">178: </a><span class="php-comment"> * @param $string
</span></span><span id="179" class="l"><a class="l" href="#179">179: </a><span class="php-comment"> * @return mixed
</span></span><span id="180" class="l"><a class="l" href="#180">180: </a><span class="php-comment"> */</span>
</span><span id="181" class="l"><a class="l" href="#181">181: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_toUnderscores" href="#_toUnderscores">toUnderscores</a>(<span class="php-var">$string</span>)
</span><span id="182" class="l"><a class="l" href="#182">182: </a> {
</span><span id="183" class="l"><a class="l" href="#183">183: </a> <span class="php-var">$string</span> = <span class="php-keyword2">lcfirst</span>(<span class="php-var">$string</span>);
</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 class="php-keyword1">return</span> <span class="php-keyword2">preg_replace_callback</span>(<span class="php-quote">'/([A-Z])/'</span>, <span class="php-keyword1">function</span> (<span class="php-var">$char</span>) {
</span><span id="186" class="l"><a class="l" href="#186">186: </a> <span class="php-keyword1">return</span> <span class="php-quote">"_"</span> . <span class="php-keyword2">strtolower</span>(<span class="php-var">$char</span>[<span class="php-num">1</span>]);
</span><span id="187" class="l"><a class="l" href="#187">187: </a> }, <span class="php-var">$string</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><span id="190" class="l"><a class="l" href="#190">190: </a> <span class="php-comment">/**
</span></span><span id="191" class="l"><a class="l" href="#191">191: </a><span class="php-comment"> * Does the property exist in the object variable list (i.e. does it have public or protected visibility?)
</span></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"> * @param $property
</span></span><span id="194" class="l"><a class="l" href="#194">194: </a><span class="php-comment"> * @return bool
</span></span><span id="195" class="l"><a class="l" href="#195">195: </a><span class="php-comment"> */</span>
</span><span id="196" class="l"><a class="l" href="#196">196: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_isAccessible" href="#_isAccessible">isAccessible</a>(<span class="php-var">$property</span>)
</span><span id="197" class="l"><a class="l" href="#197">197: </a> {
</span><span id="198" class="l"><a class="l" href="#198">198: </a> <span class="php-keyword1">return</span> <span class="php-keyword2">array_key_exists</span>(<span class="php-var">$property</span>, <span class="php-keyword2">get_object_vars</span>(<span class="php-var">$this</span>));
</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><span id="201" class="l"><a class="l" href="#201">201: </a> <span class="php-comment">/**
</span></span><span id="202" class="l"><a class="l" href="#202">202: </a><span class="php-comment"> * Checks the attribute $property and only permits it if the prefix is
</span></span><span id="203" class="l"><a class="l" href="#203">203: </a><span class="php-comment"> * in the specified $prefixes 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-comment"> * This is to support extension namespaces in some services.
</span></span><span id="206" class="l"><a class="l" href="#206">206: </a><span class="php-comment"> *
</span></span><span id="207" class="l"><a class="l" href="#207">207: </a><span class="php-comment"> * @param string $property the name of the attribute
</span></span><span id="208" class="l"><a class="l" href="#208">208: </a><span class="php-comment"> * @return boolean
</span></span><span id="209" class="l"><a class="l" href="#209">209: </a><span class="php-comment"> */</span>
</span><span id="210" class="l"><a class="l" href="#210">210: </a> <span class="php-keyword1">private</span> <span class="php-keyword1">function</span> <a id="_checkAttributePrefix" href="#_checkAttributePrefix">checkAttributePrefix</a>(<span class="php-var">$property</span>)
</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 class="php-keyword1">if</span> (!<span class="php-keyword2">method_exists</span>(<span class="php-var">$this</span>, <span class="php-quote">'getService'</span>)) {
</span><span id="213" class="l"><a class="l" href="#213">213: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">false</span>;
</span><span id="214" class="l"><a class="l" href="#214">214: </a> }
</span><span id="215" class="l"><a class="l" href="#215">215: </a> <span class="php-var">$prefix</span> = <span class="php-keyword2">strstr</span>(<span class="php-var">$property</span>, <span class="php-quote">':'</span>, <span class="php-keyword1">true</span>);
</span><span id="216" class="l"><a class="l" href="#216">216: </a>
</span><span id="217" class="l"><a class="l" href="#217">217: </a> <span class="php-keyword1">return</span> <span class="php-keyword2">in_array</span>(<span class="php-var">$prefix</span>, <span class="php-var">$this</span>->getService()->namespaces());
</span><span id="218" class="l"><a class="l" href="#218">218: </a> }
</span><span id="219" class="l"><a class="l" href="#219">219: </a>
</span><span id="220" class="l"><a class="l" href="#220">220: </a> <span class="php-comment">/**
</span></span><span id="221" class="l"><a class="l" href="#221">221: </a><span class="php-comment"> * Grab value out of the data array.
</span></span><span id="222" class="l"><a class="l" href="#222">222: </a><span class="php-comment"> *
</span></span><span id="223" class="l"><a class="l" href="#223">223: </a><span class="php-comment"> * @param string $property
</span></span><span id="224" class="l"><a class="l" href="#224">224: </a><span class="php-comment"> * @return mixed
</span></span><span id="225" class="l"><a class="l" href="#225">225: </a><span class="php-comment"> */</span>
</span><span id="226" class="l"><a class="l" href="#226">226: </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">function</span> <a id="_getProperty" href="#_getProperty">getProperty</a>(<span class="php-var">$property</span>)
</span><span id="227" class="l"><a class="l" href="#227">227: </a> {
</span><span id="228" class="l"><a class="l" href="#228">228: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">array_key_exists</span>(<span class="php-var">$property</span>, <span class="php-var">$this</span>->properties)) {
</span><span id="229" class="l"><a class="l" href="#229">229: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->properties[<span class="php-var">$property</span>];
</span><span id="230" class="l"><a class="l" href="#230">230: </a> } <span class="php-keyword1">elseif</span> (<span class="php-keyword2">array_key_exists</span>(<span class="php-var">$this</span>->toUnderscores(<span class="php-var">$property</span>), <span class="php-var">$this</span>->properties)) {
</span><span id="231" class="l"><a class="l" href="#231">231: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->properties[<span class="php-var">$this</span>->toUnderscores(<span class="php-var">$property</span>)];
</span><span id="232" class="l"><a class="l" href="#232">232: </a> } <span class="php-keyword1">elseif</span> (<span class="php-keyword2">method_exists</span>(<span class="php-var">$this</span>, <span class="php-quote">'get'</span> . <span class="php-keyword2">ucfirst</span>(<span class="php-var">$property</span>))) {
</span><span id="233" class="l"><a class="l" href="#233">233: </a> <span class="php-keyword1">return</span> <span class="php-keyword2">call_user_func</span>(<span class="php-keyword1">array</span>(<span class="php-var">$this</span>, <span class="php-quote">'get'</span> . <span class="php-keyword2">ucfirst</span>(<span class="php-var">$property</span>)));
</span><span id="234" class="l"><a class="l" href="#234">234: </a> } <span class="php-keyword1">elseif</span> (<span class="php-keyword1">false</span> !== (<span class="php-var">$propertyVal</span> = <span class="php-var">$this</span>->propertyExists(<span class="php-var">$property</span>)) && <span class="php-var">$this</span>->isAccessible(<span class="php-var">$propertyVal</span>)) {
</span><span id="235" class="l"><a class="l" href="#235">235: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-><span class="php-var">$propertyVal</span>;
</span><span id="236" class="l"><a class="l" href="#236">236: </a> }
</span><span id="237" class="l"><a class="l" href="#237">237: </a>
</span><span id="238" class="l"><a class="l" href="#238">238: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">null</span>;
</span><span id="239" class="l"><a class="l" href="#239">239: </a> }
</span><span id="240" class="l"><a class="l" href="#240">240: </a>
</span><span id="241" class="l"><a class="l" href="#241">241: </a> <span class="php-comment">/**
</span></span><span id="242" class="l"><a class="l" href="#242">242: </a><span class="php-comment"> * Sets the logger.
</span></span><span id="243" class="l"><a class="l" href="#243">243: </a><span class="php-comment"> *
</span></span><span id="244" class="l"><a class="l" href="#244">244: </a><span class="php-comment"> * @param Log\LoggerInterface $logger
</span></span><span id="245" class="l"><a class="l" href="#245">245: </a><span class="php-comment"> * @return $this
</span></span><span id="246" class="l"><a class="l" href="#246">246: </a><span class="php-comment"> */</span>
</span><span id="247" class="l"><a class="l" href="#247">247: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_setLogger" href="#_setLogger">setLogger</a>(<span class="php-keyword2">Log</span>\LoggerInterface <span class="php-var">$logger</span>)
</span><span id="248" class="l"><a class="l" href="#248">248: </a> {
</span><span id="249" class="l"><a class="l" href="#249">249: </a> <span class="php-var">$this</span>->logger = <span class="php-var">$logger</span>;
</span><span id="250" class="l"><a class="l" href="#250">250: </a>
</span><span id="251" class="l"><a class="l" href="#251">251: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>;
</span><span id="252" class="l"><a class="l" href="#252">252: </a> }
</span><span id="253" class="l"><a class="l" href="#253">253: </a>
</span><span id="254" class="l"><a class="l" href="#254">254: </a> <span class="php-comment">/**
</span></span><span id="255" class="l"><a class="l" href="#255">255: </a><span class="php-comment"> * Returns the Logger object.
</span></span><span id="256" class="l"><a class="l" href="#256">256: </a><span class="php-comment"> *
</span></span><span id="257" class="l"><a class="l" href="#257">257: </a><span class="php-comment"> * @return \OpenCloud\Common\Log\AbstractLogger
</span></span><span id="258" class="l"><a class="l" href="#258">258: </a><span class="php-comment"> */</span>
</span><span id="259" class="l"><a class="l" href="#259">259: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getLogger" href="#_getLogger">getLogger</a>()
</span><span id="260" class="l"><a class="l" href="#260">260: </a> {
</span><span id="261" class="l"><a class="l" href="#261">261: </a> <span class="php-keyword1">if</span> (<span class="php-keyword1">null</span> === <span class="php-var">$this</span>->logger) {
</span><span id="262" class="l"><a class="l" href="#262">262: </a> <span class="php-var">$this</span>->setLogger(<span class="php-keyword1">new</span> <span class="php-keyword2">Log</span>\Logger);
</span><span id="263" class="l"><a class="l" href="#263">263: </a> }
</span><span id="264" class="l"><a class="l" href="#264">264: </a>
</span><span id="265" class="l"><a class="l" href="#265">265: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->logger;
</span><span id="266" class="l"><a class="l" href="#266">266: </a> }
</span><span id="267" class="l"><a class="l" href="#267">267: </a>
</span><span id="268" class="l"><a class="l" href="#268">268: </a> <span class="php-comment">/**
</span></span><span id="269" class="l"><a class="l" href="#269">269: </a><span class="php-comment"> * @deprecated
</span></span><span id="270" class="l"><a class="l" href="#270">270: </a><span class="php-comment"> */</span>
</span><span id="271" class="l"><a class="l" href="#271">271: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_url" href="#_url">url</a>(<span class="php-var">$path</span> = <span class="php-keyword1">null</span>, <span class="php-keyword1">array</span> <span class="php-var">$query</span> = <span class="php-keyword1">array</span>())
</span><span id="272" class="l"><a class="l" href="#272">272: </a> {
</span><span id="273" class="l"><a class="l" href="#273">273: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->getUrl(<span class="php-var">$path</span>, <span class="php-var">$query</span>);
</span><span id="274" class="l"><a class="l" href="#274">274: </a> }
</span><span id="275" class="l"><a class="l" href="#275">275: </a>
</span><span id="276" class="l"><a class="l" href="#276">276: </a> <span class="php-comment">/**
</span></span><span id="277" class="l"><a class="l" href="#277">277: </a><span class="php-comment"> * Populates the current object based on an unknown data type.
</span></span><span id="278" class="l"><a class="l" href="#278">278: </a><span class="php-comment"> *
</span></span><span id="279" class="l"><a class="l" href="#279">279: </a><span class="php-comment"> * @param mixed $info
</span></span><span id="280" class="l"><a class="l" href="#280">280: </a><span class="php-comment"> * @param bool
</span></span><span id="281" class="l"><a class="l" href="#281">281: </a><span class="php-comment"> * @throws Exceptions\InvalidArgumentError
</span></span><span id="282" class="l"><a class="l" href="#282">282: </a><span class="php-comment"> */</span>
</span><span id="283" class="l"><a class="l" href="#283">283: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_populate" href="#_populate">populate</a>(<span class="php-var">$info</span>, <span class="php-var">$setObjects</span> = <span class="php-keyword1">true</span>)
</span><span id="284" class="l"><a class="l" href="#284">284: </a> {
</span><span id="285" class="l"><a class="l" href="#285">285: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">is_string</span>(<span class="php-var">$info</span>) || <span class="php-keyword2">is_integer</span>(<span class="php-var">$info</span>)) {
</span><span id="286" class="l"><a class="l" href="#286">286: </a>
</span><span id="287" class="l"><a class="l" href="#287">287: </a> <span class="php-var">$this</span>->setProperty(<span class="php-var">$this</span>->primaryKeyField(), <span class="php-var">$info</span>);
</span><span id="288" class="l"><a class="l" href="#288">288: </a> <span class="php-var">$this</span>->refresh(<span class="php-var">$info</span>);
</span><span id="289" class="l"><a class="l" href="#289">289: </a> } <span class="php-keyword1">elseif</span> (<span class="php-keyword2">is_object</span>(<span class="php-var">$info</span>) || <span class="php-keyword2">is_array</span>(<span class="php-var">$info</span>)) {
</span><span id="290" class="l"><a class="l" href="#290">290: </a>
</span><span id="291" class="l"><a class="l" href="#291">291: </a> <span class="php-keyword1">foreach</span> (<span class="php-var">$info</span> <span class="php-keyword1">as</span> <span class="php-var">$key</span> => <span class="php-var">$value</span>) {
</span><span id="292" class="l"><a class="l" href="#292">292: </a>
</span><span id="293" class="l"><a class="l" href="#293">293: </a> <span class="php-keyword1">if</span> (<span class="php-var">$key</span> == <span class="php-quote">'metadata'</span> || <span class="php-var">$key</span> == <span class="php-quote">'meta'</span>) {
</span><span id="294" class="l"><a class="l" href="#294">294: </a>
</span><span id="295" class="l"><a class="l" href="#295">295: </a> <span class="php-comment">// Try retrieving existing value</span>
</span><span id="296" class="l"><a class="l" href="#296">296: </a> <span class="php-keyword1">if</span> (<span class="php-keyword1">null</span> === (<span class="php-var">$metadata</span> = <span class="php-var">$this</span>->getProperty(<span class="php-var">$key</span>))) {
</span><span id="297" class="l"><a class="l" href="#297">297: </a> <span class="php-comment">// If none exists, create new object</span>
</span><span id="298" class="l"><a class="l" href="#298">298: </a> <span class="php-var">$metadata</span> = <span class="php-keyword1">new</span> Metadata;
</span><span id="299" class="l"><a class="l" href="#299">299: </a> }
</span><span id="300" class="l"><a class="l" href="#300">300: </a>
</span><span id="301" class="l"><a class="l" href="#301">301: </a> <span class="php-comment">// Set values for metadata</span>
</span><span id="302" class="l"><a class="l" href="#302">302: </a> <span class="php-var">$metadata</span>->setArray(<span class="php-var">$value</span>);
</span><span id="303" class="l"><a class="l" href="#303">303: </a>
</span><span id="304" class="l"><a class="l" href="#304">304: </a> <span class="php-comment">// Set object property</span>
</span><span id="305" class="l"><a class="l" href="#305">305: </a> <span class="php-var">$this</span>->setProperty(<span class="php-var">$key</span>, <span class="php-var">$metadata</span>);
</span><span id="306" class="l"><a class="l" href="#306">306: </a> } <span class="php-keyword1">elseif</span> (!<span class="php-keyword1">empty</span>(<span class="php-var">$this</span>->associatedResources[<span class="php-var">$key</span>]) && <span class="php-var">$setObjects</span> === <span class="php-keyword1">true</span>) {
</span><span id="307" class="l"><a class="l" href="#307">307: </a>
</span><span id="308" class="l"><a class="l" href="#308">308: </a> <span class="php-comment">// Associated resource</span>
</span><span id="309" class="l"><a class="l" href="#309">309: </a> <span class="php-keyword1">try</span> {
</span><span id="310" class="l"><a class="l" href="#310">310: </a>
</span><span id="311" class="l"><a class="l" href="#311">311: </a> <span class="php-var">$resource</span> = <span class="php-var">$this</span>->getService()->resource(<span class="php-var">$this</span>->associatedResources[<span class="php-var">$key</span>], <span class="php-var">$value</span>);
</span><span id="312" class="l"><a class="l" href="#312">312: </a> <span class="php-var">$resource</span>->setParent(<span class="php-var">$this</span>);
</span><span id="313" class="l"><a class="l" href="#313">313: </a>
</span><span id="314" class="l"><a class="l" href="#314">314: </a> <span class="php-var">$this</span>->setProperty(<span class="php-var">$key</span>, <span class="php-var">$resource</span>);
</span><span id="315" class="l"><a class="l" href="#315">315: </a> } <span class="php-keyword1">catch</span> (Exception\ServiceException <span class="php-var">$e</span>) {
</span><span id="316" class="l"><a class="l" href="#316">316: </a> }
</span><span id="317" class="l"><a class="l" href="#317">317: </a> } <span class="php-keyword1">elseif</span> (!<span class="php-keyword1">empty</span>(<span class="php-var">$this</span>->associatedCollections[<span class="php-var">$key</span>]) && <span class="php-var">$setObjects</span> === <span class="php-keyword1">true</span>) {
</span><span id="318" class="l"><a class="l" href="#318">318: </a>
</span><span id="319" class="l"><a class="l" href="#319">319: </a> <span class="php-comment">// Associated collection</span>
</span><span id="320" class="l"><a class="l" href="#320">320: </a> <span class="php-keyword1">try</span> {
</span><span id="321" class="l"><a class="l" href="#321">321: </a>
</span><span id="322" class="l"><a class="l" href="#322">322: </a> <span class="php-var">$className</span> = <span class="php-var">$this</span>->associatedCollections[<span class="php-var">$key</span>];
</span><span id="323" class="l"><a class="l" href="#323">323: </a> <span class="php-var">$options</span> = <span class="php-var">$this</span>->makeResourceIteratorOptions(<span class="php-var">$className</span>);
</span><span id="324" class="l"><a class="l" href="#324">324: </a> <span class="php-var">$iterator</span> = ResourceIterator::factory(<span class="php-var">$this</span>, <span class="php-var">$options</span>, <span class="php-var">$value</span>);
</span><span id="325" class="l"><a class="l" href="#325">325: </a>
</span><span id="326" class="l"><a class="l" href="#326">326: </a> <span class="php-var">$this</span>->setProperty(<span class="php-var">$key</span>, <span class="php-var">$iterator</span>);
</span><span id="327" class="l"><a class="l" href="#327">327: </a> } <span class="php-keyword1">catch</span> (Exception\ServiceException <span class="php-var">$e</span>) {
</span><span id="328" class="l"><a class="l" href="#328">328: </a> }
</span><span id="329" class="l"><a class="l" href="#329">329: </a> } <span class="php-keyword1">elseif</span> (!<span class="php-keyword1">empty</span>(<span class="php-var">$this</span>->aliases[<span class="php-var">$key</span>])) {
</span><span id="330" class="l"><a class="l" href="#330">330: </a>
</span><span id="331" class="l"><a class="l" href="#331">331: </a> <span class="php-comment">// Sometimes we might want to preserve camelCase</span>
</span><span id="332" class="l"><a class="l" href="#332">332: </a> <span class="php-comment">// or covert `rax-bandwidth:bandwidth` to `raxBandwidth`</span>
</span><span id="333" class="l"><a class="l" href="#333">333: </a> <span class="php-var">$this</span>->setProperty(<span class="php-var">$this</span>->aliases[<span class="php-var">$key</span>], <span class="php-var">$value</span>);
</span><span id="334" class="l"><a class="l" href="#334">334: </a> } <span class="php-keyword1">else</span> {
</span><span id="335" class="l"><a class="l" href="#335">335: </a> <span class="php-comment">// Normal key/value pair</span>
</span><span id="336" class="l"><a class="l" href="#336">336: </a> <span class="php-var">$this</span>->setProperty(<span class="php-var">$key</span>, <span class="php-var">$value</span>);
</span><span id="337" class="l"><a class="l" href="#337">337: </a> }
</span><span id="338" class="l"><a class="l" href="#338">338: </a> }
</span><span id="339" class="l"><a class="l" href="#339">339: </a> } <span class="php-keyword1">elseif</span> (<span class="php-keyword1">null</span> !== <span class="php-var">$info</span>) {
</span><span id="340" class="l"><a class="l" href="#340">340: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Exceptions\InvalidArgumentError(<span class="php-keyword2">sprintf</span>(
</span><span id="341" class="l"><a class="l" href="#341">341: </a> Lang::translate(<span class="php-quote">'Argument for [%s] must be string or object'</span>),
</span><span id="342" class="l"><a class="l" href="#342">342: </a> <span class="php-keyword2">get_class</span>()
</span><span id="343" class="l"><a class="l" href="#343">343: </a> ));
</span><span id="344" class="l"><a class="l" href="#344">344: </a> }
</span><span id="345" class="l"><a class="l" href="#345">345: </a> }
</span><span id="346" class="l"><a class="l" href="#346">346: </a>
</span><span id="347" class="l"><a class="l" href="#347">347: </a> <span class="php-comment">/**
</span></span><span id="348" class="l"><a class="l" href="#348">348: </a><span class="php-comment"> * Checks the most recent JSON operation for errors.
</span></span><span id="349" class="l"><a class="l" href="#349">349: </a><span class="php-comment"> *
</span></span><span id="350" class="l"><a class="l" href="#350">350: </a><span class="php-comment"> * @throws Exceptions\JsonError
</span></span><span id="351" class="l"><a class="l" href="#351">351: </a><span class="php-comment"> * @codeCoverageIgnore
</span></span><span id="352" class="l"><a class="l" href="#352">352: </a><span class="php-comment"> */</span>
</span><span id="353" class="l"><a class="l" href="#353">353: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_checkJsonError" href="#_checkJsonError">checkJsonError</a>()
</span><span id="354" class="l"><a class="l" href="#354">354: </a> {
</span><span id="355" class="l"><a class="l" href="#355">355: </a> <span class="php-keyword1">switch</span> (<span class="php-keyword2">json_last_error</span>()) {
</span><span id="356" class="l"><a class="l" href="#356">356: </a> <span class="php-keyword1">case</span> JSON_ERROR_NONE:
</span><span id="357" class="l"><a class="l" href="#357">357: </a> <span class="php-keyword1">return</span>;
</span><span id="358" class="l"><a class="l" href="#358">358: </a> <span class="php-keyword1">case</span> JSON_ERROR_DEPTH:
</span><span id="359" class="l"><a class="l" href="#359">359: </a> <span class="php-var">$jsonError</span> = <span class="php-quote">'JSON error: The maximum stack depth has been exceeded'</span>;
</span><span id="360" class="l"><a class="l" href="#360">360: </a> <span class="php-keyword1">break</span>;
</span><span id="361" class="l"><a class="l" href="#361">361: </a> <span class="php-keyword1">case</span> JSON_ERROR_STATE_MISMATCH:
</span><span id="362" class="l"><a class="l" href="#362">362: </a> <span class="php-var">$jsonError</span> = <span class="php-quote">'JSON error: Invalid or malformed JSON'</span>;
</span><span id="363" class="l"><a class="l" href="#363">363: </a> <span class="php-keyword1">break</span>;
</span><span id="364" class="l"><a class="l" href="#364">364: </a> <span class="php-keyword1">case</span> JSON_ERROR_CTRL_CHAR:
</span><span id="365" class="l"><a class="l" href="#365">365: </a> <span class="php-var">$jsonError</span> = <span class="php-quote">'JSON error: Control character error, possibly incorrectly encoded'</span>;
</span><span id="366" class="l"><a class="l" href="#366">366: </a> <span class="php-keyword1">break</span>;
</span><span id="367" class="l"><a class="l" href="#367">367: </a> <span class="php-keyword1">case</span> JSON_ERROR_SYNTAX:
</span><span id="368" class="l"><a class="l" href="#368">368: </a> <span class="php-var">$jsonError</span> = <span class="php-quote">'JSON error: Syntax error'</span>;
</span><span id="369" class="l"><a class="l" href="#369">369: </a> <span class="php-keyword1">break</span>;
</span><span id="370" class="l"><a class="l" href="#370">370: </a> <span class="php-keyword1">case</span> JSON_ERROR_UTF8:
</span><span id="371" class="l"><a class="l" href="#371">371: </a> <span class="php-var">$jsonError</span> = <span class="php-quote">'JSON error: Malformed UTF-8 characters, possibly incorrectly encoded'</span>;
</span><span id="372" class="l"><a class="l" href="#372">372: </a> <span class="php-keyword1">break</span>;
</span><span id="373" class="l"><a class="l" href="#373">373: </a> <span class="php-keyword1">default</span>:
</span><span id="374" class="l"><a class="l" href="#374">374: </a> <span class="php-var">$jsonError</span> = <span class="php-quote">'Unexpected JSON error'</span>;
</span><span id="375" class="l"><a class="l" href="#375">375: </a> <span class="php-keyword1">break</span>;
</span><span id="376" class="l"><a class="l" href="#376">376: </a> }
</span><span id="377" class="l"><a class="l" href="#377">377: </a>
</span><span id="378" class="l"><a class="l" href="#378">378: </a> <span class="php-keyword1">if</span> (<span class="php-keyword1">isset</span>(<span class="php-var">$jsonError</span>)) {
</span><span id="379" class="l"><a class="l" href="#379">379: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> JsonError(Lang::translate(<span class="php-var">$jsonError</span>));
</span><span id="380" class="l"><a class="l" href="#380">380: </a> }
</span><span id="381" class="l"><a class="l" href="#381">381: </a> }
</span><span id="382" class="l"><a class="l" href="#382">382: </a>
</span><span id="383" class="l"><a class="l" href="#383">383: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_generateUuid" href="#_generateUuid">generateUuid</a>()
</span><span id="384" class="l"><a class="l" href="#384">384: </a> {
</span><span id="385" class="l"><a class="l" href="#385">385: </a> <span class="php-keyword1">return</span> <span class="php-keyword2">sprintf</span>(<span class="php-quote">'%04x%04x-%04x-%04x-%04x-%04x%04x%04x'</span>,
</span><span id="386" class="l"><a class="l" href="#386">386: </a> <span class="php-comment">// 32 bits for "time_low"</span>
</span><span id="387" class="l"><a class="l" href="#387">387: </a> <span class="php-keyword2">mt_rand</span>(<span class="php-num">0</span>, <span class="php-num">0xffff</span>), <span class="php-keyword2">mt_rand</span>(<span class="php-num">0</span>, <span class="php-num">0xffff</span>),
</span><span id="388" class="l"><a class="l" href="#388">388: </a>
</span><span id="389" class="l"><a class="l" href="#389">389: </a> <span class="php-comment">// 16 bits for "time_mid"</span>
</span><span id="390" class="l"><a class="l" href="#390">390: </a> <span class="php-keyword2">mt_rand</span>(<span class="php-num">0</span>, <span class="php-num">0xffff</span>),
</span><span id="391" class="l"><a class="l" href="#391">391: </a>
</span><span id="392" class="l"><a class="l" href="#392">392: </a> <span class="php-comment">// 16 bits for "time_hi_and_version",</span>
</span><span id="393" class="l"><a class="l" href="#393">393: </a> <span class="php-comment">// four most significant bits holds version number 4</span>
</span><span id="394" class="l"><a class="l" href="#394">394: </a> <span class="php-keyword2">mt_rand</span>(<span class="php-num">0</span>, <span class="php-num">0x0fff</span>) | <span class="php-num">0x4000</span>,
</span><span id="395" class="l"><a class="l" href="#395">395: </a>
</span><span id="396" class="l"><a class="l" href="#396">396: </a> <span class="php-comment">// 16 bits, 8 bits for "clk_seq_hi_res",</span>
</span><span id="397" class="l"><a class="l" href="#397">397: </a> <span class="php-comment">// 8 bits for "clk_seq_low",</span>
</span><span id="398" class="l"><a class="l" href="#398">398: </a> <span class="php-comment">// two most significant bits holds zero and one for variant DCE1.1</span>
</span><span id="399" class="l"><a class="l" href="#399">399: </a> <span class="php-keyword2">mt_rand</span>(<span class="php-num">0</span>, <span class="php-num">0x3fff</span>) | <span class="php-num">0x8000</span>,
</span><span id="400" class="l"><a class="l" href="#400">400: </a>
</span><span id="401" class="l"><a class="l" href="#401">401: </a> <span class="php-comment">// 48 bits for "node"</span>
</span><span id="402" class="l"><a class="l" href="#402">402: </a> <span class="php-keyword2">mt_rand</span>(<span class="php-num">0</span>, <span class="php-num">0xffff</span>), <span class="php-keyword2">mt_rand</span>(<span class="php-num">0</span>, <span class="php-num">0xffff</span>), <span class="php-keyword2">mt_rand</span>(<span class="php-num">0</span>, <span class="php-num">0xffff</span>)
</span><span id="403" class="l"><a class="l" href="#403">403: </a> );
</span><span id="404" class="l"><a class="l" href="#404">404: </a> }
</span><span id="405" class="l"><a class="l" href="#405">405: </a>
</span><span id="406" class="l"><a class="l" href="#406">406: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_makeResourceIteratorOptions" href="#_makeResourceIteratorOptions">makeResourceIteratorOptions</a>(<span class="php-var">$resource</span>)
</span><span id="407" class="l"><a class="l" href="#407">407: </a> {
</span><span id="408" class="l"><a class="l" href="#408">408: </a> <span class="php-var">$options</span> = <span class="php-keyword1">array</span>(<span class="php-quote">'resourceClass'</span> => <span class="php-var">$this</span>->stripNamespace(<span class="php-var">$resource</span>));
</span><span id="409" class="l"><a class="l" href="#409">409: </a>
</span><span id="410" class="l"><a class="l" href="#410">410: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">method_exists</span>(<span class="php-var">$resource</span>, <span class="php-quote">'jsonCollectionName'</span>)) {
</span><span id="411" class="l"><a class="l" href="#411">411: </a> <span class="php-var">$options</span>[<span class="php-quote">'key.collection'</span>] = <span class="php-var">$resource</span>::jsonCollectionName();
</span><span id="412" class="l"><a class="l" href="#412">412: </a> }
</span><span id="413" class="l"><a class="l" href="#413">413: </a>
</span><span id="414" class="l"><a class="l" href="#414">414: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">method_exists</span>(<span class="php-var">$resource</span>, <span class="php-quote">'jsonCollectionElement'</span>)) {
</span><span id="415" class="l"><a class="l" href="#415">415: </a> <span class="php-var">$options</span>[<span class="php-quote">'key.collectionElement'</span>] = <span class="php-var">$resource</span>::jsonCollectionElement();
</span><span id="416" class="l"><a class="l" href="#416">416: </a> }
</span><span id="417" class="l"><a class="l" href="#417">417: </a>
</span><span id="418" class="l"><a class="l" href="#418">418: </a> <span class="php-keyword1">return</span> <span class="php-var">$options</span>;
</span><span id="419" class="l"><a class="l" href="#419">419: </a> }
</span><span id="420" class="l"><a class="l" href="#420">420: </a>
</span><span id="421" class="l"><a class="l" href="#421">421: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_stripNamespace" href="#_stripNamespace">stripNamespace</a>(<span class="php-var">$namespace</span>)
</span><span id="422" class="l"><a class="l" href="#422">422: </a> {
</span><span id="423" class="l"><a class="l" href="#423">423: </a> <span class="php-var">$array</span> = <span class="php-keyword2">explode</span>(<span class="php-quote">'\\'</span>, <span class="php-var">$namespace</span>);
</span><span id="424" class="l"><a class="l" href="#424">424: </a>
</span><span id="425" class="l"><a class="l" href="#425">425: </a> <span class="php-keyword1">return</span> <span class="php-keyword2">end</span>(<span class="php-var">$array</span>);
</span><span id="426" class="l"><a class="l" href="#426">426: </a> }
</span><span id="427" class="l"><a class="l" href="#427">427: </a>
</span><span id="428" class="l"><a class="l" href="#428">428: </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">static</span> <span class="php-keyword1">function</span> <a id="_getJsonHeader" href="#_getJsonHeader">getJsonHeader</a>()
</span><span id="429" class="l"><a class="l" href="#429">429: </a> {
</span><span id="430" class="l"><a class="l" href="#430">430: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">array</span>(HeaderConst::CONTENT_TYPE => MimeConst::JSON);
</span><span id="431" class="l"><a class="l" href="#431">431: </a> }
</span><span id="432" class="l"><a class="l" href="#432">432: </a>}
</span><span id="433" class="l"><a class="l" href="#433">433: </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>
|