Merge pull request #16 from Jeckel-Lab/feature/query-bus

Add interfaces for a Query Bus

src/Core/QueryDispatcher/Exception/InvalidQueryException.php

@@ -0,0 +1,22 @@
+<?php
+
+/**
+ * @author: Julien Mercier-Rojas <julien@jeckel-lab.fr>
+ * Created at: 08/11/2021
+ */
+
+declare(strict_types=1);
+
+namespace JeckelLab\Contract\Core\QueryDispatcher\Exception;
+
+use JeckelLab\Contract\Core\Exception\RuntimeException;
+
+/**
+ * Class InvalidQueryException
+ * @package JeckelLab\Contract\Core\QueryDispatcher\Exception
+ * @psalm-immutable
+ */
+class InvalidQueryException extends RuntimeException implements QueryDispatcherException
+{
+
+}

src/Core/QueryDispatcher/Exception/QueryDispatcherException.php

@@ -0,0 +1,20 @@
+<?php
+
+/**
+ * @author: Julien Mercier-Rojas <julien@jeckel-lab.fr>
+ * Created at: 08/11/2021
+ */
+
+declare(strict_types=1);
+
+namespace JeckelLab\Contract\Core\QueryDispatcher\Exception;
+
+use JeckelLab\Contract\Core\Exception\CoreException;
+
+/**
+ * @psalm-immutable
+ */
+interface QueryDispatcherException extends CoreException
+{
+
+}

src/Core/QueryDispatcher/Query/Query.php

@@ -0,0 +1,18 @@
+<?php
+
+/**
+ * @author: Julien Mercier-Rojas <julien@jeckel-lab.fr>
+ * Created at: 08/11/2021
+ */
+
+declare(strict_types=1);
+
+namespace JeckelLab\Contract\Core\QueryDispatcher\Query;
+
+/**
+ * @psalm-immutable
+ */
+interface Query
+{
+
+}

src/Core/QueryDispatcher/QueryBus/QueryBus.php

@@ -0,0 +1,20 @@
+<?php
+
+/**
+ * @author: Julien Mercier-Rojas <julien@jeckel-lab.fr>
+ * Created at: 08/11/2021
+ */
+
+namespace JeckelLab\Contract\Core\QueryDispatcher\QueryBus;
+
+use JeckelLab\Contract\Core\QueryDispatcher\Query\Query;
+use JeckelLab\Contract\Presentation\ViewModel\ViewModel;
+
+interface QueryBus
+{
+    /**
+     * @param Query $query
+     * @return ViewModel
+     */
+    public function dispatch(Query $query): ViewModel;
+}

src/Core/QueryDispatcher/QueryHandler/QueryHandler.php

@@ -0,0 +1,28 @@
+<?php
+
+/**
+ * @author: Julien Mercier-Rojas <julien@jeckel-lab.fr>
+ * Created at: 08/11/2021
+ */
+
+namespace JeckelLab\Contract\Core\QueryDispatcher\QueryHandler;
+
+use JeckelLab\Contract\Core\QueryDispatcher\Exception\InvalidQueryException;
+use JeckelLab\Contract\Core\QueryDispatcher\Query\Query;
+use JeckelLab\Contract\Presentation\ViewModel\ViewModel;
+
+interface QueryHandler
+{
+    /**
+     * @return array<class-string<Query>>
+     * @psalm-mutation-free
+     */
+    public static function getHandledQueries(): array;
+
+    /**
+     * @param Query $query
+     * @return ViewModel
+     * @throws InvalidQueryException
+     */
+    public function __invoke(Query $query): ViewModel;
+}