/usr/share/doc/php-opencloud/api/source-class-OpenCloud.Queues.Resource.Queue.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 | <!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/Queues/Resource/Queue.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><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 class="active"><a href="namespace-OpenCloud.Queues.html">Queues<span></span></a>
<ul>
<li><a href="namespace-OpenCloud.Queues.Exception.html">Exception</a>
</li>
<li class="active"><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.Queues.Resource.Claim.html">Claim</a></li>
<li><a href="class-OpenCloud.Queues.Resource.Message.html">Message</a></li>
<li class="active"><a href="class-OpenCloud.Queues.Resource.Queue.html">Queue</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.Queues.Resource.html" title="Summary of OpenCloud\Queues\Resource"><span>Namespace</span></a>
</li>
<li>
<a href="class-OpenCloud.Queues.Resource.Queue.html" title="Summary of OpenCloud\Queues\Resource\Queue"><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\Queues\Resource;
</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\Url;
</span><span id="21" class="l"><a class="l" href="#21"> 21: </a><span class="php-keyword1">use</span> OpenCloud\Common\Collection\PaginatedIterator;
</span><span id="22" class="l"><a class="l" href="#22"> 22: </a><span class="php-keyword1">use</span> OpenCloud\Common\Http\Message\Formatter;
</span><span id="23" class="l"><a class="l" href="#23"> 23: </a><span class="php-keyword1">use</span> OpenCloud\Common\Resource\PersistentResource;
</span><span id="24" class="l"><a class="l" href="#24"> 24: </a><span class="php-keyword1">use</span> OpenCloud\Queues\Exception;
</span><span id="25" class="l"><a class="l" href="#25"> 25: </a><span class="php-keyword1">use</span> OpenCloud\Common\Metadata;
</span><span id="26" class="l"><a class="l" href="#26"> 26: </a>
</span><span id="27" class="l"><a class="l" href="#27"> 27: </a><span class="php-comment">/**
</span></span><span id="28" class="l"><a class="l" href="#28"> 28: </a><span class="php-comment"> * A queue holds messages. Ideally, a queue is created per work type. For example,
</span></span><span id="29" class="l"><a class="l" href="#29"> 29: </a><span class="php-comment"> * if you want to compress files, you would create a queue dedicated to this job.
</span></span><span id="30" class="l"><a class="l" href="#30"> 30: </a><span class="php-comment"> * Any application that reads from this queue would only compress files.
</span></span><span id="31" class="l"><a class="l" href="#31"> 31: </a><span class="php-comment"> */</span>
</span><span id="32" class="l"><a class="l" href="#32"> 32: </a><span class="php-keyword1">class</span> <a id="Queue" href="#Queue">Queue</a> <span class="php-keyword1">extends</span> PersistentResource
</span><span id="33" class="l"><a class="l" href="#33"> 33: </a>{
</span><span id="34" class="l"><a class="l" href="#34"> 34: </a> <span class="php-comment">/**
</span></span><span id="35" class="l"><a class="l" href="#35"> 35: </a><span class="php-comment"> * Maximum number of messages that can be posted at once.
</span></span><span id="36" class="l"><a class="l" href="#36"> 36: </a><span class="php-comment"> */</span>
</span><span id="37" class="l"><a class="l" href="#37"> 37: </a> <span class="php-keyword1">const</span> <a id="MAX_POST_MESSAGES" href="#MAX_POST_MESSAGES">MAX_POST_MESSAGES</a> = <span class="php-num">10</span>;
</span><span id="38" class="l"><a class="l" href="#38"> 38: </a>
</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-comment"> * The name given to the queue. The name MUST NOT exceed 64 bytes in length,
</span></span><span id="41" class="l"><a class="l" href="#41"> 41: </a><span class="php-comment"> * and is limited to US-ASCII letters, digits, underscores, and hyphens.
</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-comment"> * @var string
</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-keyword1">private</span> <span class="php-var"><a id="$name" href="#$name">$name</a></span>;
</span><span id="46" class="l"><a class="l" href="#46"> 46: </a>
</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-comment"> * Miscellaneous, user-defined information about the queue.
</span></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"> * @var array|Metadata
</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-keyword1">protected</span> <span class="php-var"><a id="$metadata" href="#$metadata">$metadata</a></span>;
</span><span id="53" class="l"><a class="l" href="#53"> 53: </a>
</span><span id="54" class="l"><a class="l" href="#54"> 54: </a> <span class="php-comment">/**
</span></span><span id="55" class="l"><a class="l" href="#55"> 55: </a><span class="php-comment"> * Populated when the service's listQueues() method is called. Provides a
</span></span><span id="56" class="l"><a class="l" href="#56"> 56: </a><span class="php-comment"> * convenient link for a particular Queue.md.
</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-comment"> * @var string
</span></span><span id="59" class="l"><a class="l" href="#59"> 59: </a><span class="php-comment"> */</span>
</span><span id="60" class="l"><a class="l" href="#60"> 60: </a> <span class="php-keyword1">private</span> <span class="php-var"><a id="$href" href="#$href">$href</a></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 class="php-keyword1">protected</span> <span class="php-keyword1">static</span> <span class="php-var"><a id="$url_resource" href="#$url_resource">$url_resource</a></span> = <span class="php-quote">'queues'</span>;
</span><span id="63" class="l"><a class="l" href="#63"> 63: </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">static</span> <span class="php-var"><a id="$json_collection_name" href="#$json_collection_name">$json_collection_name</a></span> = <span class="php-quote">'queues'</span>;
</span><span id="64" class="l"><a class="l" href="#64"> 64: </a> <span class="php-keyword1">protected</span> <span class="php-keyword1">static</span> <span class="php-var"><a id="$json_name" href="#$json_name">$json_name</a></span> = <span class="php-keyword1">false</span>;
</span><span id="65" class="l"><a class="l" href="#65"> 65: </a>
</span><span id="66" class="l"><a class="l" href="#66"> 66: </a> <span class="php-keyword1">public</span> <span class="php-var"><a id="$createKeys" href="#$createKeys">$createKeys</a></span> = <span class="php-keyword1">array</span>(<span class="php-quote">'name'</span>);
</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-comment">/**
</span></span><span id="69" class="l"><a class="l" href="#69"> 69: </a><span class="php-comment"> * Set the name (with validation).
</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-comment"> * @param $name string
</span></span><span id="72" class="l"><a class="l" href="#72"> 72: </a><span class="php-comment"> * @return $this
</span></span><span id="73" class="l"><a class="l" href="#73"> 73: </a><span class="php-comment"> * @throws \OpenCloud\Queues\Exception\QueueException
</span></span><span id="74" class="l"><a class="l" href="#74"> 74: </a><span class="php-comment"> */</span>
</span><span id="75" class="l"><a class="l" href="#75"> 75: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_setName" href="#_setName">setName</a>(<span class="php-var">$name</span>)
</span><span id="76" class="l"><a class="l" href="#76"> 76: </a> {
</span><span id="77" class="l"><a class="l" href="#77"> 77: </a> <span class="php-keyword1">if</span> (<span class="php-keyword2">preg_match</span>(<span class="php-quote">'#[^\w\d\-\_]+#'</span>, <span class="php-var">$name</span>)) {
</span><span id="78" class="l"><a class="l" href="#78"> 78: </a> <span class="php-keyword1">throw</span> <span class="php-keyword1">new</span> Exception\QueueException(<span class="php-keyword2">sprintf</span>(
</span><span id="79" class="l"><a class="l" href="#79"> 79: </a> <span class="php-quote">'Queues names are restricted to alphanumeric characters, '</span>
</span><span id="80" class="l"><a class="l" href="#80"> 80: </a> . <span class="php-quote">' hyphens and underscores. You provided: %s'</span>,
</span><span id="81" class="l"><a class="l" href="#81"> 81: </a> <span class="php-keyword2">print_r</span>(<span class="php-var">$name</span>, <span class="php-keyword1">true</span>)
</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><span id="84" class="l"><a class="l" href="#84"> 84: </a>
</span><span id="85" class="l"><a class="l" href="#85"> 85: </a> <span class="php-var">$this</span>->name = <span class="php-var">$name</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 class="php-keyword1">return</span> <span class="php-var">$this</span>;
</span><span id="88" class="l"><a class="l" href="#88"> 88: </a> }
</span><span id="89" class="l"><a class="l" href="#89"> 89: </a>
</span><span id="90" class="l"><a class="l" href="#90"> 90: </a> <span class="php-comment">/**
</span></span><span id="91" class="l"><a class="l" href="#91"> 91: </a><span class="php-comment"> * @return string
</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="_getName" href="#_getName">getName</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>->name;
</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"> * Save this metadata both to the local object and the API.
</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"> * @param array $params
</span></span><span id="102" class="l"><a class="l" href="#102">102: </a><span class="php-comment"> * @return mixed
</span></span><span id="103" class="l"><a class="l" href="#103">103: </a><span class="php-comment"> */</span>
</span><span id="104" class="l"><a class="l" href="#104">104: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_saveMetadata" href="#_saveMetadata">saveMetadata</a>(<span class="php-keyword1">array</span> <span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="105" class="l"><a class="l" href="#105">105: </a> {
</span><span id="106" class="l"><a class="l" href="#106">106: </a> <span class="php-keyword1">if</span> (!<span class="php-keyword1">empty</span>(<span class="php-var">$params</span>)) {
</span><span id="107" class="l"><a class="l" href="#107">107: </a> <span class="php-var">$this</span>->setMetadata(<span class="php-var">$params</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-var">$json</span> = <span class="php-keyword2">json_encode</span>((object) <span class="php-var">$this</span>->getMetadata()->toArray());
</span><span id="111" class="l"><a class="l" href="#111">111: </a>
</span><span id="112" class="l"><a class="l" href="#112">112: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->getClient()->put(<span class="php-var">$this</span>->getUrl(<span class="php-quote">'metadata'</span>), self::getJsonHeader(), <span class="php-var">$json</span>)->send();
</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><span id="115" class="l"><a class="l" href="#115">115: </a> <span class="php-comment">/**
</span></span><span id="116" class="l"><a class="l" href="#116">116: </a><span class="php-comment"> * Retrieve metadata from the API and set it to the local object.
</span></span><span id="117" class="l"><a class="l" href="#117">117: </a><span class="php-comment"> */</span>
</span><span id="118" class="l"><a class="l" href="#118">118: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_retrieveMetadata" href="#_retrieveMetadata">retrieveMetadata</a>()
</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 class="php-var">$response</span> = <span class="php-var">$this</span>->getClient()->get(<span class="php-var">$this</span>->url(<span class="php-quote">'metadata'</span>))->send();
</span><span id="121" class="l"><a class="l" href="#121">121: </a>
</span><span id="122" class="l"><a class="l" href="#122">122: </a> <span class="php-var">$metadata</span> = <span class="php-keyword1">new</span> Metadata();
</span><span id="123" class="l"><a class="l" href="#123">123: </a> <span class="php-var">$metadata</span>->setArray(Formatter::decode(<span class="php-var">$response</span>));
</span><span id="124" class="l"><a class="l" href="#124">124: </a> <span class="php-var">$this</span>->setMetadata(<span class="php-var">$metadata</span>);
</span><span id="125" class="l"><a class="l" href="#125">125: </a> }
</span><span id="126" class="l"><a class="l" href="#126">126: </a>
</span><span id="127" class="l"><a class="l" href="#127">127: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_create" href="#_create">create</a>(<span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</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 class="php-keyword1">return</span> <span class="php-var">$this</span>->getService()->createQueue(<span class="php-var">$params</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 class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_createJson" href="#_createJson">createJson</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-keyword1">return</span> (object) <span class="php-keyword1">array</span>(
</span><span id="135" class="l"><a class="l" href="#135">135: </a> <span class="php-quote">'queue_name'</span> => <span class="php-var">$this</span>->getName(),
</span><span id="136" class="l"><a class="l" href="#136">136: </a> <span class="php-quote">'metadata'</span> => <span class="php-var">$this</span>->getMetadata(<span class="php-keyword1">false</span>)
</span><span id="137" class="l"><a class="l" href="#137">137: </a> );
</span><span id="138" class="l"><a class="l" href="#138">138: </a> }
</span><span id="139" class="l"><a class="l" href="#139">139: </a>
</span><span id="140" class="l"><a class="l" href="#140">140: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_primaryKeyField" href="#_primaryKeyField">primaryKeyField</a>()
</span><span id="141" class="l"><a class="l" href="#141">141: </a> {
</span><span id="142" class="l"><a class="l" href="#142">142: </a> <span class="php-keyword1">return</span> <span class="php-quote">'name'</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><span id="145" class="l"><a class="l" href="#145">145: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_update" href="#_update">update</a>(<span class="php-var">$params</span> = <span class="php-keyword1">array</span>())
</span><span id="146" class="l"><a class="l" href="#146">146: </a> {
</span><span id="147" class="l"><a class="l" href="#147">147: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->noUpdate();
</span><span id="148" class="l"><a class="l" href="#148">148: </a> }
</span><span id="149" class="l"><a class="l" href="#149">149: </a>
</span><span id="150" class="l"><a class="l" href="#150">150: </a> <span class="php-comment">/**
</span></span><span id="151" class="l"><a class="l" href="#151">151: </a><span class="php-comment"> * This operation returns queue statistics including how many messages are
</span></span><span id="152" class="l"><a class="l" href="#152">152: </a><span class="php-comment"> * in the queue, broken out by status.
</span></span><span id="153" class="l"><a class="l" href="#153">153: </a><span class="php-comment"> *
</span></span><span id="154" class="l"><a class="l" href="#154">154: </a><span class="php-comment"> * @return object
</span></span><span id="155" class="l"><a class="l" href="#155">155: </a><span class="php-comment"> */</span>
</span><span id="156" class="l"><a class="l" href="#156">156: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getStats" href="#_getStats">getStats</a>()
</span><span id="157" class="l"><a class="l" href="#157">157: </a> {
</span><span id="158" class="l"><a class="l" href="#158">158: </a> <span class="php-var">$response</span> = <span class="php-var">$this</span>->getClient()
</span><span id="159" class="l"><a class="l" href="#159">159: </a> ->get(<span class="php-var">$this</span>->getUrl(<span class="php-quote">'stats'</span>))
</span><span id="160" class="l"><a class="l" href="#160">160: </a> ->send();
</span><span id="161" class="l"><a class="l" href="#161">161: </a>
</span><span id="162" class="l"><a class="l" href="#162">162: </a> <span class="php-var">$body</span> = Formatter::decode(<span class="php-var">$response</span>);
</span><span id="163" class="l"><a class="l" href="#163">163: </a>
</span><span id="164" class="l"><a class="l" href="#164">164: </a> <span class="php-keyword1">return</span> (!<span class="php-keyword1">isset</span>(<span class="php-var">$body</span>->messages)) ? <span class="php-keyword1">false</span> : <span class="php-var">$body</span>->messages;
</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><span id="167" class="l"><a class="l" href="#167">167: </a> <span class="php-comment">/**
</span></span><span id="168" class="l"><a class="l" href="#168">168: </a><span class="php-comment"> * Gets a message either by a specific ID, or, if no ID is specified, just
</span></span><span id="169" class="l"><a class="l" href="#169">169: </a><span class="php-comment"> * an empty Message object.
</span></span><span id="170" class="l"><a class="l" href="#170">170: </a><span class="php-comment"> *
</span></span><span id="171" class="l"><a class="l" href="#171">171: </a><span class="php-comment"> * @param string|null $id If a string, then the service will retrieve an
</span></span><span id="172" class="l"><a class="l" href="#172">172: </a><span class="php-comment"> * individual message based on its specific ID. If NULL, then an empty
</span></span><span id="173" class="l"><a class="l" href="#173">173: </a><span class="php-comment"> * object is returned for further use.
</span></span><span id="174" class="l"><a class="l" href="#174">174: </a><span class="php-comment"> * @return Message
</span></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-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getMessage" href="#_getMessage">getMessage</a>(<span class="php-var">$id</span> = <span class="php-keyword1">null</span>)
</span><span id="177" class="l"><a class="l" href="#177">177: </a> {
</span><span id="178" class="l"><a class="l" href="#178">178: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->getService()->resource(<span class="php-quote">'Message'</span>, <span class="php-var">$id</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-comment">/**
</span></span><span id="182" class="l"><a class="l" href="#182">182: </a><span class="php-comment"> * Post an individual message.
</span></span><span id="183" class="l"><a class="l" href="#183">183: </a><span class="php-comment"> *
</span></span><span id="184" class="l"><a class="l" href="#184">184: </a><span class="php-comment"> * @param array $params
</span></span><span id="185" class="l"><a class="l" href="#185">185: </a><span class="php-comment"> * @return bool
</span></span><span id="186" class="l"><a class="l" href="#186">186: </a><span class="php-comment"> */</span>
</span><span id="187" class="l"><a class="l" href="#187">187: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_createMessage" href="#_createMessage">createMessage</a>(<span class="php-keyword1">array</span> <span class="php-var">$params</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> <span class="php-var">$this</span>->createMessages(<span class="php-keyword1">array</span>(<span class="php-var">$params</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"> * Post multiple messages.
</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-comment"> * @param array $messages
</span></span><span id="196" class="l"><a class="l" href="#196">196: </a><span class="php-comment"> * @return bool
</span></span><span id="197" class="l"><a class="l" href="#197">197: </a><span class="php-comment"> */</span>
</span><span id="198" class="l"><a class="l" href="#198">198: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_createMessages" href="#_createMessages">createMessages</a>(<span class="php-keyword1">array</span> <span class="php-var">$messages</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 class="php-var">$objects</span> = <span class="php-keyword1">array</span>();
</span><span id="201" class="l"><a class="l" href="#201">201: </a>
</span><span id="202" class="l"><a class="l" href="#202">202: </a> <span class="php-keyword1">foreach</span> (<span class="php-var">$messages</span> <span class="php-keyword1">as</span> <span class="php-var">$dataArray</span>) {
</span><span id="203" class="l"><a class="l" href="#203">203: </a> <span class="php-var">$objects</span>[] = <span class="php-var">$this</span>->getMessage(<span class="php-var">$dataArray</span>)->createJson();
</span><span id="204" class="l"><a class="l" href="#204">204: </a> }
</span><span id="205" class="l"><a class="l" href="#205">205: </a>
</span><span id="206" class="l"><a class="l" href="#206">206: </a> <span class="php-var">$json</span> = <span class="php-keyword2">json_encode</span>(<span class="php-keyword2">array_slice</span>(<span class="php-var">$objects</span>, <span class="php-num">0</span>, self::MAX_POST_MESSAGES));
</span><span id="207" class="l"><a class="l" href="#207">207: </a> <span class="php-var">$this</span>->checkJsonError();
</span><span id="208" class="l"><a class="l" href="#208">208: </a>
</span><span id="209" class="l"><a class="l" href="#209">209: </a> <span class="php-var">$response</span> = <span class="php-var">$this</span>->getClient()
</span><span id="210" class="l"><a class="l" href="#210">210: </a> ->post(<span class="php-var">$this</span>->getUrl(<span class="php-quote">'messages'</span>), self::getJsonHeader(), <span class="php-var">$json</span>)
</span><span id="211" class="l"><a class="l" href="#211">211: </a> ->send();
</span><span id="212" class="l"><a class="l" href="#212">212: </a>
</span><span id="213" class="l"><a class="l" href="#213">213: </a> <span class="php-keyword1">if</span> (<span class="php-keyword1">null</span> !== (<span class="php-var">$location</span> = <span class="php-var">$response</span>->getHeader(<span class="php-quote">'Location'</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">$parts</span> = <span class="php-keyword2">array_merge</span>(<span class="php-var">$this</span>->getUrl()->getParts(), <span class="php-keyword2">parse_url</span>(<span class="php-var">$location</span>));
</span><span id="216" class="l"><a class="l" href="#216">216: </a> <span class="php-var">$url</span> = Url::factory(Url::buildUrl(<span class="php-var">$parts</span>));
</span><span id="217" class="l"><a class="l" href="#217">217: </a>
</span><span id="218" class="l"><a class="l" href="#218">218: </a> <span class="php-var">$options</span> = <span class="php-var">$this</span>->makeResourceIteratorOptions(__NAMESPACE__ . <span class="php-quote">'\\Message'</span>) + <span class="php-keyword1">array</span>(
</span><span id="219" class="l"><a class="l" href="#219">219: </a> <span class="php-quote">'baseUrl'</span> => <span class="php-var">$url</span>,
</span><span id="220" class="l"><a class="l" href="#220">220: </a> <span class="php-quote">'limit.page'</span> => <span class="php-num">10</span>
</span><span id="221" class="l"><a class="l" href="#221">221: </a> );
</span><span id="222" class="l"><a class="l" href="#222">222: </a>
</span><span id="223" class="l"><a class="l" href="#223">223: </a> <span class="php-keyword1">return</span> PaginatedIterator::factory(<span class="php-var">$this</span>, <span class="php-var">$options</span>);
</span><span id="224" class="l"><a class="l" href="#224">224: </a> }
</span><span id="225" class="l"><a class="l" href="#225">225: </a>
</span><span id="226" class="l"><a class="l" href="#226">226: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">true</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><span id="229" class="l"><a class="l" href="#229">229: </a> <span class="php-comment">/**
</span></span><span id="230" class="l"><a class="l" href="#230">230: </a><span class="php-comment"> * Lists messages according to certain filter options. Results are ordered
</span></span><span id="231" class="l"><a class="l" href="#231">231: </a><span class="php-comment"> * by age, oldest message first. All of the parameters are optional.
</span></span><span id="232" class="l"><a class="l" href="#232">232: </a><span class="php-comment"> *
</span></span><span id="233" class="l"><a class="l" href="#233">233: </a><span class="php-comment"> * @param array $options An associative array of filtering parameters:
</span></span><span id="234" class="l"><a class="l" href="#234">234: </a><span class="php-comment"> *
</span></span><span id="235" class="l"><a class="l" href="#235">235: </a><span class="php-comment"> * - ids (array) A two-dimensional array of IDs to retrieve.
</span></span><span id="236" class="l"><a class="l" href="#236">236: </a><span class="php-comment"> *
</span></span><span id="237" class="l"><a class="l" href="#237">237: </a><span class="php-comment"> * - claim_id (string) The claim ID to which the message is associated.
</span></span><span id="238" class="l"><a class="l" href="#238">238: </a><span class="php-comment"> *
</span></span><span id="239" class="l"><a class="l" href="#239">239: </a><span class="php-comment"> * - marker (string) An opaque string that the client can use to request the
</span></span><span id="240" class="l"><a class="l" href="#240">240: </a><span class="php-comment"> * next batch of messages. If not specified, the API will return all
</span></span><span id="241" class="l"><a class="l" href="#241">241: </a><span class="php-comment"> * messages at the head of the queue (up to limit).
</span></span><span id="242" class="l"><a class="l" href="#242">242: </a><span class="php-comment"> *
</span></span><span id="243" class="l"><a class="l" href="#243">243: </a><span class="php-comment"> * - limit (integer) A number up to 20 (the default, but is configurable)
</span></span><span id="244" class="l"><a class="l" href="#244">244: </a><span class="php-comment"> * queues to return. If not specified, it defaults to 10.
</span></span><span id="245" class="l"><a class="l" href="#245">245: </a><span class="php-comment"> *
</span></span><span id="246" class="l"><a class="l" href="#246">246: </a><span class="php-comment"> * - echo (bool) Determines whether the API returns a client's own messages,
</span></span><span id="247" class="l"><a class="l" href="#247">247: </a><span class="php-comment"> * as determined by the uuid portion of the User-Agent header. If not
</span></span><span id="248" class="l"><a class="l" href="#248">248: </a><span class="php-comment"> * specified, echo defaults to FALSE.
</span></span><span id="249" class="l"><a class="l" href="#249">249: </a><span class="php-comment"> *
</span></span><span id="250" class="l"><a class="l" href="#250">250: </a><span class="php-comment"> * - include_claimed (bool) Determines whether the API returns claimed
</span></span><span id="251" class="l"><a class="l" href="#251">251: </a><span class="php-comment"> * messages as well as unclaimed messages. If not specified, defaults
</span></span><span id="252" class="l"><a class="l" href="#252">252: </a><span class="php-comment"> * to FALSE (i.e. only unclaimed messages are returned).
</span></span><span id="253" class="l"><a class="l" href="#253">253: </a><span class="php-comment"> *
</span></span><span id="254" class="l"><a class="l" href="#254">254: </a><span class="php-comment"> * @return Collection
</span></span><span id="255" class="l"><a class="l" href="#255">255: </a><span class="php-comment"> */</span>
</span><span id="256" class="l"><a class="l" href="#256">256: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_listMessages" href="#_listMessages">listMessages</a>(<span class="php-keyword1">array</span> <span class="php-var">$options</span> = <span class="php-keyword1">array</span>())
</span><span id="257" class="l"><a class="l" href="#257">257: </a> {
</span><span id="258" class="l"><a class="l" href="#258">258: </a> <span class="php-comment">// Implode array into delimeted string if necessary</span>
</span><span id="259" class="l"><a class="l" href="#259">259: </a> <span class="php-keyword1">if</span> (<span class="php-keyword1">isset</span>(<span class="php-var">$options</span>[<span class="php-quote">'ids'</span>]) && <span class="php-keyword2">is_array</span>(<span class="php-var">$options</span>[<span class="php-quote">'ids'</span>])) {
</span><span id="260" class="l"><a class="l" href="#260">260: </a> <span class="php-var">$options</span>[<span class="php-quote">'ids'</span>] = <span class="php-keyword2">implode</span>(<span class="php-quote">','</span>, <span class="php-var">$options</span>[<span class="php-quote">'ids'</span>]);
</span><span id="261" class="l"><a class="l" href="#261">261: </a> }
</span><span id="262" class="l"><a class="l" href="#262">262: </a>
</span><span id="263" class="l"><a class="l" href="#263">263: </a> <span class="php-comment">// PHP will cast boolean values to integers (true => 1, false => 0) but</span>
</span><span id="264" class="l"><a class="l" href="#264">264: </a> <span class="php-comment">// the Queues REST API expects strings as query parameters ("true" and "false").</span>
</span><span id="265" class="l"><a class="l" href="#265">265: </a> <span class="php-keyword1">foreach</span> (<span class="php-var">$options</span> <span class="php-keyword1">as</span> <span class="php-var">$optionKey</span> => <span class="php-var">$optionValue</span>) {
</span><span id="266" class="l"><a class="l" href="#266">266: </a> <span class="php-keyword1">if</span> (<span class="php-keyword1">true</span> === <span class="php-var">$optionValue</span>) {
</span><span id="267" class="l"><a class="l" href="#267">267: </a> <span class="php-var">$options</span>[<span class="php-var">$optionKey</span>] = <span class="php-quote">"true"</span>;
</span><span id="268" class="l"><a class="l" href="#268">268: </a> } <span class="php-keyword1">elseif</span> (<span class="php-keyword1">false</span> === <span class="php-var">$optionValue</span>) {
</span><span id="269" class="l"><a class="l" href="#269">269: </a> <span class="php-var">$options</span>[<span class="php-var">$optionKey</span>] = <span class="php-quote">"false"</span>;
</span><span id="270" class="l"><a class="l" href="#270">270: </a> }
</span><span id="271" class="l"><a class="l" href="#271">271: </a> }
</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-var">$url</span> = <span class="php-var">$this</span>->getUrl(<span class="php-quote">'messages'</span>, <span class="php-var">$options</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 class="php-var">$options</span> = <span class="php-var">$this</span>->makeResourceIteratorOptions(__NAMESPACE__ . <span class="php-quote">'\\Message'</span>) + <span class="php-keyword1">array</span>(
</span><span id="276" class="l"><a class="l" href="#276">276: </a> <span class="php-quote">'baseUrl'</span> => <span class="php-var">$url</span>,
</span><span id="277" class="l"><a class="l" href="#277">277: </a> <span class="php-quote">'limit.page'</span> => <span class="php-num">10</span>
</span><span id="278" class="l"><a class="l" href="#278">278: </a> );
</span><span id="279" class="l"><a class="l" href="#279">279: </a>
</span><span id="280" class="l"><a class="l" href="#280">280: </a> <span class="php-keyword1">return</span> PaginatedIterator::factory(<span class="php-var">$this</span>, <span class="php-var">$options</span>);
</span><span id="281" class="l"><a class="l" href="#281">281: </a> }
</span><span id="282" class="l"><a class="l" href="#282">282: </a>
</span><span id="283" class="l"><a class="l" href="#283">283: </a> <span class="php-comment">/**
</span></span><span id="284" class="l"><a class="l" href="#284">284: </a><span class="php-comment"> * This operation immediately deletes the specified messages, providing a
</span></span><span id="285" class="l"><a class="l" href="#285">285: </a><span class="php-comment"> * means for bulk deletes.
</span></span><span id="286" class="l"><a class="l" href="#286">286: </a><span class="php-comment"> *
</span></span><span id="287" class="l"><a class="l" href="#287">287: </a><span class="php-comment"> * @param array $ids Two-dimensional array of IDs to be deleted
</span></span><span id="288" class="l"><a class="l" href="#288">288: </a><span class="php-comment"> * @return boolean
</span></span><span id="289" class="l"><a class="l" href="#289">289: </a><span class="php-comment"> */</span>
</span><span id="290" class="l"><a class="l" href="#290">290: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_deleteMessages" href="#_deleteMessages">deleteMessages</a>(<span class="php-keyword1">array</span> <span class="php-var">$ids</span>)
</span><span id="291" class="l"><a class="l" href="#291">291: </a> {
</span><span id="292" class="l"><a class="l" href="#292">292: </a> <span class="php-var">$url</span> = <span class="php-var">$this</span>->url(<span class="php-quote">'messages'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'ids'</span> => <span class="php-keyword2">implode</span>(<span class="php-quote">','</span>, <span class="php-var">$ids</span>)));
</span><span id="293" class="l"><a class="l" href="#293">293: </a> <span class="php-var">$this</span>->getClient()-><span class="php-keyword2">delete</span>(<span class="php-var">$url</span>)->send();
</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-keyword1">return</span> <span class="php-keyword1">true</span>;
</span><span id="296" class="l"><a class="l" href="#296">296: </a> }
</span><span id="297" class="l"><a class="l" href="#297">297: </a>
</span><span id="298" class="l"><a class="l" href="#298">298: </a> <span class="php-comment">/**
</span></span><span id="299" class="l"><a class="l" href="#299">299: </a><span class="php-comment"> * This operation claims a set of messages, up to limit, from oldest to
</span></span><span id="300" class="l"><a class="l" href="#300">300: </a><span class="php-comment"> * newest, skipping any that are already claimed. If no unclaimed messages
</span></span><span id="301" class="l"><a class="l" href="#301">301: </a><span class="php-comment"> * are available, FALSE is returned.
</span></span><span id="302" class="l"><a class="l" href="#302">302: </a><span class="php-comment"> *
</span></span><span id="303" class="l"><a class="l" href="#303">303: </a><span class="php-comment"> * You should delete the message when you have finished processing it,
</span></span><span id="304" class="l"><a class="l" href="#304">304: </a><span class="php-comment"> * before the claim expires, to ensure the message is processed only once.
</span></span><span id="305" class="l"><a class="l" href="#305">305: </a><span class="php-comment"> * Be aware that you must call the delete() method on the Message object and
</span></span><span id="306" class="l"><a class="l" href="#306">306: </a><span class="php-comment"> * pass in the Claim ID, rather than relying on the service's bulk delete
</span></span><span id="307" class="l"><a class="l" href="#307">307: </a><span class="php-comment"> * deleteMessages() method. This is so that the server can return an error
</span></span><span id="308" class="l"><a class="l" href="#308">308: </a><span class="php-comment"> * if the claim just expired, giving you a chance to roll back your processing
</span></span><span id="309" class="l"><a class="l" href="#309">309: </a><span class="php-comment"> * of the given message, since another worker will likely claim the message
</span></span><span id="310" class="l"><a class="l" href="#310">310: </a><span class="php-comment"> * and process it.
</span></span><span id="311" class="l"><a class="l" href="#311">311: </a><span class="php-comment"> *
</span></span><span id="312" class="l"><a class="l" href="#312">312: </a><span class="php-comment"> * Just as with a message's age, the age given for the claim is relative to
</span></span><span id="313" class="l"><a class="l" href="#313">313: </a><span class="php-comment"> * the server's clock, and is useful for determining how quickly messages are
</span></span><span id="314" class="l"><a class="l" href="#314">314: </a><span class="php-comment"> * getting processed, and whether a given message's claim is about to expire.
</span></span><span id="315" class="l"><a class="l" href="#315">315: </a><span class="php-comment"> *
</span></span><span id="316" class="l"><a class="l" href="#316">316: </a><span class="php-comment"> * When a claim expires, it is removed, allowing another client worker to
</span></span><span id="317" class="l"><a class="l" href="#317">317: </a><span class="php-comment"> * claim the message in the case that the original worker fails to process it.
</span></span><span id="318" class="l"><a class="l" href="#318">318: </a><span class="php-comment"> *
</span></span><span id="319" class="l"><a class="l" href="#319">319: </a><span class="php-comment"> * @param int $limit
</span></span><span id="320" class="l"><a class="l" href="#320">320: </a><span class="php-comment"> */</span>
</span><span id="321" class="l"><a class="l" href="#321">321: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_claimMessages" href="#_claimMessages">claimMessages</a>(<span class="php-keyword1">array</span> <span class="php-var">$options</span> = <span class="php-keyword1">array</span>())
</span><span id="322" class="l"><a class="l" href="#322">322: </a> {
</span><span id="323" class="l"><a class="l" href="#323">323: </a> <span class="php-var">$limit</span> = (<span class="php-keyword1">isset</span>(<span class="php-var">$options</span>[<span class="php-quote">'limit'</span>])) ? <span class="php-var">$options</span>[<span class="php-quote">'limit'</span>] : Claim::LIMIT_DEFAULT;
</span><span id="324" class="l"><a class="l" href="#324">324: </a> <span class="php-var">$grace</span> = (<span class="php-keyword1">isset</span>(<span class="php-var">$options</span>[<span class="php-quote">'grace'</span>])) ? <span class="php-var">$options</span>[<span class="php-quote">'grace'</span>] : Claim::GRACE_DEFAULT;
</span><span id="325" class="l"><a class="l" href="#325">325: </a> <span class="php-var">$ttl</span> = (<span class="php-keyword1">isset</span>(<span class="php-var">$options</span>[<span class="php-quote">'ttl'</span>])) ? <span class="php-var">$options</span>[<span class="php-quote">'ttl'</span>] : Claim::TTL_DEFAULT;
</span><span id="326" class="l"><a class="l" href="#326">326: </a>
</span><span id="327" class="l"><a class="l" href="#327">327: </a> <span class="php-var">$json</span> = <span class="php-keyword2">json_encode</span>((object) <span class="php-keyword1">array</span>(
</span><span id="328" class="l"><a class="l" href="#328">328: </a> <span class="php-quote">'grace'</span> => <span class="php-var">$grace</span>,
</span><span id="329" class="l"><a class="l" href="#329">329: </a> <span class="php-quote">'ttl'</span> => <span class="php-var">$ttl</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><span id="332" class="l"><a class="l" href="#332">332: </a> <span class="php-var">$url</span> = <span class="php-var">$this</span>->getUrl(<span class="php-quote">'claims'</span>, <span class="php-keyword1">array</span>(<span class="php-quote">'limit'</span> => <span class="php-var">$limit</span>));
</span><span id="333" class="l"><a class="l" href="#333">333: </a>
</span><span id="334" class="l"><a class="l" href="#334">334: </a> <span class="php-var">$response</span> = <span class="php-var">$this</span>->getClient()->post(<span class="php-var">$url</span>, self::getJsonHeader(), <span class="php-var">$json</span>)->send();
</span><span id="335" class="l"><a class="l" href="#335">335: </a>
</span><span id="336" class="l"><a class="l" href="#336">336: </a> <span class="php-keyword1">if</span> (<span class="php-var">$response</span>->getStatusCode() == <span class="php-num">204</span>) {
</span><span id="337" class="l"><a class="l" href="#337">337: </a> <span class="php-keyword1">return</span> <span class="php-keyword1">false</span>;
</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><span id="340" class="l"><a class="l" href="#340">340: </a> <span class="php-var">$options</span> = <span class="php-keyword1">array</span>(<span class="php-quote">'resourceClass'</span> => <span class="php-quote">'Message'</span>, <span class="php-quote">'baseUrl'</span> => <span class="php-var">$url</span>);
</span><span id="341" class="l"><a class="l" href="#341">341: </a>
</span><span id="342" class="l"><a class="l" href="#342">342: </a> <span class="php-keyword1">return</span> PaginatedIterator::factory(<span class="php-var">$this</span>, <span class="php-var">$options</span>, Formatter::decode(<span class="php-var">$response</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 class="php-comment">/**
</span></span><span id="346" class="l"><a class="l" href="#346">346: </a><span class="php-comment"> * If an ID is supplied, the API is queried for a persistent object; otherwise
</span></span><span id="347" class="l"><a class="l" href="#347">347: </a><span class="php-comment"> * an empty object is returned.
</span></span><span id="348" class="l"><a class="l" href="#348">348: </a><span class="php-comment"> *
</span></span><span id="349" class="l"><a class="l" href="#349">349: </a><span class="php-comment"> * @param int $id
</span></span><span id="350" class="l"><a class="l" href="#350">350: </a><span class="php-comment"> * @return Claim
</span></span><span id="351" class="l"><a class="l" href="#351">351: </a><span class="php-comment"> */</span>
</span><span id="352" class="l"><a class="l" href="#352">352: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getClaim" href="#_getClaim">getClaim</a>(<span class="php-var">$id</span> = <span class="php-keyword1">null</span>)
</span><span id="353" class="l"><a class="l" href="#353">353: </a> {
</span><span id="354" class="l"><a class="l" href="#354">354: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->getService()->resource(<span class="php-quote">'Claim'</span>, <span class="php-var">$id</span>, <span class="php-var">$this</span>);
</span><span id="355" class="l"><a class="l" href="#355">355: </a> }
</span><span id="356" class="l"><a class="l" href="#356">356: </a>}
</span><span id="357" class="l"><a class="l" href="#357">357: </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>
|