Added description

[friendica.git] / src / BaseCollection.php

diff --git a/src/BaseCollection.php b/src/BaseCollection.php
index 5b35653fdd661c86a5d79d16ee3585429c7a81d9..0bf46f0dcb73d95d3639afe60f58a3a56ff85c54 100644 (file)
--- a/src/BaseCollection.php
+++ b/src/BaseCollection.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * @copyright Copyright (C) 2020, Friendica
+ * @copyright Copyright (C) 2010-2022, the Friendica project
  *
  * @license GNU AGPL version 3 or any later version
  *
@@ -22,12 +22,11 @@
 namespace Friendica;
 
 /**
- * The Collection classes inheriting from this abstract class are meant to represent a list of database record.
- * The associated model class has to be provided in the child classes.
+ * The Collection classes inheriting from this class are meant to represent a list of structured objects of a single type.
  *
  * Collections can be used with foreach(), accessed like an array and counted.
  */
-abstract class BaseCollection extends \ArrayIterator
+class BaseCollection extends \ArrayIterator
 {
        /**
         * This property is used with paginated results to hold the total number of items satisfying the paginated request.
@@ -88,7 +87,7 @@ abstract class BaseCollection extends \ArrayIterator
         */
        public function column($column, $index_key = null)
        {
-               return array_column($this->getArrayCopy(), $column, $index_key);
+               return array_column($this->getArrayCopy(true), $column, $index_key);
        }
 
        /**
@@ -115,4 +114,31 @@ abstract class BaseCollection extends \ArrayIterator
        {
                return new static(array_filter($this->getArrayCopy(), $callback, $flag));
        }
+
+       /**
+        * Reverse the orders of the elements in the collection
+        *
+        * @return $this
+        */
+       public function reverse(): BaseCollection
+       {
+               return new static(array_reverse($this->getArrayCopy()), $this->getTotalCount());
+       }
+
+       /**
+        * @inheritDoc
+        *
+        * includes recursion for entity::toArray() function
+        * @see BaseEntity::toArray()
+        */
+       public function getArrayCopy(bool $recursive = false): array
+       {
+               if (!$recursive) {
+                       return parent::getArrayCopy();
+               }
+
+               return array_map(function ($item) {
+                       return is_object($item) ? $item->toArray() : $item;
+               }, parent::getArrayCopy());
+       }
 }