EngineProvider.php 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  1. <?php
  2. /**
  3. * Copyright © Magento, Inc. All rights reserved.
  4. * See COPYING.txt for license details.
  5. */
  6. namespace Magento\CatalogSearch\Model\ResourceModel;
  7. use Magento\Framework\Search\EngineResolverInterface;
  8. /**
  9. * Catalog Search engine provider
  10. *
  11. * @api
  12. * @since 100.0.2
  13. */
  14. class EngineProvider
  15. {
  16. /**
  17. * @deprecated since using engine resolver
  18. * @see \Magento\Framework\Search\EngineResolverInterface
  19. */
  20. const CONFIG_ENGINE_PATH = 'catalog/search/engine';
  21. /**
  22. * @var EngineInterface
  23. */
  24. protected $engine;
  25. /**
  26. * @var \Magento\Framework\App\Config\ScopeConfigInterface
  27. * @deprecated 101.0.0 since it is not used anymore
  28. */
  29. protected $scopeConfig;
  30. /**
  31. * @var \Magento\Framework\ObjectManagerInterface
  32. */
  33. private $objectManager;
  34. /**
  35. * Pool of existing engines
  36. *
  37. * @var array
  38. */
  39. private $enginePool;
  40. /**
  41. * @var EngineResolverInterface
  42. */
  43. private $engineResolver;
  44. /**
  45. * @param \Magento\Framework\ObjectManagerInterface $objectManager
  46. * @param array $engines
  47. * @param EngineResolverInterface $engineResolver
  48. */
  49. public function __construct(
  50. \Magento\Framework\ObjectManagerInterface $objectManager,
  51. array $engines,
  52. EngineResolverInterface $engineResolver
  53. ) {
  54. $this->objectManager = $objectManager;
  55. $this->enginePool = $engines;
  56. $this->engineResolver = $engineResolver;
  57. }
  58. /**
  59. * Get engine singleton
  60. *
  61. * @return EngineInterface
  62. */
  63. public function get()
  64. {
  65. if (!$this->engine) {
  66. $currentEngine = $this->engineResolver->getCurrentSearchEngine();
  67. if (!isset($this->enginePool[$currentEngine])) {
  68. throw new \LogicException(
  69. 'There is no such engine: ' . $currentEngine
  70. );
  71. }
  72. $engineClassName = $this->enginePool[$currentEngine];
  73. $engine = $this->objectManager->create($engineClassName);
  74. if (false === $engine instanceof EngineInterface) {
  75. throw new \LogicException(
  76. $currentEngine . ' doesn\'t implement ' . EngineInterface::class
  77. );
  78. }
  79. /** @var $engine EngineInterface */
  80. if ($engine && !$engine->isAvailable()) {
  81. throw new \LogicException(
  82. 'Engine is not available: ' . $currentEngine
  83. );
  84. }
  85. $this->engine = $engine;
  86. }
  87. return $this->engine;
  88. }
  89. }