Add Ontology

composer.json

@@ -22,8 +22,10 @@
  "phpunit/phpunit": "~9.0",
  "mockery/mockery": "^1.4",
  "infection/infection": "^0.26",
- "symplify/easy-coding-standard": "^9.0"
+ "symplify/easy-coding-standard": "^9.0",
+ "jeroen-g/ontology": "*"
  },
+ "minimum-stability": "dev",
  "autoload": {
  "psr-4": {
  "JeroenG\\Explorer\\": "src/"
@@ -40,5 +42,14 @@
  "JeroenG\\Explorer\\ExplorerServiceProvider"
  ]
  }
+ },
+ "repositories": {
+ "jeroen-g/ontology": {
+ "type": "path",
+ "url": "/Users/jgroenendijk/Sites/projects/packagertest/packages/JeroenG/Ontology",
+ "options": {
+ "symlink": true
+ }
+ }
  }
 }

docs/bibliography.md

@@ -0,0 +1,62 @@
+# Bibliography
+
+### JeroenG\Explorer\Domain\Syntax\DisjunctionMax
+- [Official documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-dis-max-query.html)
+
+
+### JeroenG\Explorer\Domain\Syntax\Exists
+- [Official documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html)
+
+
+### JeroenG\Explorer\Domain\Syntax\Invert
+- [Official documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html)
+
+
+### JeroenG\Explorer\Domain\Syntax\MatchAll
+- [Official documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html)
+
+
+### JeroenG\Explorer\Domain\Syntax\MatchPhrase
+- [Official documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase.html)
+
+
+### JeroenG\Explorer\Domain\Syntax\Matching
+- [Official documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html)
+
+
+### JeroenG\Explorer\Domain\Syntax\MultiMatch
+- [Official documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html)
+
+
+### JeroenG\Explorer\Domain\Syntax\Nested
+- [Official documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html)
+
+
+### JeroenG\Explorer\Domain\Syntax\QueryString
+- [Official documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html)
+
+
+### JeroenG\Explorer\Domain\Syntax\Range
+- [Official documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html)
+
+
+### JeroenG\Explorer\Domain\Syntax\SimpleQueryString
+- [Official documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html)
+
+
+### JeroenG\Explorer\Domain\Syntax\Sort
+- [Official documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html)
+
+
+### JeroenG\Explorer\Domain\Syntax\Term
+- [Official documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html)
+
+
+### JeroenG\Explorer\Domain\Syntax\Terms
+- [Official documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html)
+
+
+### JeroenG\Explorer\Domain\Syntax\Wildcard
+- [Official documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html)
+
+

docs/index.md

@@ -24,6 +24,7 @@ Also do not forget to follow the [installation instructions for Laravel Scout](h
 # Explorer documentation
 
 - [Quickstart](quickstart.md)
+- [Bibliography](bibliography.md)
 - [Mapping properties in Elasticsearch](mapping.md)
 - [Sorting search results](sorting.md)
 - [Pagination and search result size](pagination.md)

ontology.php

@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+use JeroenG\Ontology\Application\ConfigurationConfigurator;
+
+return static function (ConfigurationConfigurator $configurator): ConfigurationConfigurator {
+ return $configurator
+ ->setDomainLayers(['Domain'])
+ ->setApplicationLayers(['Application'])
+ ->setInfrastructureLayers(['Infrastructure'])
+ ->setGenerators([
+ JeroenG\Ontology\Domain\Generators\Bibliography::class,
+ ])
+ ->setValidators([
+ JeroenG\Ontology\Domain\Validators\Hexagonal\Repository::class,
+ JeroenG\Ontology\Domain\Validators\ValueObject\Immutable::class,
+ ])
+ ;
+};

src/Domain/Syntax/DisjunctionMax.php

@@ -4,6 +4,9 @@
 
 namespace JeroenG\Explorer\Domain\Syntax;
 
+use JeroenG\Ontology\Domain\Attributes as DDD;
+
+#[DDD\Www('Official documentation', 'https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-dis-max-query.html')]
 class DisjunctionMax implements SyntaxInterface
 {
  /** @var SyntaxInterface[] */

src/Domain/Syntax/Exists.php

@@ -4,6 +4,9 @@
 
 namespace JeroenG\Explorer\Domain\Syntax;
 
+use JeroenG\Ontology\Domain\Attributes as DDD;
+
+#[DDD\Www('Official documentation', 'https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-exists-query.html')]
 class Exists implements SyntaxInterface
 {
  private string $field;

src/Domain/Syntax/Invert.php

@@ -4,6 +4,9 @@
 
 namespace JeroenG\Explorer\Domain\Syntax;
 
+use JeroenG\Ontology\Domain\Attributes as DDD;
+
+#[DDD\Www('Official documentation', 'https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-bool-query.html')]
 class Invert implements SyntaxInterface
 {
  private SyntaxInterface $query;

src/Domain/Syntax/MatchAll.php

@@ -4,6 +4,9 @@
 
 namespace JeroenG\Explorer\Domain\Syntax;
 
+use JeroenG\Ontology\Domain\Attributes as DDD;
+
+#[DDD\Www('Official documentation', 'https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-all-query.html')]
 class MatchAll implements SyntaxInterface
 {
  public function build(): array

src/Domain/Syntax/MatchPhrase.php

@@ -4,6 +4,9 @@
 
 namespace JeroenG\Explorer\Domain\Syntax;
 
+use JeroenG\Ontology\Domain\Attributes as DDD;
+
+#[DDD\Www('Official documentation', 'https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query-phrase.html')]
 class MatchPhrase implements SyntaxInterface
 {
  private string $field;

src/Domain/Syntax/Matching.php

@@ -4,6 +4,9 @@
 
 namespace JeroenG\Explorer\Domain\Syntax;
 
+use JeroenG\Ontology\Domain\Attributes as DDD;
+
+#[DDD\Www('Official documentation', 'https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-match-query.html')]
 class Matching implements SyntaxInterface
 {
  private string $field;

src/Domain/Syntax/MultiMatch.php

@@ -4,6 +4,9 @@
 
 namespace JeroenG\Explorer\Domain\Syntax;
 
+use JeroenG\Ontology\Domain\Attributes as DDD;
+
+#[DDD\Www('Official documentation', 'https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-multi-match-query.html')]
 class MultiMatch implements SyntaxInterface
 {
  private mixed $value;

src/Domain/Syntax/Nested.php

@@ -5,6 +5,9 @@
 
 namespace JeroenG\Explorer\Domain\Syntax;
 
+use JeroenG\Ontology\Domain\Attributes as DDD;
+
+#[DDD\Www('Official documentation', 'https://www.elastic.co/guide/en/elasticsearch/reference/current/nested.html')]
 class Nested implements SyntaxInterface
 {
  private string $path;

src/Domain/Syntax/QueryString.php

@@ -6,7 +6,9 @@
 namespace JeroenG\Explorer\Domain\Syntax;
 
 use Webmozart\Assert\Assert;
+use JeroenG\Ontology\Domain\Attributes as DDD;
 
+#[DDD\Www('Official documentation', 'https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-query-string-query.html')]
 class QueryString implements SyntaxInterface
 {
  public const OP_AND = 'AND';

src/Domain/Syntax/Range.php

@@ -5,7 +5,9 @@
 namespace JeroenG\Explorer\Domain\Syntax;
 
 use Webmozart\Assert\Assert;
+use JeroenG\Ontology\Domain\Attributes as DDD;
 
+#[DDD\Www('Official documentation', 'https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-range-query.html')]
 class Range implements SyntaxInterface
 {
  public const RELATIONS = ['gt', 'gte', 'lt', 'lte'];

src/Domain/Syntax/SimpleQueryString.php

@@ -5,6 +5,9 @@
 
 namespace JeroenG\Explorer\Domain\Syntax;
 
+use JeroenG\Ontology\Domain\Attributes as DDD;
+
+#[DDD\Www('Official documentation', 'https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-simple-query-string-query.html')]
 class SimpleQueryString extends QueryString
 {
  public function build(): array

src/Domain/Syntax/Sort.php

@@ -5,7 +5,9 @@
 namespace JeroenG\Explorer\Domain\Syntax;
 
 use Webmozart\Assert\Assert;
+use JeroenG\Ontology\Domain\Attributes as DDD;
 
+#[DDD\Www('Official documentation', 'https://www.elastic.co/guide/en/elasticsearch/reference/current/sort-search-results.html')]
 class Sort implements SyntaxInterface
 {
  public const ASCENDING = 'asc';

src/Domain/Syntax/Term.php

@@ -4,10 +4,13 @@
 
 namespace JeroenG\Explorer\Domain\Syntax;
 
+use JeroenG\Ontology\Domain\Attributes as DDD;
+
+#[DDD\Www('Official documentation', 'https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-term-query.html')]
 class Term implements SyntaxInterface
 {
  private string $field;
- 
+
  private mixed $value;
 
  private ?float $boost;

src/Domain/Syntax/Terms.php

@@ -5,7 +5,9 @@
 namespace JeroenG\Explorer\Domain\Syntax;
 
 use Webmozart\Assert\Assert;
+use JeroenG\Ontology\Domain\Attributes as DDD;
 
+#[DDD\Www('Official documentation', 'https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-terms-query.html')]
 class Terms implements SyntaxInterface
 {
  private string $field;

src/Domain/Syntax/Wildcard.php

@@ -4,6 +4,9 @@
 
 namespace JeroenG\Explorer\Domain\Syntax;
 
+use JeroenG\Ontology\Domain\Attributes as DDD;
+
+#[DDD\Www('Official documentation', 'https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-wildcard-query.html')]
 class Wildcard implements SyntaxInterface
 {
  private string $field;