123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145 |
- <?php
- /**
- * Copyright © Magento, Inc. All rights reserved.
- * See COPYING.txt for license details.
- */
- namespace Magento\Framework\Communication\Config;
- use Magento\Framework\Reflection\TypeProcessor;
- use Magento\Framework\Reflection\MethodsMap;
- /**
- * Communication configuration validator.
- */
- class Validator
- {
- /**
- * @var TypeProcessor
- */
- private $typeProcessor;
- /**
- * @var MethodsMap
- */
- private $methodsMap;
- /**
- * Initialize dependencies.
- *
- * @param TypeProcessor $typeProcessor
- * @param MethodsMap $methodsMap
- */
- public function __construct(
- TypeProcessor $typeProcessor,
- MethodsMap $methodsMap
- ) {
- $this->typeProcessor = $typeProcessor;
- $this->methodsMap = $methodsMap;
- }
- /**
- * Validate response schema definition for topic
- *
- * @param string $responseSchema
- * @param string $topicName
- * @return void
- */
- public function validateResponseSchemaType($responseSchema, $topicName)
- {
- try {
- $this->validateType($responseSchema);
- } catch (\InvalidArgumentException $e) {
- throw new \LogicException(
- 'Response schema definition has service class with wrong annotated methods',
- $e->getCode(),
- $e
- );
- } catch (\Exception $e) {
- throw new \LogicException(
- sprintf(
- 'Response schema definition for topic "%s" should reference existing type or service class. '
- . 'Given "%s"',
- $topicName,
- $responseSchema
- )
- );
- }
- }
- /**
- * Validate request schema definition for topic
- *
- * @param string $requestSchema
- * @param string $topicName
- * @return void
- */
- public function validateRequestSchemaType($requestSchema, $topicName)
- {
- try {
- $this->validateType($requestSchema);
- } catch (\InvalidArgumentException $e) {
- throw new \LogicException(
- 'Request schema definition has service class with wrong annotated methods',
- $e->getCode(),
- $e
- );
- } catch (\Exception $e) {
- throw new \LogicException(
- sprintf(
- 'Request schema definition for topic "%s" should reference existing service class. '
- . 'Given "%s"',
- $topicName,
- $requestSchema
- )
- );
- }
- }
- /**
- * Validate service method specified in the definition of handler
- *
- * @param string $serviceName
- * @param string $methodName
- * @param string $handlerName
- * @param string $topicName
- * @return void
- */
- public function validateResponseHandlersType($serviceName, $methodName, $handlerName, $topicName)
- {
- try {
- $this->methodsMap->getMethodParams($serviceName, $methodName);
- } catch (\Exception $e) {
- throw new \LogicException(
- sprintf(
- 'Service method specified in the definition of handler "%s" for topic "%s"'
- . ' is not available. Given "%s"',
- $handlerName,
- $topicName,
- $serviceName . '::' . $methodName
- )
- );
- }
- }
- /**
- * Ensure that specified type is either a simple type or a valid service data type.
- *
- * @param string $typeName
- * @return $this
- * @throws \Exception In case when type is invalid
- * @throws \InvalidArgumentException if methods don't have annotation
- */
- protected function validateType($typeName)
- {
- if ($this->typeProcessor->isTypeSimple($typeName)) {
- return $this;
- }
- if ($this->typeProcessor->isArrayType($typeName)) {
- $arrayItemType = $this->typeProcessor->getArrayItemType($typeName);
- $this->methodsMap->getMethodsMap($arrayItemType);
- } else {
- $this->methodsMap->getMethodsMap($typeName);
- }
- return $this;
- }
- }
|