[3.0] change IndexableInterface and pass IndexInterface

UPGRADE-3.0.x.md

@@ -0,0 +1,21 @@
+# Upgrade to 3.0
+
+# CoreShop\Component\Index\Model\IndexableInterface Signature changed
+
+From
+
+```php
+    public function getIndexable();
+    public function getIndexableEnabled();
+    public function getIndexableName($language);
+```
+
+To
+
+```php
+    public function getIndexable(IndexInterface $index): bool
+    public function getIndexableEnabled(IndexInterface $index): bool
+    public function getIndexableName(IndexInterface $index, string $language): string
+```
+
+

src/CoreShop/Behat/Context/Domain/FilterContext.php

@@ -230,7 +230,7 @@ public function ifIQueryWithASimpleOrder(FilterInterface $filter, $orderKey, $or
                 continue;
             }
 
-            $result[] = $object->getIndexableName('en');
+            $result[] = $object->getIndexableName($filter->getIndex(), 'en');
         }
 
         Assert::eq([$firstResult, $secondResult], $result);

src/CoreShop/Behat/Model/Index/TestEnableIndex.php

@@ -15,6 +15,7 @@
 namespace CoreShop\Behat\Model\Index;
 
 use CoreShop\Component\Index\Model\IndexableInterface;
+use CoreShop\Component\Index\Model\IndexInterface;
 use CoreShop\Component\Resource\Exception\ImplementedByPimcoreException;
 use CoreShop\Component\Resource\Pimcore\Model\AbstractPimcoreModel;
 
@@ -23,40 +24,56 @@ class TestEnableIndex extends AbstractPimcoreModel implements IndexableInterface
     /**
      * {@inheritdoc}
      */
-    public function getIndexable()
+    public function getIndexable(IndexInterface $index): bool
     {
-        return $this->getIndexableEnabled() && $this->getPublished();
+        return $this->getIndexableEnabled($index) && $this->getPublished();
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getIndexableEnabled()
+    public function getIndexableEnabled(IndexInterface $index): bool
     {
-        return $this->getEnabled();
+        $enabled = $this->getEnabled();
+
+        if (is_bool($enabled)) {
+            return $enabled;
+        }
+
+        return false;
     }
 
+
     /**
      * {@inheritdoc}
      */
-    public function getEnabled()
+    public function getIndexableName(IndexInterface $index, string $language): string
     {
-        return new ImplementedByPimcoreException(__CLASS__, __METHOD__);
+        $name = $this->getName($language);
+
+        if (null === $name) {
+            return '';
+        }
+
+        if (!is_string($name)) {
+            return '';
+        }
+
+        return $name;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getName($language)
+    public function getEnabled()
     {
         return new ImplementedByPimcoreException(__CLASS__, __METHOD__);
     }
-
     /**
      * {@inheritdoc}
      */
-    public function getIndexableName($language)
+    public function getName($language)
     {
-        return $this->getName($language);
+        return new ImplementedByPimcoreException(__CLASS__, __METHOD__);
     }
 }

src/CoreShop/Behat/Model/Index/TestIndex.php

@@ -15,6 +15,7 @@
 namespace CoreShop\Behat\Model\Index;
 
 use CoreShop\Component\Index\Model\IndexableInterface;
+use CoreShop\Component\Index\Model\IndexInterface;
 use CoreShop\Component\Resource\Exception\ImplementedByPimcoreException;
 use CoreShop\Component\Resource\Pimcore\Model\AbstractPimcoreModel;
 
@@ -23,17 +24,23 @@ class TestIndex extends AbstractPimcoreModel implements IndexableInterface
     /**
      * {@inheritdoc}
      */
-    public function getIndexable()
+    public function getIndexable(IndexInterface $index): bool
     {
         return true;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getIndexableEnabled()
+    public function getIndexableEnabled(IndexInterface $index): bool
     {
-        return $this->getEnabled();
+        $enabled = $this->getEnabled();
+
+        if (!is_bool($enabled)) {
+            return false;
+        }
+
+        return $enabled;
     }
 
     /**
@@ -55,8 +62,14 @@ public function getName($language)
     /**
      * {@inheritdoc}
      */
-    public function getIndexableName($language)
+    public function getIndexableName(IndexInterface $index, string $language): string
     {
-        return $this->getName($language);
+        $name = $this->getName($language);
+
+        if (!is_string($name)) {
+            return '';
+        }
+
+        return $name;
     }
 }

src/CoreShop/Behat/Model/Index/TestIndexFields.php

@@ -15,6 +15,7 @@
 namespace CoreShop\Behat\Model\Index;
 
 use CoreShop\Component\Index\Model\IndexableInterface;
+use CoreShop\Component\Index\Model\IndexInterface;
 use CoreShop\Component\Resource\Exception\ImplementedByPimcoreException;
 use CoreShop\Component\Resource\Pimcore\Model\AbstractPimcoreModel;
 
@@ -23,17 +24,23 @@ class TestIndexFields extends AbstractPimcoreModel implements IndexableInterface
     /**
      * {@inheritdoc}
      */
-    public function getIndexable()
+    public function getIndexable(IndexInterface $index): bool
     {
         return true;
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getIndexableEnabled()
+    public function getIndexableEnabled(IndexInterface $index): bool
     {
-        return $this->getEnabled();
+        $enabled = $this->getEnabled();
+
+        if (!is_bool($enabled)) {
+            return false;
+        }
+
+        return $enabled;
     }
 
     /**
@@ -55,9 +62,15 @@ public function getName($language)
     /**
      * {@inheritdoc}
      */
-    public function getIndexableName($language)
+    public function getIndexableName(IndexInterface $index, string $language): string
     {
-        return $this->getName($language);
+        $name = $this->getName($language);
+
+        if (!is_string($name)) {
+            return '';
+        }
+
+        return $name;
     }
 
     /**

src/CoreShop/Bundle/IndexBundle/Worker/AbstractWorker.php

@@ -141,7 +141,7 @@ protected function prepareData(IndexInterface $index, IndexableInterface $object
         $extensions = $this->getExtensions($index);
 
         $virtualObjectId = $object->getId();
-        $virtualObjectActive = $object->getIndexableEnabled();
+        $virtualObjectActive = $object->getIndexableEnabled($index);
 
         if ($object->getType() === Concrete::OBJECT_TYPE_VARIANT) {
             /**
@@ -154,7 +154,7 @@ protected function prepareData(IndexInterface $index, IndexableInterface $object
             }
 
             $virtualObjectId = $parent->getId();
-            $virtualObjectActive = $object->getIndexableEnabled();
+            $virtualObjectActive = $object->getIndexableEnabled($index);
         }
 
         $data = [
@@ -173,7 +173,7 @@ protected function prepareData(IndexInterface $index, IndexableInterface $object
             }
         }
 
-        $data['active'] = $object->getIndexableEnabled();
+        $data['active'] = $object->getIndexableEnabled($index);
 
         if (!is_bool($data['active'])) {
             $data['active'] = false;
@@ -185,7 +185,7 @@ protected function prepareData(IndexInterface $index, IndexableInterface $object
         ];
 
         foreach (Tool::getValidLanguages() as $language) {
-            $localizedData['values'][$language]['name'] = $object->getIndexableName($language);
+            $localizedData['values'][$language]['name'] = $object->getIndexableName($index, $language);
         }
 
         $relationData = [];

src/CoreShop/Bundle/IndexBundle/Worker/MysqlWorker.php

@@ -349,7 +349,7 @@ public function deleteFromIndex(IndexInterface $index, IndexableInterface $objec
      */
     public function updateIndex(IndexInterface $index, IndexableInterface $object)
     {
-        $doIndex = $object->getIndexable();
+        $doIndex = $object->getIndexable($index);
 
         if ($doIndex) {
             $preparedData = $this->prepareData($index, $object);

src/CoreShop/Component/Core/Model/Product.php

@@ -14,6 +14,7 @@
 
 namespace CoreShop\Component\Core\Model;
 
+use CoreShop\Component\Index\Model\IndexInterface;
 use CoreShop\Component\Product\Model\Product as BaseProduct;
 use CoreShop\Component\Resource\Exception\ImplementedByPimcoreException;
 use CoreShop\Component\Store\Repository\StoreRepositoryInterface;
@@ -345,23 +346,23 @@ public function setStorePrice($storePrice, \CoreShop\Component\Store\Model\Store
     /**
      * {@inheritdoc}
      */
-    public function getIndexableEnabled()
+    public function getIndexableEnabled(IndexInterface $index): bool
     {
         return $this->getActive() && $this->getPublished();
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getIndexable()
+    public function getIndexable(IndexInterface $index): bool
     {
-        return $this->getIndexableEnabled();
+        return $this->getIndexableEnabled($index);
     }
 
     /**
      * {@inheritdoc}
      */
-    public function getIndexableName($language)
+    public function getIndexableName(IndexInterface $index, string $language): string
     {
         return $this->getName($language);
     }

src/CoreShop/Component/Index/Model/IndexableInterface.php

@@ -21,16 +21,6 @@ interface IndexableInterface
      */
     public function getId();
 
-    /**
-     * @return bool
-     */
-    public function getIndexableEnabled();
-
-    /**
-     * @return bool
-     */
-    public function getIndexable();
-
     /**
      * @return string
      */
@@ -51,15 +41,12 @@ public function getClassName();
      */
     public function getType();
 
-    /**
-     * @param string $language
-     *
-     * @return string
-     */
-    public function getIndexableName($language);
-
     /**
      * @return mixed
      */
     public function getParent();
+
+    public function getIndexableEnabled(IndexInterface $index): bool;
+    public function getIndexable(IndexInterface $index): bool;
+    public function getIndexableName(IndexInterface $index, string $language): string;
 }