One of the error codes that is listed on the Errors page.
+ * + * + * @return null|string + */ + public function getCode() + { + if (is_null($this->code)) { + /** @psalm-var ?string $data */ + $data = $this->raw(self::FIELD_CODE); + if (is_null($data)) { + return null; + } + $this->code = (string) $data; + } + + return $this->code; + } + + + + /** + * @return mixed + */ + public function by(string $key) + { + $data = $this->raw($key); + if (is_null($data)) { + return null; + } + if (preg_match(GraphQLErrorObject::FIELD_PATTERN1, $key) === 1) { + /** @psalm-var stdClass $data */ + return JsonObjectModel::of($data); + } + + return $data; + } + + + /** + * @psalm-param stdClass|arrayLocation within your query where the error occurred.
+ * + + * @return null|GraphQLErrorLocationCollection + */ + public function getLocations(); + + /** + *Query fields listed in order from the root of the query response up to the field in which the error occurred. path is displayed in the response only if an error is associated with a particular field in the query result.
Dictionary with additional information where applicable.
+ * + + * @return null|GraphQLErrorObject + */ + public function getExtensions(); + + /** + * @param ?string $message + */ + public function setMessage(?string $message): void; + + /** + * @param ?GraphQLErrorLocationCollection $locations + */ + public function setLocations(?GraphQLErrorLocationCollection $locations): void; + + /** + * @param ?array $path + */ + public function setPath(?array $path): void; + + /** + * @param ?GraphQLErrorObject $extensions + */ + public function setExtensions(?GraphQLErrorObject $extensions): void; +} diff --git a/lib/commercetools-history/src/Models/GraphQl/GraphQLErrorBuilder.php b/lib/commercetools-history/src/Models/GraphQl/GraphQLErrorBuilder.php new file mode 100644 index 00000000000..95278d33a16 --- /dev/null +++ b/lib/commercetools-history/src/Models/GraphQl/GraphQLErrorBuilder.php @@ -0,0 +1,162 @@ + + */ +final class GraphQLErrorBuilder implements Builder +{ + /** + + * @var ?string + */ + private $message; + + /** + + * @var ?GraphQLErrorLocationCollection + */ + private $locations; + + /** + + * @var ?array + */ + private $path; + + /** + + * @var null|GraphQLErrorObject|GraphQLErrorObjectBuilder + */ + private $extensions; + + /** + *Detailed description of the error explaining the root cause of the problem and suggesting how to correct the error.
+ * + + * @return null|string + */ + public function getMessage() + { + return $this->message; + } + + /** + *Location within your query where the error occurred.
+ * + + * @return null|GraphQLErrorLocationCollection + */ + public function getLocations() + { + return $this->locations; + } + + /** + *Query fields listed in order from the root of the query response up to the field in which the error occurred. path is displayed in the response only if an error is associated with a particular field in the query result.
Dictionary with additional information where applicable.
+ * + + * @return null|GraphQLErrorObject + */ + public function getExtensions() + { + return $this->extensions instanceof GraphQLErrorObjectBuilder ? $this->extensions->build() : $this->extensions; + } + + /** + * @param ?string $message + * @return $this + */ + public function withMessage(?string $message) + { + $this->message = $message; + + return $this; + } + + /** + * @param ?GraphQLErrorLocationCollection $locations + * @return $this + */ + public function withLocations(?GraphQLErrorLocationCollection $locations) + { + $this->locations = $locations; + + return $this; + } + + /** + * @param ?array $path + * @return $this + */ + public function withPath(?array $path) + { + $this->path = $path; + + return $this; + } + + /** + * @param ?GraphQLErrorObject $extensions + * @return $this + */ + public function withExtensions(?GraphQLErrorObject $extensions) + { + $this->extensions = $extensions; + + return $this; + } + + /** + * @deprecated use withExtensions() instead + * @return $this + */ + public function withExtensionsBuilder(?GraphQLErrorObjectBuilder $extensions) + { + $this->extensions = $extensions; + + return $this; + } + + public function build(): GraphQLError + { + return new GraphQLErrorModel( + $this->message, + $this->locations, + $this->path, + $this->extensions instanceof GraphQLErrorObjectBuilder ? $this->extensions->build() : $this->extensions + ); + } + + public static function of(): GraphQLErrorBuilder + { + return new self(); + } +} diff --git a/lib/commercetools-history/src/Models/GraphQl/GraphQLErrorCollection.php b/lib/commercetools-history/src/Models/GraphQl/GraphQLErrorCollection.php new file mode 100644 index 00000000000..947ce31864f --- /dev/null +++ b/lib/commercetools-history/src/Models/GraphQl/GraphQLErrorCollection.php @@ -0,0 +1,56 @@ + + * @method GraphQLError current() + * @method GraphQLError end() + * @method GraphQLError at($offset) + */ +class GraphQLErrorCollection extends MapperSequence +{ + /** + * @psalm-assert GraphQLError $value + * @psalm-param GraphQLError|stdClass $value + * @throws InvalidArgumentException + * + * @return GraphQLErrorCollection + */ + public function add($value) + { + if (!$value instanceof GraphQLError) { + throw new InvalidArgumentException(); + } + $this->store($value); + + return $this; + } + + /** + * @psalm-return callable(int):?GraphQLError + */ + protected function mapper() + { + return function (?int $index): ?GraphQLError { + $data = $this->get($index); + if ($data instanceof stdClass) { + /** @var GraphQLError $data */ + $data = GraphQLErrorModel::of($data); + $this->set($data, $index); + } + + return $data; + }; + } +} diff --git a/lib/commercetools-history/src/Models/GraphQl/GraphQLErrorLocation.php b/lib/commercetools-history/src/Models/GraphQl/GraphQLErrorLocation.php new file mode 100644 index 00000000000..9d2bd2e5f46 --- /dev/null +++ b/lib/commercetools-history/src/Models/GraphQl/GraphQLErrorLocation.php @@ -0,0 +1,45 @@ +Line number of the query where the error occurred. + * + + * @return null|int + */ + public function getLine(); + + /** + *Position in line where the error occurred.
Line number of the query where the error occurred.
+ * + + * @return null|int + */ + public function getLine() + { + return $this->line; + } + + /** + *Position in line where the error occurred.
Line number of the query where the error occurred.
+ * + * + * @return null|int + */ + public function getLine() + { + if (is_null($this->line)) { + /** @psalm-var ?int $data */ + $data = $this->raw(self::FIELD_LINE); + if (is_null($data)) { + return null; + } + $this->line = (int) $data; + } + + return $this->line; + } + + /** + *Position in line where the error occurred.
Detailed description of the error explaining the root cause of the problem and suggesting how to correct the error.
+ * + * + * @return null|string + */ + public function getMessage() + { + if (is_null($this->message)) { + /** @psalm-var ?string $data */ + $data = $this->raw(self::FIELD_MESSAGE); + if (is_null($data)) { + return null; + } + $this->message = (string) $data; + } + + return $this->message; + } + + /** + *Location within your query where the error occurred.
+ * + * + * @return null|GraphQLErrorLocationCollection + */ + public function getLocations() + { + if (is_null($this->locations)) { + /** @psalm-var ?listQuery fields listed in order from the root of the query response up to the field in which the error occurred. path is displayed in the response only if an error is associated with a particular field in the query result.
Dictionary with additional information where applicable.
+ * + * + * @return null|GraphQLErrorObject + */ + public function getExtensions() + { + if (is_null($this->extensions)) { + /** @psalm-var stdClass|arrayName of the operation, if you defined several operations in query.
JSON object that contains key-value pairs in which the keys are variable names and the values are variable values.
+ * + + * @return null|GraphQLVariablesMap + */ + public function getVariables(); + + /** + * @param ?string $query + */ + public function setQuery(?string $query): void; + + /** + * @param ?string $operationName + */ + public function setOperationName(?string $operationName): void; + + /** + * @param ?GraphQLVariablesMap $variables + */ + public function setVariables(?GraphQLVariablesMap $variables): void; +} diff --git a/lib/commercetools-history/src/Models/GraphQl/GraphQLRequestBuilder.php b/lib/commercetools-history/src/Models/GraphQl/GraphQLRequestBuilder.php new file mode 100644 index 00000000000..14faed70dc3 --- /dev/null +++ b/lib/commercetools-history/src/Models/GraphQl/GraphQLRequestBuilder.php @@ -0,0 +1,131 @@ + + */ +final class GraphQLRequestBuilder implements Builder +{ + /** + + * @var ?string + */ + private $query; + + /** + + * @var ?string + */ + private $operationName; + + /** + + * @var null|GraphQLVariablesMap|GraphQLVariablesMapBuilder + */ + private $variables; + + /** + *String representation of the Source Text of the Document that is specified in the Language section of the GraphQL specification.
+ * + + * @return null|string + */ + public function getQuery() + { + return $this->query; + } + + /** + *Name of the operation, if you defined several operations in query.
JSON object that contains key-value pairs in which the keys are variable names and the values are variable values.
+ * + + * @return null|GraphQLVariablesMap + */ + public function getVariables() + { + return $this->variables instanceof GraphQLVariablesMapBuilder ? $this->variables->build() : $this->variables; + } + + /** + * @param ?string $query + * @return $this + */ + public function withQuery(?string $query) + { + $this->query = $query; + + return $this; + } + + /** + * @param ?string $operationName + * @return $this + */ + public function withOperationName(?string $operationName) + { + $this->operationName = $operationName; + + return $this; + } + + /** + * @param ?GraphQLVariablesMap $variables + * @return $this + */ + public function withVariables(?GraphQLVariablesMap $variables) + { + $this->variables = $variables; + + return $this; + } + + /** + * @deprecated use withVariables() instead + * @return $this + */ + public function withVariablesBuilder(?GraphQLVariablesMapBuilder $variables) + { + $this->variables = $variables; + + return $this; + } + + public function build(): GraphQLRequest + { + return new GraphQLRequestModel( + $this->query, + $this->operationName, + $this->variables instanceof GraphQLVariablesMapBuilder ? $this->variables->build() : $this->variables + ); + } + + public static function of(): GraphQLRequestBuilder + { + return new self(); + } +} diff --git a/lib/commercetools-history/src/Models/GraphQl/GraphQLRequestCollection.php b/lib/commercetools-history/src/Models/GraphQl/GraphQLRequestCollection.php new file mode 100644 index 00000000000..cd040d5d296 --- /dev/null +++ b/lib/commercetools-history/src/Models/GraphQl/GraphQLRequestCollection.php @@ -0,0 +1,56 @@ + + * @method GraphQLRequest current() + * @method GraphQLRequest end() + * @method GraphQLRequest at($offset) + */ +class GraphQLRequestCollection extends MapperSequence +{ + /** + * @psalm-assert GraphQLRequest $value + * @psalm-param GraphQLRequest|stdClass $value + * @throws InvalidArgumentException + * + * @return GraphQLRequestCollection + */ + public function add($value) + { + if (!$value instanceof GraphQLRequest) { + throw new InvalidArgumentException(); + } + $this->store($value); + + return $this; + } + + /** + * @psalm-return callable(int):?GraphQLRequest + */ + protected function mapper() + { + return function (?int $index): ?GraphQLRequest { + $data = $this->get($index); + if ($data instanceof stdClass) { + /** @var GraphQLRequest $data */ + $data = GraphQLRequestModel::of($data); + $this->set($data, $index); + } + + return $data; + }; + } +} diff --git a/lib/commercetools-history/src/Models/GraphQl/GraphQLRequestModel.php b/lib/commercetools-history/src/Models/GraphQl/GraphQLRequestModel.php new file mode 100644 index 00000000000..be24deceaf3 --- /dev/null +++ b/lib/commercetools-history/src/Models/GraphQl/GraphQLRequestModel.php @@ -0,0 +1,145 @@ +query = $query; + $this->operationName = $operationName; + $this->variables = $variables; + + } + + /** + *String representation of the Source Text of the Document that is specified in the Language section of the GraphQL specification.
+ * + * + * @return null|string + */ + public function getQuery() + { + if (is_null($this->query)) { + /** @psalm-var ?string $data */ + $data = $this->raw(self::FIELD_QUERY); + if (is_null($data)) { + return null; + } + $this->query = (string) $data; + } + + return $this->query; + } + + /** + *Name of the operation, if you defined several operations in query.
JSON object that contains key-value pairs in which the keys are variable names and the values are variable values.
+ * + * + * @return null|GraphQLVariablesMap + */ + public function getVariables() + { + if (is_null($this->variables)) { + /** @psalm-var stdClass|arrayErrors that the GraphQL query returns.
+ * + + * @return null|GraphQLErrorCollection + */ + public function getErrors(); + + /** + * @param mixed $data + */ + public function setData( $data): void; + + /** + * @param ?GraphQLErrorCollection $errors + */ + public function setErrors(?GraphQLErrorCollection $errors): void; +} diff --git a/lib/commercetools-history/src/Models/GraphQl/GraphQLResponseBuilder.php b/lib/commercetools-history/src/Models/GraphQl/GraphQLResponseBuilder.php new file mode 100644 index 00000000000..0f880b062be --- /dev/null +++ b/lib/commercetools-history/src/Models/GraphQl/GraphQLResponseBuilder.php @@ -0,0 +1,92 @@ + + */ +final class GraphQLResponseBuilder implements Builder +{ + /** + + * @var null|mixed|mixed + */ + private $data; + + /** + + * @var ?GraphQLErrorCollection + */ + private $errors; + + /** + *JSON object that contains the results of a GraphQL query.
+ * + + * @return null|mixed + */ + public function getData() + { + return $this->data; + } + + /** + *Errors that the GraphQL query returns.
+ * + + * @return null|GraphQLErrorCollection + */ + public function getErrors() + { + return $this->errors; + } + + /** + * @param mixed $data + * @return $this + */ + public function withData( $data) + { + $this->data = $data; + + return $this; + } + + /** + * @param ?GraphQLErrorCollection $errors + * @return $this + */ + public function withErrors(?GraphQLErrorCollection $errors) + { + $this->errors = $errors; + + return $this; + } + + + public function build(): GraphQLResponse + { + return new GraphQLResponseModel( + $this->data, + $this->errors + ); + } + + public static function of(): GraphQLResponseBuilder + { + return new self(); + } +} diff --git a/lib/commercetools-history/src/Models/GraphQl/GraphQLResponseCollection.php b/lib/commercetools-history/src/Models/GraphQl/GraphQLResponseCollection.php new file mode 100644 index 00000000000..d89d3a414b1 --- /dev/null +++ b/lib/commercetools-history/src/Models/GraphQl/GraphQLResponseCollection.php @@ -0,0 +1,56 @@ + + * @method GraphQLResponse current() + * @method GraphQLResponse end() + * @method GraphQLResponse at($offset) + */ +class GraphQLResponseCollection extends MapperSequence +{ + /** + * @psalm-assert GraphQLResponse $value + * @psalm-param GraphQLResponse|stdClass $value + * @throws InvalidArgumentException + * + * @return GraphQLResponseCollection + */ + public function add($value) + { + if (!$value instanceof GraphQLResponse) { + throw new InvalidArgumentException(); + } + $this->store($value); + + return $this; + } + + /** + * @psalm-return callable(int):?GraphQLResponse + */ + protected function mapper() + { + return function (?int $index): ?GraphQLResponse { + $data = $this->get($index); + if ($data instanceof stdClass) { + /** @var GraphQLResponse $data */ + $data = GraphQLResponseModel::of($data); + $this->set($data, $index); + } + + return $data; + }; + } +} diff --git a/lib/commercetools-history/src/Models/GraphQl/GraphQLResponseModel.php b/lib/commercetools-history/src/Models/GraphQl/GraphQLResponseModel.php new file mode 100644 index 00000000000..7f1e4f8f1ed --- /dev/null +++ b/lib/commercetools-history/src/Models/GraphQl/GraphQLResponseModel.php @@ -0,0 +1,108 @@ +data = $data; + $this->errors = $errors; + + } + + /** + *JSON object that contains the results of a GraphQL query.
+ * + * + * @return null|mixed + */ + public function getData() + { + if (is_null($this->data)) { + /** @psalm-var mixed $data */ + $data = $this->raw(self::FIELD_DATA); + if (is_null($data)) { + return null; + } + $this->data = $data; + } + + return $this->data; + } + + /** + *Errors that the GraphQL query returns.
+ * + * + * @return null|GraphQLErrorCollection + */ + public function getErrors() + { + if (is_null($this->errors)) { + /** @psalm-var ?list