ExtraModule: Add support for special ExtraModule which can define some extra logic in project modules and connect to other packages. Now it is used to search videos on Mathematicator.com and return results.

Author: janbarasek

config.neon

@@ -1,9 +1,15 @@
 services:
-	- Mathematicator\Engine\Engine
-	- Mathematicator\Engine\QueryNormalizer
-	- Mathematicator\Engine\Translator
+	mathematicator.engine:
+		factory: Mathematicator\Engine\Engine
+		setup:
+			- addExtraModule(@Mathematicator\Engine\SampleModule)
+	mathematicator.queryNormalizer:
+		factory: Mathematicator\Engine\QueryNormalizer
+	mathematicator.translator:
+	 	factory: Mathematicator\Engine\Translator
 	- Mathematicator\NumberRewriter
 	- Mathematicator\NaturalTextFormatter
+	- Mathematicator\Engine\SampleModule
 
 orm.annotations:
 	paths:

src/Engine.php

@@ -30,6 +30,11 @@ final class Engine
 	 */
 	private $serviceFactory;
 
+	/**
+	 * @var ExtraModule[]
+	 */
+	private $extraModules = [];
+
 	/**
 	 * @param Router $router
 	 * @param QueryNormalizer $queryNormalizer
@@ -72,9 +77,30 @@ public function compute(string $query): EngineResult
 			$return = new EngineSingleResult($queryEntity->getQuery(), $matchedRoute);
 		}
 
+		foreach ($this->extraModules as $extraModule) {
+			$extraModule->setEngineSingleResult($return);
+			if ($extraModule->match($queryEntity->getQuery()) === true) {
+				foreach (InjectExtension::getInjectProperties(\get_class($extraModule)) as $property => $service) {
+					$extraModule->{$property} = $this->serviceFactory->getByType($service);
+				}
+				if (method_exists($extraModule, 'setQuery')) {
+					$extraModule->setQuery($queryEntity->getQuery());
+				}
+				$extraModule->actionDefault();
+			}
+		}
+
 		return $return->setTime((int) (Debugger::timer('search_request') * 1000));
 	}
 
+	/**
+	 * @param ExtraModule $extraModule
+	 */
+	public function addExtraModule(ExtraModule $extraModule): void
+	{
+		$this->extraModules[] = $extraModule;
+	}
+
 	/**
 	 * @param Query $query
 	 * @param string $serviceName

src/Entity/EngineSingleResult.php

@@ -45,7 +45,32 @@ public function __construct(string $query, string $matchedRoute, ?Box $interpret
 	 */
 	public function getBoxes(): array
 	{
-		return $this->boxes;
+		$withoutNoResult = [];
+
+		foreach ($this->boxes as $box) {
+			if ($box->getTag() !== 'no-results') {
+				$withoutNoResult[] = $box;
+			}
+		}
+
+		$return = $withoutNoResult === [] ? $this->boxes : $withoutNoResult;
+
+		usort($return, static function (Box $a, Box $b): int {
+			return $a->getRank() < $b->getRank() ? 1 : -1;
+		});
+
+		return $return;
+	}
+
+	/**
+	 * @param Box $box
+	 * @return EngineSingleResult
+	 */
+	public function addBox(Box $box): self
+	{
+		$this->boxes[] = $box;
+
+		return $this;
 	}
 
 	/**
@@ -64,4 +89,15 @@ public function getSources(): array
 		return $this->sources;
 	}
 
+	/**
+	 * @param Source $source
+	 * @return EngineSingleResult
+	 */
+	public function addSource(Source $source): self
+	{
+		$this->sources[] = $source;
+
+		return $this;
+	}
+
 }

src/ExtraModule/BaseModule.php

@@ -0,0 +1,39 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mathematicator\Engine;
+
+
+abstract class BaseModule implements ExtraModule
+{
+
+	/**
+	 * @var EngineSingleResult
+	 */
+	protected $result;
+
+	/**
+	 * @var string
+	 */
+	protected $query;
+
+	/**
+	 * @internal
+	 * @param EngineSingleResult $result
+	 */
+	final public function setEngineSingleResult(EngineSingleResult $result): void
+	{
+		$this->result = $result;
+	}
+
+	/**
+	 * @internal
+	 * @param string $query
+	 */
+	final public function setQuery(string $query): void
+	{
+		$this->query = $query;
+	}
+
+}

src/ExtraModule/ExtraModule.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mathematicator\Engine;
+
+
+interface ExtraModule
+{
+
+	/**
+	 * @internal
+	 * @param EngineSingleResult $result
+	 */
+	public function setEngineSingleResult(EngineSingleResult $result): void;
+
+	/**
+	 * @param string $query
+	 * @return bool
+	 */
+	public function match(string $query): bool;
+
+	public function actionDefault(): void;
+
+}

src/ExtraModule/SampleModule.php

@@ -0,0 +1,31 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Mathematicator\Engine;
+
+
+use Mathematicator\Search\Box;
+
+final class SampleModule extends BaseModule
+{
+
+	/**
+	 * @param string $query
+	 * @return bool
+	 */
+	public function match(string $query): bool
+	{
+		return $query === 'help';
+	}
+
+	public function actionDefault(): void
+	{
+		$this->result->addBox(
+			(new Box(Box::TYPE_TEXT))
+				->setTitle('Help')
+				->setText('What can I help you with?')
+		);
+	}
+
+}