Implement Countable interface for all Listings (#6962)

* implement Countable interface for all Listings * implement Countable interface for all Listings * implement Countable interface for all Listings * implement Countable interface for all Listings * implement Countable interface for all Listings
pimcore · Aug 25, 2020 · 009a5aa · 009a5aa
1 parent 4182af0
commit 009a5aa
Show file tree

Hide file tree

Showing 38 changed files with 167 additions and 144 deletions.
diff --git a/bundles/EcommerceFrameworkBundle/CartManager/Cart/Listing/Dao.php b/bundles/EcommerceFrameworkBundle/CartManager/Cart/Listing/Dao.php
@@ -38,9 +38,11 @@ public function load()
 
     public function getTotalCount()
     {
-        $amount = $this->db->fetchRow('SELECT COUNT(*) as amount FROM `' . \Pimcore\Bundle\EcommerceFrameworkBundle\CartManager\Cart\Dao::TABLE_NAME . '`' . $this->getCondition());
-
-        return $amount['amount'];
+        try {
+            return (int) $this->db->fetchOne('SELECT COUNT(*) FROM `' . \Pimcore\Bundle\EcommerceFrameworkBundle\CartManager\Cart\Dao::TABLE_NAME . '`' . $this->getCondition());
+        } catch (\Exception $e) {
+            return 0;
+        }
     }
 
     public function setCartClass($cartClass)

diff --git a/bundles/EcommerceFrameworkBundle/CartManager/CartCheckoutData/Listing/Dao.php b/bundles/EcommerceFrameworkBundle/CartManager/CartCheckoutData/Listing/Dao.php
@@ -36,8 +36,10 @@ public function load()
 
     public function getTotalCount()
     {
-        $amount = $this->db->fetchRow('SELECT COUNT(*) as amount FROM `' . \Pimcore\Bundle\EcommerceFrameworkBundle\CartManager\CartCheckoutData\Dao::TABLE_NAME . '`' . $this->getCondition());
-
-        return $amount['amount'];
+        try {
+            return (int)$this->db->fetchOne('SELECT COUNT(*) FROM `' . \Pimcore\Bundle\EcommerceFrameworkBundle\CartManager\CartCheckoutData\Dao::TABLE_NAME . '`' . $this->getCondition());
+        } catch(\Exception $e) {
+            return 0;
+        }
     }
 }
diff --git a/bundles/EcommerceFrameworkBundle/CartManager/CartItem/Listing/Dao.php b/bundles/EcommerceFrameworkBundle/CartManager/CartItem/Listing/Dao.php
@@ -40,9 +40,11 @@ public function load()
 
     public function getTotalCount()
     {
-        $amount = $this->db->fetchRow('SELECT COUNT(*) as amount FROM `' . \Pimcore\Bundle\EcommerceFrameworkBundle\CartManager\CartItem\Dao::TABLE_NAME . '`' . $this->getCondition());
-
-        return $amount['amount'];
+        try {
+            return (int)$this->db->fetchOne('SELECT COUNT(*) FROM `' . \Pimcore\Bundle\EcommerceFrameworkBundle\CartManager\CartItem\Dao::TABLE_NAME . '`' . $this->getCondition());
+        } catch(\Exception $e) {
+            return 0;
+        }
     }
 
     public function getTotalAmount()

diff --git a/bundles/EcommerceFrameworkBundle/PricingManager/Rule/Listing/Dao.php b/bundles/EcommerceFrameworkBundle/PricingManager/Rule/Listing/Dao.php
@@ -55,4 +55,13 @@ public function getRuleClass()
     {
         return $this->ruleClass;
     }
+
+    public function getTotalCount()
+    {
+        try {
+            return (int) $this->db->fetchOne('SELECT COUNT(*) FROM `' . \Pimcore\Bundle\EcommerceFrameworkBundle\PricingManager\Rule\Dao::TABLE_NAME . '`' . $this->getCondition());
+        } catch (\Exception $e) {
+            return 0;
+        }
+    }
 }
diff --git a/bundles/EcommerceFrameworkBundle/VoucherService/Token/Listing/Dao.php b/bundles/EcommerceFrameworkBundle/VoucherService/Token/Listing/Dao.php
@@ -42,19 +42,20 @@ public function load()
         return $tokens;
     }
 
+    /**
+     * @return int
+     */
     public function getTotalCount()
     {
         try {
-            $amount = (int)$this->db->fetchOne(
+            return (int)$this->db->fetchOne(
                 'SELECT COUNT(*) as amount FROM ' .
                 \Pimcore\Bundle\EcommerceFrameworkBundle\VoucherService\Token\Dao::TABLE_NAME .
                 $this->getCondition(),
                 $this->model->getConditionVariables()
             );
         } catch (\Exception $e) {
-            return false;
+            return 0;
         }
-
-        return $amount;
     }
 }
diff --git a/lib/Model/Listing/AbstractListing.php b/lib/Model/Listing/AbstractListing.php
@@ -24,7 +24,7 @@
  *
  * @method \Pimcore\Db\ZendCompatibility\QueryBuilder getQuery()
  */
-abstract class AbstractListing extends AbstractModel implements \Iterator
+abstract class AbstractListing extends AbstractModel implements \Iterator, \Countable
 {
     /**
      * @var array
@@ -582,4 +582,17 @@ public function rewind()
         $this->getData();
         reset($this->data);
     }
+
+    /**
+     * @return int
+     */
+    public function count()
+    {
+        $dao = $this->getDao();
+        if(!\method_exists($dao, 'getTotalCount')) {
+            @trigger_error('Listings should implement Countable interface', E_USER_DEPRECATED);
+            return 0;
+        }
+        return $dao->getTotalCount();
+    }
 }
diff --git a/models/DataObject/ClassDefinition/CustomLayout/Listing/Dao.php b/models/DataObject/ClassDefinition/CustomLayout/Listing/Dao.php
@@ -45,18 +45,13 @@ public function load()
 
     /**
      * @return int
-     *
-     * @todo: $amount could not be defined, so this could cause an issue
      */
     public function getTotalCount()
     {
-        $amount = 0;
-
         try {
-            $amount = (int) $this->db->fetchOne('SELECT COUNT(*) as amount FROM custom_layouts ' . $this->getCondition(), $this->model->getConditionVariables());
+            return (int) $this->db->fetchOne('SELECT COUNT(*) FROM custom_layouts ' . $this->getCondition(), $this->model->getConditionVariables());
         } catch (\Exception $e) {
+            return 0;
         }
-
-        return $amount;
     }
 }
diff --git a/models/DataObject/ClassDefinition/Listing/Dao.php b/models/DataObject/ClassDefinition/Listing/Dao.php
@@ -51,13 +51,10 @@ public function load()
      */
     public function getTotalCount()
     {
-        $amount = 0;
-
         try {
-            $amount = (int) $this->db->fetchOne('SELECT COUNT(*) as amount FROM classes ' . $this->getCondition(), $this->model->getConditionVariables());
+            return (int) $this->db->fetchOne('SELECT COUNT(*) FROM classes ' . $this->getCondition(), $this->model->getConditionVariables());
         } catch (\Exception $e) {
+            return 0;
         }
-
-        return $amount;
     }
 }
diff --git a/models/DataObject/Classificationstore/CollectionConfig/Listing/Dao.php b/models/DataObject/Classificationstore/CollectionConfig/Listing/Dao.php
@@ -60,13 +60,10 @@ public function getDataArray()
      */
     public function getTotalCount()
     {
-        $amount = 0;
-
         try {
-            $amount = (int) $this->db->fetchOne('SELECT COUNT(*) as amount FROM ' . DataObject\Classificationstore\CollectionConfig\Dao::TABLE_NAME_COLLECTIONS . ' '. $this->getCondition(), $this->model->getConditionVariables());
+            return (int) $this->db->fetchOne('SELECT COUNT(*) FROM ' . DataObject\Classificationstore\CollectionConfig\Dao::TABLE_NAME_COLLECTIONS . ' '. $this->getCondition(), $this->model->getConditionVariables());
         } catch (\Exception $e) {
+            return 0;
         }
-
-        return $amount;
     }
 }
diff --git a/models/DataObject/Classificationstore/CollectionGroupRelation/Listing/Dao.php b/models/DataObject/Classificationstore/CollectionGroupRelation/Listing/Dao.php
@@ -76,13 +76,10 @@ public function getDataArray()
      */
     public function getTotalCount()
     {
-        $amount = 0;
-
         try {
-            $amount = (int) $this->db->fetchOne('SELECT COUNT(*) as amount FROM ' . DataObject\Classificationstore\CollectionGroupRelation\Dao::TABLE_NAME_RELATIONS . ' '. $this->getCondition(), $this->model->getConditionVariables());
+            return (int) $this->db->fetchOne('SELECT COUNT(*) FROM ' . DataObject\Classificationstore\CollectionGroupRelation\Dao::TABLE_NAME_RELATIONS . ' '. $this->getCondition(), $this->model->getConditionVariables());
         } catch (\Exception $e) {
+            return 0;
         }
-
-        return $amount;
     }
 }
diff --git a/models/DataObject/Classificationstore/GroupConfig/Listing/Dao.php b/models/DataObject/Classificationstore/GroupConfig/Listing/Dao.php
@@ -62,13 +62,10 @@ public function getDataArray()
      */
     public function getTotalCount()
     {
-        $amount = 0;
-
         try {
-            $amount = (int) $this->db->fetchOne('SELECT COUNT(*) as amount FROM ' . DataObject\Classificationstore\GroupConfig\Dao::TABLE_NAME_GROUPS . ' '. $this->getCondition(), $this->model->getConditionVariables());
+            return (int) $this->db->fetchOne('SELECT COUNT(*) FROM ' . DataObject\Classificationstore\GroupConfig\Dao::TABLE_NAME_GROUPS . ' '. $this->getCondition(), $this->model->getConditionVariables());
         } catch (\Exception $e) {
+            return 0;
         }
-
-        return $amount;
     }
 }
diff --git a/models/DataObject/Classificationstore/KeyConfig/Listing/Dao.php b/models/DataObject/Classificationstore/KeyConfig/Listing/Dao.php
@@ -62,14 +62,11 @@ public function getDataArray()
      */
     public function getTotalCount()
     {
-        $amount = 0;
-
         try {
-            $amount = (int) $this->db->fetchOne('SELECT COUNT(*) as amount FROM ' . DataObject\Classificationstore\KeyConfig\Dao::TABLE_NAME_KEYS . ' '. $this->getCondition(), $this->model->getConditionVariables());
+            return (int) $this->db->fetchOne('SELECT COUNT(*) FROM ' . DataObject\Classificationstore\KeyConfig\Dao::TABLE_NAME_KEYS . ' '. $this->getCondition(), $this->model->getConditionVariables());
         } catch (\Exception $e) {
+            return 0;
         }
-
-        return $amount;
     }
 
     /**

diff --git a/models/DataObject/Classificationstore/KeyGroupRelation/Listing/Dao.php b/models/DataObject/Classificationstore/KeyGroupRelation/Listing/Dao.php
@@ -95,13 +95,10 @@ public function getDataArray()
      */
     public function getTotalCount()
     {
-        $amount = 0;
-
         try {
-            $amount = (int) $this->db->fetchOne('SELECT COUNT(*) as amount FROM ' . DataObject\Classificationstore\KeyGroupRelation\Dao::TABLE_NAME_RELATIONS . ' '. $this->getCondition(), $this->model->getConditionVariables());
+            return (int) $this->db->fetchOne('SELECT COUNT(*) FROM ' . DataObject\Classificationstore\KeyGroupRelation\Dao::TABLE_NAME_RELATIONS . ' '. $this->getCondition(), $this->model->getConditionVariables());
         } catch (\Exception $e) {
+            return 0;
         }
-
-        return $amount;
     }
 }
diff --git a/models/DataObject/Classificationstore/StoreConfig/Listing/Dao.php b/models/DataObject/Classificationstore/StoreConfig/Listing/Dao.php
@@ -60,13 +60,10 @@ public function getDataArray()
      */
     public function getTotalCount()
     {
-        $amount = 0;
-
         try {
-            $amount = (int) $this->db->fetchOne('SELECT COUNT(*) as amount FROM ' . DataObject\Classificationstore\StoreConfig\Dao::TABLE_NAME_STORES . ' '. $this->getCondition(), $this->model->getConditionVariables());
+            return (int) $this->db->fetchOne('SELECT COUNT(*) FROM ' . DataObject\Classificationstore\StoreConfig\Dao::TABLE_NAME_STORES . ' '. $this->getCondition(), $this->model->getConditionVariables());
         } catch (\Exception $e) {
+            return 0;
         }
-
-        return $amount;
     }
 }
diff --git a/models/DataObject/QuantityValue/Unit/Listing/Dao.php b/models/DataObject/QuantityValue/Unit/Listing/Dao.php
@@ -47,12 +47,14 @@ public function load()
     }
 
     /**
-     * @return mixed
+     * @return int
      */
     public function getTotalCount()
     {
-        $amount = $this->db->fetchRow('SELECT COUNT(*) as amount FROM `' . DataObject\QuantityValue\Unit\Dao::TABLE_NAME . '`' . $this->getCondition());
-
-        return $amount['amount'];
+        try {
+            return (int) $this->db->fetchOne('SELECT COUNT(*) FROM '.DataObject\QuantityValue\Unit\Dao::TABLE_NAME.' ' . $this->getCondition(), $this->model->getConditionVariables());
+        } catch (\Exception $e) {
+            return 0;
+        }
     }
 }
diff --git a/models/Element/Note/Listing/Dao.php b/models/Element/Note/Listing/Dao.php
@@ -57,18 +57,13 @@ public function loadIdList()
 
     /**
      * @return int
-     *
-     * @todo: $amount could not be defined, so this could cause an issue
      */
     public function getTotalCount()
     {
-        $amount = 0;
-
         try {
-            $amount = (int) $this->db->fetchOne('SELECT COUNT(*) as amount FROM notes ' . $this->getCondition(), $this->model->getConditionVariables());
+            return (int) $this->db->fetchOne('SELECT COUNT(*) FROM notes ' . $this->getCondition(), $this->model->getConditionVariables());
         } catch (\Exception $e) {
+            return 0;
         }
-
-        return $amount;
     }
 }
diff --git a/models/Element/Recyclebin/Item/Listing/Dao.php b/models/Element/Recyclebin/Item/Listing/Dao.php
@@ -50,13 +50,10 @@ public function load()
      */
     public function getTotalCount()
     {
-        $amount = 0;
-
         try {
-            $amount = (int) $this->db->fetchOne('SELECT COUNT(*) as amount FROM recyclebin ' . $this->getCondition(), $this->model->getConditionVariables());
+            return (int) $this->db->fetchOne('SELECT COUNT(*) FROM recyclebin ' . $this->getCondition(), $this->model->getConditionVariables());
         } catch (\Exception $e) {
+            return 0;
         }
-
-        return $amount;
     }
 }
diff --git a/models/Element/Tag/Listing/Dao.php b/models/Element/Tag/Listing/Dao.php
@@ -57,18 +57,13 @@ public function loadIdList()
 
     /**
      * @return int
-     *
-     * @todo: $amount could not be defined, so this could cause an issue
      */
     public function getTotalCount()
     {
-        $amount = 0;
-
         try {
-            $amount = (int) $this->db->fetchOne('SELECT COUNT(*) as amount FROM tags ' . $this->getCondition(), $this->model->getConditionVariables());
+            return (int) $this->db->fetchOne('SELECT COUNT(*) FROM tags ' . $this->getCondition(), $this->model->getConditionVariables());
         } catch (\Exception $e) {
+            return 0;
         }
-
-        return $amount;
     }
 }
diff --git a/models/Element/WorkflowState/Listing/Dao.php b/models/Element/WorkflowState/Listing/Dao.php
@@ -50,13 +50,10 @@ public function load()
      */
     public function getTotalCount()
     {
-        $amount = 0;
-
         try {
-            $amount = (int) $this->db->fetchOne('SELECT COUNT(*) as amount FROM element_workflow_state ' . $this->getCondition(), $this->model->getConditionVariables());
+            return (int) $this->db->fetchOne('SELECT COUNT(*) FROM element_workflow_state ' . $this->getCondition(), $this->model->getConditionVariables());
         } catch (\Exception $e) {
+            return 0;
         }
-
-        return $amount;
     }
 }
diff --git a/models/Glossary/Listing/Dao.php b/models/Glossary/Listing/Dao.php
@@ -60,13 +60,10 @@ public function getDataArray()
      */
     public function getTotalCount()
     {
-        $amount = 0;
-
         try {
-            $amount = (int) $this->db->fetchOne('SELECT COUNT(*) as amount FROM glossary ' . $this->getCondition(), $this->model->getConditionVariables());
+            return (int) $this->db->fetchOne('SELECT COUNT(*) FROM glossary ' . $this->getCondition(), $this->model->getConditionVariables());
         } catch (\Exception $e) {
+            return 0;
         }
-
-        return $amount;
     }
 }
diff --git a/models/GridConfig/Listing/Dao.php b/models/GridConfig/Listing/Dao.php
@@ -50,13 +50,10 @@ public function load()
      */
     public function getTotalCount()
     {
-        $amount = 0;
-
         try {
-            $amount = (int) $this->db->fetchOne('SELECT COUNT(*) as amount FROM gridconfigs ' . $this->getCondition(), $this->model->getConditionVariables());
+            return (int) $this->db->fetchOne('SELECT COUNT(*) FROM gridconfigs ' . $this->getCondition(), $this->model->getConditionVariables());
         } catch (\Exception $e) {
+            return 0;
         }
-
-        return $amount;
     }
 }
diff --git a/models/GridConfigFavourite/Listing/Dao.php b/models/GridConfigFavourite/Listing/Dao.php
@@ -51,13 +51,10 @@ public function load()
      */
     public function getTotalCount()
     {
-        $amount = 0;
-
         try {
-            $amount = (int) $this->db->fetchOne('SELECT COUNT(*) as amount FROM gridconfig_favourites ' . $this->getCondition(), $this->model->getConditionVariables());
+            return (int) $this->db->fetchOne('SELECT COUNT(*) FROM gridconfig_favourites ' . $this->getCondition(), $this->model->getConditionVariables());
         } catch (\Exception $e) {
+            return 0;
         }
-
-        return $amount;
     }
 }