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
PageStreamingDescriptor.php
179 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 | namespace Google\ApiCore; |
| 33 | |
| 34 | use InvalidArgumentException; |
| 35 | |
| 36 | /** |
| 37 | * Holds the description information used for page streaming. |
| 38 | */ |
| 39 | class PageStreamingDescriptor |
| 40 | { |
| 41 | private $descriptor; |
| 42 | |
| 43 | /** |
| 44 | * @param array $descriptor { |
| 45 | * Required. |
| 46 | * @type string $requestPageTokenGetMethod the get method for the page token in the request object. |
| 47 | * @type string $requestPageTokenSetMethod the set method for the page token in the request object. |
| 48 | * @type string $responsePageTokenGetMethod the get method for the page token in the response object. |
| 49 | * @type string resourcesGetMethod the get method for the resources in the response object. |
| 50 | * |
| 51 | * Optional. |
| 52 | * @type string $requestPageSizeGetMethod the get method for the page size in the request object. |
| 53 | * } |
| 54 | */ |
| 55 | public function __construct(array $descriptor) |
| 56 | { |
| 57 | self::validate($descriptor); |
| 58 | $this->descriptor = $descriptor; |
| 59 | } |
| 60 | |
| 61 | /** |
| 62 | * @param array $fields { |
| 63 | * Required. |
| 64 | * |
| 65 | * @type string $requestPageTokenField the page token field in the request object. |
| 66 | * @type string $responsePageTokenField the page token field in the response object. |
| 67 | * @type string $resourceField the resource field in the response object. |
| 68 | * |
| 69 | * Optional. |
| 70 | * @type string $requestPageSizeField the page size field in the request object. |
| 71 | * } |
| 72 | * @return PageStreamingDescriptor |
| 73 | */ |
| 74 | public static function createFromFields(array $fields) |
| 75 | { |
| 76 | $requestPageToken = $fields['requestPageTokenField']; |
| 77 | $responsePageToken = $fields['responsePageTokenField']; |
| 78 | $resources = $fields['resourceField']; |
| 79 | |
| 80 | $descriptor = [ |
| 81 | 'requestPageTokenGetMethod' => PageStreamingDescriptor::getMethod($requestPageToken), |
| 82 | 'requestPageTokenSetMethod' => PageStreamingDescriptor::setMethod($requestPageToken), |
| 83 | 'responsePageTokenGetMethod' => PageStreamingDescriptor::getMethod($responsePageToken), |
| 84 | 'resourcesGetMethod' => PageStreamingDescriptor::getMethod($resources), |
| 85 | ]; |
| 86 | |
| 87 | if (isset($fields['requestPageSizeField'])) { |
| 88 | $requestPageSize = $fields['requestPageSizeField']; |
| 89 | $descriptor['requestPageSizeGetMethod'] = PageStreamingDescriptor::getMethod($requestPageSize); |
| 90 | $descriptor['requestPageSizeSetMethod'] = PageStreamingDescriptor::setMethod($requestPageSize); |
| 91 | } |
| 92 | |
| 93 | return new PageStreamingDescriptor($descriptor); |
| 94 | } |
| 95 | |
| 96 | private static function getMethod(string $field) |
| 97 | { |
| 98 | return 'get' . ucfirst($field); |
| 99 | } |
| 100 | |
| 101 | private static function setMethod(string $field) |
| 102 | { |
| 103 | return 'set' . ucfirst($field); |
| 104 | } |
| 105 | |
| 106 | /** |
| 107 | * @return string The page token get method on the request object |
| 108 | */ |
| 109 | public function getRequestPageTokenGetMethod() |
| 110 | { |
| 111 | return $this->descriptor['requestPageTokenGetMethod']; |
| 112 | } |
| 113 | |
| 114 | /** |
| 115 | * @return string The page size get method on the request object |
| 116 | */ |
| 117 | public function getRequestPageSizeGetMethod() |
| 118 | { |
| 119 | return $this->descriptor['requestPageSizeGetMethod']; |
| 120 | } |
| 121 | |
| 122 | /** |
| 123 | * @return bool True if the request object has a page size field |
| 124 | */ |
| 125 | public function requestHasPageSizeField() |
| 126 | { |
| 127 | return array_key_exists('requestPageSizeGetMethod', $this->descriptor); |
| 128 | } |
| 129 | |
| 130 | /** |
| 131 | * @return string The page token get method on the response object |
| 132 | */ |
| 133 | public function getResponsePageTokenGetMethod() |
| 134 | { |
| 135 | return $this->descriptor['responsePageTokenGetMethod']; |
| 136 | } |
| 137 | |
| 138 | /** |
| 139 | * @return string The resources get method on the response object |
| 140 | */ |
| 141 | public function getResourcesGetMethod() |
| 142 | { |
| 143 | return $this->descriptor['resourcesGetMethod']; |
| 144 | } |
| 145 | |
| 146 | /** |
| 147 | * @return string The page token set method on the request object |
| 148 | */ |
| 149 | public function getRequestPageTokenSetMethod() |
| 150 | { |
| 151 | return $this->descriptor['requestPageTokenSetMethod']; |
| 152 | } |
| 153 | |
| 154 | /** |
| 155 | * @return string The page size set method on the request object |
| 156 | */ |
| 157 | public function getRequestPageSizeSetMethod() |
| 158 | { |
| 159 | return $this->descriptor['requestPageSizeSetMethod']; |
| 160 | } |
| 161 | |
| 162 | private static function validate(array $descriptor) |
| 163 | { |
| 164 | $requiredFields = [ |
| 165 | 'requestPageTokenGetMethod', |
| 166 | 'requestPageTokenSetMethod', |
| 167 | 'responsePageTokenGetMethod', |
| 168 | 'resourcesGetMethod', |
| 169 | ]; |
| 170 | foreach ($requiredFields as $field) { |
| 171 | if (empty($descriptor[$field])) { |
| 172 | throw new InvalidArgumentException( |
| 173 | "$field is required for PageStreamingDescriptor" |
| 174 | ); |
| 175 | } |
| 176 | } |
| 177 | } |
| 178 | } |
| 179 |