Middleware
3 years ago
ResourceTemplate
3 years ago
Testing
3 years ago
Transport
3 years ago
AgentHeader.php
3 years ago
ApiException.php
3 years ago
ApiStatus.php
3 years ago
ArrayTrait.php
3 years ago
BidiStream.php
3 years ago
Call.php
3 years ago
ClientStream.php
3 years ago
CredentialsWrapper.php
3 years ago
FixedSizeCollection.php
3 years ago
GPBLabel.php
3 years ago
GPBType.php
3 years ago
GapicClientTrait.php
3 years ago
GrpcSupportTrait.php
3 years ago
OperationResponse.php
3 years ago
Page.php
3 years ago
PageStreamingDescriptor.php
3 years ago
PagedListResponse.php
3 years ago
PathTemplate.php
3 years ago
PollingTrait.php
3 years ago
RequestBuilder.php
3 years ago
RequestParamsHeaderDescriptor.php
3 years ago
RetrySettings.php
3 years ago
Serializer.php
3 years ago
ServerStream.php
3 years ago
ServerStreamingCallInterface.php
3 years ago
ServiceAddressTrait.php
3 years ago
UriTrait.php
3 years ago
ValidationException.php
3 years ago
ValidationTrait.php
3 years ago
Version.php
3 years ago
PathTemplate.php
114 lines
| 1 | <?php |
| 2 | /* |
| 3 | * Copyright 2016 Google LLC |
| 4 | * All rights reserved. |
| 5 | * |
| 6 | * Redistribution and use in source and binary forms, with or without |
| 7 | * modification, are permitted provided that the following conditions are |
| 8 | * met: |
| 9 | * |
| 10 | * * Redistributions of source code must retain the above copyright |
| 11 | * notice, this list of conditions and the following disclaimer. |
| 12 | * * Redistributions in binary form must reproduce the above |
| 13 | * copyright notice, this list of conditions and the following disclaimer |
| 14 | * in the documentation and/or other materials provided with the |
| 15 | * distribution. |
| 16 | * * Neither the name of Google Inc. nor the names of its |
| 17 | * contributors may be used to endorse or promote products derived from |
| 18 | * this software without specific prior written permission. |
| 19 | * |
| 20 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 21 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 22 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 23 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 24 | * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 25 | * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 26 | * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 27 | * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 28 | * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 29 | * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 30 | * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 31 | */ |
| 32 | |
| 33 | namespace Google\ApiCore; |
| 34 | |
| 35 | use Google\ApiCore\ResourceTemplate\AbsoluteResourceTemplate; |
| 36 | use Google\ApiCore\ResourceTemplate\RelativeResourceTemplate; |
| 37 | use Google\ApiCore\ResourceTemplate\ResourceTemplateInterface; |
| 38 | |
| 39 | /** |
| 40 | * Represents a path template. |
| 41 | * |
| 42 | * Templates use the syntax of the API platform; see the protobuf of HttpRule for |
| 43 | * details. A template consists of a sequence of literals, wildcards, and variable bindings, |
| 44 | * where each binding can have a sub-path. A string representation can be parsed into an |
| 45 | * instance of PathTemplate, which can then be used to perform matching and instantiation. |
| 46 | */ |
| 47 | class PathTemplate implements ResourceTemplateInterface |
| 48 | { |
| 49 | private $resourceTemplate; |
| 50 | |
| 51 | /** |
| 52 | * PathTemplate constructor. |
| 53 | * |
| 54 | * @param string $path A path template string |
| 55 | * @throws ValidationException When $path cannot be parsed into a valid PathTemplate |
| 56 | */ |
| 57 | public function __construct(string $path = null) |
| 58 | { |
| 59 | if (empty($path)) { |
| 60 | throw new ValidationException('Cannot construct PathTemplate from empty string'); |
| 61 | } |
| 62 | |
| 63 | if ($path[0] === '/') { |
| 64 | $this->resourceTemplate = new AbsoluteResourceTemplate($path); |
| 65 | } else { |
| 66 | $this->resourceTemplate = new RelativeResourceTemplate($path); |
| 67 | } |
| 68 | } |
| 69 | |
| 70 | /** |
| 71 | * @return string A string representation of the path template |
| 72 | */ |
| 73 | public function __toString() |
| 74 | { |
| 75 | return $this->resourceTemplate->__toString(); |
| 76 | } |
| 77 | |
| 78 | /** |
| 79 | * Renders a path template using the provided bindings. |
| 80 | * |
| 81 | * @param array $bindings An array matching var names to binding strings. |
| 82 | * @throws ValidationException if a key isn't provided or if a sub-template |
| 83 | * can't be parsed. |
| 84 | * @return string A rendered representation of this path template. |
| 85 | */ |
| 86 | public function render(array $bindings) |
| 87 | { |
| 88 | return $this->resourceTemplate->render($bindings); |
| 89 | } |
| 90 | |
| 91 | /** |
| 92 | * Check if $path matches a resource string. |
| 93 | * |
| 94 | * @param string $path A resource string. |
| 95 | * @return bool |
| 96 | */ |
| 97 | public function matches(string $path) |
| 98 | { |
| 99 | return $this->resourceTemplate->matches($path); |
| 100 | } |
| 101 | |
| 102 | /** |
| 103 | * Matches a fully qualified path template string. |
| 104 | * |
| 105 | * @param string $path A fully qualified path template string. |
| 106 | * @throws ValidationException if path can't be matched to the template. |
| 107 | * @return array Array matching var names to binding values. |
| 108 | */ |
| 109 | public function match(string $path) |
| 110 | { |
| 111 | return $this->resourceTemplate->match($path); |
| 112 | } |
| 113 | } |
| 114 |