Add handling of named indices

Author: codeliner

src/DocumentStore.php

@@ -38,6 +38,7 @@ public function hasCollection(string $collectionName): bool;
     /**
      * @param string $collectionName
      * @param Index[] ...$indices
+     * @throws RuntimeException if adding did not succeed
      */
     public function addCollection(string $collectionName, Index ...$indices): void;
 
@@ -47,6 +48,22 @@ public function addCollection(string $collectionName, Index ...$indices): void;
      */
     public function dropCollection(string $collectionName): void;
 
+    public function hasCollectionIndex(string $collectionName, string $indexName): bool;
+
+    /**
+     * @param string $collectionName
+     * @param Index $index
+     * @throws RuntimeException if adding did not succeed
+     */
+    public function addCollectionIndex(string $collectionName, Index $index): void;
+
+    /**
+     * @param string $collectionName
+     * @param string $indexName
+     * @throws RuntimeException if dropping did not succeed
+     */
+    public function dropCollectionIndex(string $collectionName, string $indexName): void;
+
     /**
      * @param string $collectionName
      * @param string $docId

src/FieldIndex.php

@@ -28,6 +28,11 @@ final class FieldIndex implements Index
      */
     private $sort;
 
+    /**
+     * @var string|null
+     */
+    private $name;
+
     public static function forFieldInMultiFieldIndex(string $field): self
     {
         return self::forField($field);
@@ -38,19 +43,26 @@ public static function forField(string $field, int $sort = self::SORT_ASC, bool
         return new self($field, $sort, $unique);
     }
 
+    public static function namedIndexForField(string $idxName, string $field, int $sort = self::SORT_ASC, bool $unique = false): self
+    {
+        return new self($field, $sort, $unique, $idxName);
+    }
+
     public static function fromArray(array $data): Index
     {
         return new self(
             $data['field'] ?? '',
             $data['sort'] ?? self::SORT_ASC,
-            $data['unique'] ?? false
+            $data['unique'] ?? false,
+            $data['name'] ?? null
         );
     }
 
     private function __construct(
         string $field,
         int $sort,
-        bool $unique
+        bool $unique,
+        string $name = null
     ) {
         if (\mb_strlen($field) === 0) {
             throw new \InvalidArgumentException('Field must not be empty');
@@ -63,6 +75,7 @@ private function __construct(
         $this->field = $field;
         $this->sort = $sort;
         $this->unique = $unique;
+        $this->name = $name;
     }
 
     /**
@@ -89,12 +102,18 @@ public function unique(): bool
         return $this->unique;
     }
 
+    public function name(): ?string
+    {
+        return $this->name;
+    }
+
     public function toArray(): array
     {
         return [
             'field' => $this->field,
             'sort' => $this->sort,
             'unique' => $this->unique,
+            'name' => $this->name,
         ];
     }
 

src/InMemoryDocumentStore.php

@@ -81,6 +81,32 @@ public function dropCollection(string $collectionName): void
         }
     }
 
+    public function hasCollectionIndex(string $collectionName, string $indexName): bool
+    {
+        //InMemoryDocumentStore ignores indices
+        return false;
+    }
+
+    /**
+     * @param string $collectionName
+     * @param Index $index
+     * @throws RuntimeException if adding did not succeed
+     */
+    public function addCollectionIndex(string $collectionName, Index $index): void
+    {
+        //InMemoryDocumentStore ignores indices
+    }
+
+    /**
+     * @param string $collectionName
+     * @param string $indexName
+     * @throws RuntimeException if dropping did not succeed
+     */
+    public function dropCollectionIndex(string $collectionName, string $indexName): void
+    {
+        //InMemoryDocumentStore ignores indices
+    }
+
     /**
      * @param string $collectionName
      * @param string $docId

src/MultiFieldIndex.php

@@ -23,6 +23,11 @@ final class MultiFieldIndex implements Index
      */
     private $unique;
 
+    /**
+     * @var string|null
+     */
+    private $name;
+
     public static function forFields(array $fieldNames, bool $unique = false): self
     {
         return self::fromArray([
@@ -31,6 +36,15 @@ public static function forFields(array $fieldNames, bool $unique = false): self
         ]);
     }
 
+    public static function namedIndexForFields(string $idxName, array $fieldNames, bool $unique = false): self
+    {
+        return self::fromArray([
+            'name' => $idxName,
+            'fields' => $fieldNames,
+            'unique' => $unique,
+        ]);
+    }
+
     public static function fromArray(array $data): Index
     {
         $fields = \array_map(function (string $field): FieldIndex {
@@ -39,18 +53,20 @@ public static function fromArray(array $data): Index
 
         return new self(
             $data['unique'] ?? false,
+            $data['name'] ?? null,
             ...$fields
         );
     }
 
-    private function __construct(bool $unique, FieldIndex ...$fields)
+    private function __construct(bool $unique,string $name = null, FieldIndex ...$fields)
     {
         if (\count($fields) <= 1) {
             throw new \InvalidArgumentException('MultiFieldIndex should contain at least two fields');
         }
 
         $this->fields = $fields;
         $this->unique = $unique;
+        $this->name = $name;
     }
 
     /**
@@ -69,13 +85,19 @@ public function unique(): bool
         return $this->unique;
     }
 
+    public function name(): ?string
+    {
+        return $this->name;
+    }
+
     public function toArray(): array
     {
         return [
             'fields' => \array_map(function (FieldIndex $field): string {
                 return $field->field();
             }, $this->fields),
             'unique' => $this->unique,
+            'name' => $this->name,
         ];
     }