ConsumerInstance.php 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\Framework\MessageQueue\Consumer\Config\Validator;
  7. use Magento\Framework\MessageQueue\Consumer;
  8. use Magento\Framework\MessageQueue\Consumer\Config\ValidatorInterface;
  9. use Magento\Framework\MessageQueue\ConsumerInterface;
  10. /**
  11. * Consumer config data validator for consumer instance.
  12. */
  13. class ConsumerInstance implements ValidatorInterface
  14. {
  15. /**
  16. * {@inheritdoc}
  17. */
  18. public function validate($configData)
  19. {
  20. foreach ($configData as $consumerConfig) {
  21. $this->validateConsumerInstance($consumerConfig);
  22. }
  23. }
  24. /**
  25. * Make sure that specified consumer instance is valid.
  26. *
  27. * @param array $consumerConfig
  28. * @return void
  29. * @throws \LogicException
  30. */
  31. private function validateConsumerInstance($consumerConfig)
  32. {
  33. $consumerInstance = $consumerConfig['consumerInstance'];
  34. if ($consumerInstance == ConsumerInterface::class) {
  35. return;
  36. }
  37. if (!class_exists($consumerInstance)) {
  38. throw new \LogicException(
  39. sprintf(
  40. "'%s' does not exist and thus cannot be used as 'consumerInstance' for '%s' consumer.",
  41. $consumerInstance,
  42. $consumerConfig['name'],
  43. ConsumerInterface::class
  44. )
  45. );
  46. }
  47. $implementedInterfaces = class_implements($consumerInstance);
  48. if (!in_array(ConsumerInterface::class, $implementedInterfaces)) {
  49. throw new \LogicException(
  50. sprintf(
  51. "'%s' cannot be specified as 'consumerInstance' for '%s' consumer,"
  52. . " unless it implements '%s' interface",
  53. $consumerInstance,
  54. $consumerConfig['name'],
  55. ConsumerInterface::class
  56. )
  57. );
  58. }
  59. }
  60. }