Patch marshaller

src/Association/Embedded.php

@@ -4,10 +4,12 @@
 namespace Cake\ElasticSearch\Association;
 
 use Cake\Core\App;
+use Cake\Datasource\FactoryLocator;
 use Cake\ElasticSearch\Document;
 use Cake\ElasticSearch\Exception\MissingDocumentException;
 use Cake\ElasticSearch\Index;
 use Cake\Utility\Inflector;
+use InvalidArgumentException;
 use function Cake\Core\deprecationWarning;
 
 /**
@@ -39,7 +41,7 @@
     protected string $alias;
 
     /**
-     * The class to use for the embeded document.
+     * The class to use for the embedded document.
      *
      * @var string
      */
@@ -59,6 +61,13 @@
      */
     protected string $indexClass;
 
+    /**
+     * Index instance this embed is linked to
+     *
+     * @var \Cake\ElasticSearch\Index|null
+     */
+    protected ?Index $index;
+
     /**
      * Constructor
      *
@@ -224,15 +233,28 @@
     /**
      * Set the index class used for this embed.
      *
-     * @param \Cake\ElasticSearch\Index|string|null $name The class name to set.
+     * @param \Cake\ElasticSearch\Index|string|null $className The class name to set.
      * @return $this
+     * @throws \InvalidArgumentException In case the class name is set after the target index has been
+     *  resolved, and it doesn't match the target index's class name.
      */
-    public function setIndexClass(string|Index|null $name)
+    public function setIndexClass(string|Index|null $className)
     {
-        if ($name instanceof Index) {
-            $this->indexClass = get_class($name);
-        } elseif (is_string($name)) {
-            $class = App::className($name, 'Model/Index');
+        if ($className instanceof Index) {
+            $this->index = $className;
+            $this->indexClass = get_class($className);
+        } elseif (is_string($className)) {
+            $class = App::className($className, 'Model/Index');
+            if (
+                isset($this->indexClass) &&
+                get_class($this->indexClass) !== $class
+            ) {
+                throw new InvalidArgumentException(sprintf(
+                    "The class name `%s` doesn't match the target index class name of `%s`.",
+                    $className,
+                    $this->index::class,
+                ));
+            }
             $this->indexClass = $class;
         }
 
@@ -261,6 +283,35 @@
         return $this->getIndexClass();
     }
 
+    /**
+     * Sets the index instance for the target side of the association.
+     *
+     * @param \Cake\ElasticSearch\Index $index the instance to be assigned as target side
+     * @return $this
+     */
+    public function setIndex(Index $index)
+    {
+        $this->index = $index;
+
+        return $this;
+    }
+
+    /**
+     * Gets the index instance for the target side of the association.
+     *
+     * @return \Cake\ElasticSearch\Index
+     */
+    public function getIndex(): Index
+    {
+        if (!isset($this->index)) {
+            /** @var \Cake\ElasticSearch\Index $index */
+            $index = FactoryLocator::get('Elastic')->get($this->getIndexClass());
+            $this->index = $index;
+        }
+
+        return $this->index;
+    }
+
     /**
      * Get the alias for this embed.
      *

src/Marshaller.php

@@ -1,3 +1,3 @@
 <?php
 declare(strict_types=1);
 
@@ -19,7 +19,6 @@
 use ArrayObject;
 use Cake\Collection\Collection;
 use Cake\Datasource\EntityInterface;
-use Cake\Datasource\FactoryLocator;
 use Cake\ElasticSearch\Association\Embedded;
 use RuntimeException;
 
@@ -52,45 +51,22 @@
      *
      * ### Options:
      *
-     * * fieldList: A whitelist of fields to be assigned to the entity. If not present,
+     * - fieldList: A whitelist of fields to be assigned to the entity. If not present,
      *   the accessible fields list in the entity will be used.
-     * * accessibleFields: A list of fields to allow or deny in entity accessible fields.
-     * * associated: A list of embedded documents you want to marshal.
+     * - accessibleFields: A list of fields to allow or deny in entity accessible fields.
+     * - associated: A list of embedded documents you want to marshal.
      *
-     * @param array $data The data to hydrate.
-     * @param array $options List of options
+     * @param array<string, mixed> $data The data to hydrate.
+     * @param array<string, mixed> $options List of options
      * @return \Cake\ElasticSearch\Document
      */
     public function one(array $data, array $options = []): Document
     {
-        $entityClass = $this->index->getEntityClass();
-        $entity = $this->createAndHydrate($entityClass, $data, $options);
-        $entity->setSource($this->index->getRegistryAlias());
-
-        return $entity;
-    }
-
-    /**
-     * Creates and Hydrates Document whilst honouring accessibleFields etc
-     *
-     * @param string $class      Class name of Document to create
-     * @param array  $data       The data to hydrate with
-     * @param array  $options    Options to control the hydration
-     * @param string $indexClass Index class to get embeds from (for nesting)
-     * @return \Cake\ElasticSearch\Document
-     */
-    protected function createAndHydrate(
-        string $class,
-        array $data,
-        array $options = [],
-        ?string $indexClass = null,
-    ): Document {
-        $entity = new $class();
-
         $options += ['associated' => []];
 
         [$data, $options] = $this->_prepareDataAndOptions($data, $options);
 
+        $entity = $this->index->newEmptyEntity();
         if (isset($options['accessibleFields'])) {
             foreach ((array)$options['accessibleFields'] as $key => $value) {
                 $entity->setAccess($key, $value);
@@ -102,13 +78,7 @@
             unset($data[$badKey]);
         }
 
-        if ($indexClass === null) {
-            $embeds = $this->index->embedded();
-        } else {
-            /** @var \Cake\ElasticSearch\Index $index */
-            $index = FactoryLocator::get('Elastic')->get($indexClass);
-            $embeds = $index->embedded();
-        }
+        $embeds = $this->index->embedded();
 
         foreach ($embeds as $embed) {
             $property = $embed->getProperty();
@@ -117,7 +87,7 @@
                 if (isset($options['associated'][$alias])) {
                     $entity->set($property, $this->newNested($embed, $data[$property], $options['associated'][$alias]));
                     unset($data[$property]);
-                } elseif (in_array($alias, $options['associated'])) {
+                } elseif (in_array($alias, $options['associated'], true)) {
                     $entity->set($property, $this->newNested($embed, $data[$property]));
                     unset($data[$property]);
                 }
@@ -134,7 +104,7 @@
             }
         }
 
         return $entity;
     }
 
     /**
@@ -147,39 +117,32 @@
      */
     protected function newNested(Embedded $embed, array $data, array $options = []): Document|array
     {
-        $class = $embed->getEntityClass();
+        $marshaller = $embed->getIndex()->marshaller();
         if ($embed->type() === Embedded::ONE_TO_ONE) {
-            return $this->createAndHydrate($class, $data, $options, $embed->getIndexClass());
-        } else {
-            $children = [];
-            foreach ($data as $row) {
-                if (is_array($row)) {
-                    $children[] = $this->createAndHydrate($class, $row, $options, $embed->getIndexClass());
-                }
-            }
-
-            return $children;
+            return $marshaller->one($data, $options);
         }
+
+        return $marshaller->many($data, $options);
     }
 
     /**
      * Merge an embedded document.
      *
      * @param \Cake\ElasticSearch\Association\Embedded $embed The embed definition.
-     * @param \Cake\ElasticSearch\Document|array $existing The existing entity or entities.
-     * @param array $data The data to marshal
+     * @param \Cake\ElasticSearch\Document|array|null $existing The existing entity or entities.
+     * @param array<string, mixed> $data The data to marshal
      * @return \Cake\ElasticSearch\Document|array Either a document or an array of documents.
      */
     protected function mergeNested(Embedded $embed, Document|array|null $existing, array $data): Document|array
     {
-        $class = $embed->getEntityClass();
+        $index = $embed->getIndex();
         if ($embed->type() === Embedded::ONE_TO_ONE) {
             if (!($existing instanceof EntityInterface)) {
-                $existing = new $class();
+                $existing = $index->newEmptyEntity();
             }
             $existing->set($data);
 
             return $existing;
         } else {
             if (!is_array($existing)) {
                 $existing = [];
@@ -192,7 +155,7 @@
             }
             foreach ($data as $row) {
                 if (is_array($row)) {
-                    $new = new $class();
+                    $new = $index->newEmptyEntity();
                     $new->set($row);
                     $existing[] = $new;
                 }
@@ -207,18 +170,21 @@
      *
      * ### Options:
      *
-     * * fieldList: A whitelist of fields to be assigned to the entity. If not present,
+     * - fieldList: A whitelist of fields to be assigned to the entity. If not present,
      *   the accessible fields list in the entity will be used.
-     * * accessibleFields: A list of fields to allow or deny in entity accessible fields.
+     * - accessibleFields: A list of fields to allow or deny in entity accessible fields.
      *
-     * @param array $data A list of entity data you want converted into objects.
-     * @param array $options Options
-     * @return array An array of hydrated entities
+     * @param array $data The data to hydrate.
+     * @param array<string, mixed> $options List of options
+     * @return array<\Cake\Datasource\EntityInterface> An array of hydrated records.
      */
     public function many(array $data, array $options = []): array
     {
         $output = [];
         foreach ($data as $record) {
+            if (!is_array($record)) {
+                continue;
+            }
             $output[] = $this->one($record, $options);
         }
 
@@ -230,21 +196,23 @@
      *
      * ### Options:
      *
-     * * fieldList: A whitelist of fields to be assigned to the entity. If not present
+     * - fieldList: A whitelist of fields to be assigned to the entity. If not present
      *   the accessible fields list in the entity will be used.
-     * * associated: A list of embedded documents you want to marshal.
+     * - associated: A list of embedded documents you want to marshal.
      *
      * @param \Cake\Datasource\EntityInterface $entity the entity that will get the
      * data merged in
      * @param array $data key value list of fields to be merged into the entity
-     * @param array $options List of options.
+     * @param array<string, mixed> $options List of options.
      * @return \Cake\Datasource\EntityInterface
      */
     public function merge(EntityInterface $entity, array $data, array $options = []): EntityInterface
     {
         $options += ['associated' => []];
         [$data, $options] = $this->_prepareDataAndOptions($data, $options);
-        $errors = $this->_validate($data, $options, $entity->isNew());
+
+        $isNew = $entity->isNew();
+        $errors = $this->_validate($data, $options, $isNew);
         $entity->setErrors($errors);
 
         foreach (array_keys($errors) as $badKey) {
@@ -253,7 +221,7 @@
 
         foreach ($this->index->embedded() as $embed) {
             $property = $embed->getProperty();
-            if (in_array($embed->getAlias(), $options['associated']) && isset($data[$property])) {
+            if (in_array($embed->getAlias(), $options['associated'], true) && isset($data[$property])) {
                 $data[$property] = $this->mergeNested($embed, $entity->{$property}, $data[$property]);
             }
         }
@@ -265,6 +233,7 @@
         }
 
         foreach ((array)$options['fieldList'] as $field) {
+            assert(is_string($field));
             if (array_key_exists($field, $data)) {
                 $entity->set($field, $data[$field]);
             }
@@ -274,9 +243,7 @@
     }
 
     /**
-     * Update a collection of entities.
-     *
-     * Merges each of the elements from `$data` into each of the entities in `$entities`.
+     * Merges each of the elements from `$data` into each of the entities in `$entities`
      *
      * Records in `$data` are matched against the entities using the id field.
      * Entries in `$entities` that cannot be matched to any record in
@@ -285,13 +252,14 @@
      *
      * ### Options:
      *
-     * * fieldList: A whitelist of fields to be assigned to the entity. If not present,
+     * - fieldList: An allowed list of fields to be assigned to the entity. If not present,
      *   the accessible fields list in the entity will be used.
      *
-     * @param iterable $entities An array of Elasticsearch entities
-     * @param array $data A list of entity data you want converted into objects.
-     * @param array $options Options
-     * @return array An array of merged entities
+     * @param iterable<\Cake\Datasource\EntityInterface> $entities the entities that will get the
+     *   data merged in
+     * @param array $data list of arrays to be merged into the entities
+     * @param array<string, mixed> $options List of options.
+     * @return array<\Cake\Datasource\EntityInterface>
      */
     public function mergeMany(iterable $entities, array $data, array $options = []): array
     {
@@ -306,22 +274,25 @@
 
         $new = $indexed[''] ?? [];
         unset($indexed['']);
-
         $output = [];
-        foreach ($entities as $record) {
-            if (!($record instanceof EntityInterface)) {
+
+        foreach ($entities as $entity) {
+            if (!($entity instanceof EntityInterface)) {
                 continue;
             }
-            $id = $record->id;
+
+            $id = $entity->id;
             if (!isset($indexed[$id])) {
                 continue;
             }
-            $output[] = $this->merge($record, $indexed[$id], $options);
+
+            $output[] = $this->merge($entity, $indexed[$id], $options);
             unset($indexed[$id]);
         }
+
         $new = array_merge($indexed, $new);
-        foreach ($new as $newRecord) {
-            $output[] = $this->one($newRecord, $options);
+        foreach ($new as $value) {
+            $output[] = $this->one($value, $options);
         }
 
         return $output;
@@ -360,8 +331,8 @@
     /**
      * Returns data and options prepared to validate and marshall.
      *
-     * @param array $data The data to prepare.
-     * @param array $options The options passed to this marshaller.
+     * @param array<string, mixed> $data The data to prepare.
+     * @param array<string, mixed> $options The options passed to this marshaller.
      * @return array An array containing prepared data and options.
      */
     protected function _prepareDataAndOptions(array $data, array $options): array