Rework handling of iterator as result of database query

Author: bramley

README.md

@@ -49,6 +49,7 @@ For guidance on using the plugin see the plugin's page within the phplist docume
 ## Version history ##
 
     version         Description
+    3.34.0+20250202 Add methods to disable and enable a subscriber
     3.33.1+20240819 Make the legacy CommonPlugin_xxx classes aliases of the namespaced classes
     3.33.0+20240215 Add trait for listuser table
     3.32.1+20231226 Use an autoload function to load legacy classes instead of single class file

changelog.txt

@@ -1,3 +1,9 @@
+version 3.34.0+20250202
+      Avoid dynamic property
+      Update curl user agent
+      Add methods to disable and enable a subscriber
+      Rework handling of iterator as result of database query
+
 version 3.33.1+20240819
       Make the legacy CommonPlugin_xxx classes aliases of the namespaced classes
       CS Fixer

plugins/Common/CountableIterator.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace phpList\plugin\Common;
+
+/**
+ * CommonPlugin for phplist.
+ *
+ * This file is a part of CommonPlugin.
+ *
+ * @category  phplist
+ *
+ * @author    Duncan Cameron
+ * @copyright 2025 Duncan Cameron
+ * @license   http://www.gnu.org/licenses/gpl.html GNU General Public License, Version 3
+ */
+class CountableIterator extends \IteratorIterator implements \Countable
+{
+    private $count;
+
+    /**
+     * @param Iterator $iterator
+     * @param int      $count
+     */
+    public function __construct($iterator, $count)
+    {
+        parent::__construct($iterator);
+        $this->count = $count;
+    }
+
+    /**
+     * Implementation of Countable interface.
+     * Returns the number of rows in the result.
+     *
+     * @return int
+     */
+    #[\ReturnTypeWillChange]
+    public function count()
+    {
+        return $this->count;
+    }
+}

plugins/Common/DB.php

@@ -94,14 +94,16 @@ public function queryAffectedRows($sql)
      * @param string $sql       the query
      * @param string $keyColumn optional result column to use as the key
      *
-     * @return DBResultIterator iterator
+     * @return CountableIterator iterator
      */
     public function queryAll($sql, $keyColumn = null)
     {
         $resource = $this->_query($sql);
         $count = Sql_Num_Rows($resource);
 
-        return new DBResultIterator($resource, $count, $keyColumn);
+        return $keyColumn === null
+            ? new CountableIterator($resource, $count)
+            : new CountableIterator(new KeyedIterator($resource, $keyColumn), $count);
     }
 
     /**

plugins/Common/DBResultIterator.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace phpList\plugin\Common;
+
+/**
+ * CommonPlugin for phplist.
+ *
+ * This file is a part of CommonPlugin.
+ *
+ * @category  phplist
+ *
+ * @author    Duncan Cameron
+ * @copyright 2025 Duncan Cameron
+ * @license   http://www.gnu.org/licenses/gpl.html GNU General Public License, Version 3
+ */
+class KeyedIterator extends \IteratorIterator
+{
+    private $keyColumn;
+
+    /**
+     * @param Iterator $iterator
+     * @param string   $keyColumn
+     */
+    public function __construct($iterator, $keyColumn)
+    {
+        parent::__construct($iterator);
+        $this->keyColumn = $keyColumn;
+    }
+
+    /**
+     * Return the key as a column from the result.
+     *
+     * @return mixed
+     */
+    #[\ReturnTypeWillChange]
+    public function key()
+    {
+        return parent::current()[$this->keyColumn];
+    }
+}

plugins/Common/KeyedIterator.php

@@ -13,6 +13,7 @@
     'phpList\plugin\Common\Controller' => $pluginsDir . '/Common/Controller.php',
     'phpList\plugin\Common\ControllerFactory' => $pluginsDir . '/Common/ControllerFactory.php',
     'phpList\plugin\Common\ControllerFactoryBase' => $pluginsDir . '/Common/ControllerFactoryBase.php',
+    'phpList\plugin\Common\CountableIterator' => $pluginsDir . '/Common/CountableIterator.php',
     'phpList\plugin\Common\DAO' => $pluginsDir . '/Common/DAO.php',
     'phpList\plugin\Common\DAO\Attribute' => $pluginsDir . '/Common/DAO/Attribute.php',
     'phpList\plugin\Common\DAO\AttributeTrait' => $pluginsDir . '/Common/DAO/AttributeTrait.php',
@@ -27,7 +28,6 @@
     'phpList\plugin\Common\DAO\User' => $pluginsDir . '/Common/DAO/User.php',
     'phpList\plugin\Common\DAO\UserTrait' => $pluginsDir . '/Common/DAO/UserTrait.php',
     'phpList\plugin\Common\DB' => $pluginsDir . '/Common/DB.php',
-    'phpList\plugin\Common\DBResultIterator' => $pluginsDir . '/Common/DBResultIterator.php',
     'phpList\plugin\Common\DatabaseCache' => $pluginsDir . '/Common/DatabaseCache.php',
     'phpList\plugin\Common\Exception' => $pluginsDir . '/Common/Exception.php',
     'phpList\plugin\Common\ExportCSV' => $pluginsDir . '/Common/ExportCSV.php',
@@ -46,6 +46,7 @@
     'phpList\plugin\Common\IMailClient' => $pluginsDir . '/Common/IMailClient.php',
     'phpList\plugin\Common\IPopulator' => $pluginsDir . '/Common/IPopulator.php',
     'phpList\plugin\Common\ImageTag' => $pluginsDir . '/Common/ImageTag.php',
+    'phpList\plugin\Common\KeyedIterator' => $pluginsDir . '/Common/KeyedIterator.php',
     'phpList\plugin\Common\Listing' => $pluginsDir . '/Common/Listing.php',
     'phpList\plugin\Common\Logger' => $pluginsDir . '/Common/Logger.php',
     'phpList\plugin\Common\MailSender' => $pluginsDir . '/Common/MailSender.php',

plugins/CommonPlugin/class_map.php

@@ -1 +1 @@
-3.33.1+20240819
+3.34.0+20250202