Merge pull request #11105 from annando/api-direct-messages

[friendica.git] / src / Object / Search / ResultList.php

diff --git a/src/Object/Search/ResultList.php b/src/Object/Search/ResultList.php
index 88caaa7e56ab409438dcf85e113dfff9c6266a0b..c6ddf22013ad9c2daade4b7a76f1cf90232be654 100644 (file)
--- a/src/Object/Search/ResultList.php
+++ b/src/Object/Search/ResultList.php
@@ -1,11 +1,30 @@
 <?php
+/**
+ * @copyright Copyright (C) 2010-2021, the Friendica project
+ *
+ * @license GNU AGPL version 3 or any later version
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as
+ * published by the Free Software Foundation, either version 3 of the
+ * License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ *
+ */
 
 namespace Friendica\Object\Search;
 
 use Friendica\Model\Search;
 
 /**
- * A list of search results with details
+ * A list of search results with metadata
  *
  * @see Search for details
  */
@@ -28,7 +47,8 @@ class ResultList
        private $itemsPage;
        /**
         * Array of results
-        * @var Result[]
+        *
+        * @var IResult[]
         */
        private $results;
 
@@ -57,7 +77,7 @@ class ResultList
        }
 
        /**
-        * @return Result[]
+        * @return IResult[]
         */
        public function getResults()
        {
@@ -65,10 +85,10 @@ class ResultList
        }
 
        /**
-        * @param int      $page
-        * @param int      $total
-        * @param int      $itemsPage
-        * @param Result[] $results
+        * @param int             $page
+        * @param int             $total
+        * @param int             $itemsPage
+        * @param IResult[] $results
         */
        public function __construct($page = 0, $total = 0, $itemsPage = 0, array $results = [])
        {
@@ -82,9 +102,9 @@ class ResultList
        /**
         * Adds a result to the result list
         *
-        * @param Result $result
+        * @param IResult $result
         */
-       public function addResult(Result $result)
+       public function addResult(IResult $result)
        {
                $this->results[] = $result;
        }