src/Object/Search/ResultList.php

   1 <?php
   2 /**
   3  * @copyright Copyright (C) 2010-2023, the Friendica project
   4  *
   5  * @license GNU AGPL version 3 or any later version
   6  *
   7  * This program is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU Affero General Public License as
   9  * published by the Free Software Foundation, either version 3 of the
  10  * License, or (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU Affero General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Affero General Public License
  18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  19  *
  20  */
  21
  22 namespace Friendica\Object\Search;
  23
  24 use Friendica\Model\Search;
  25
  26 /**
  27  * A list of search results with metadata
  28  *
  29  * @see Search for details
  30  */
  31 class ResultList
  32 {
  33         /**
  34          * Page of the result list
  35          * @var int
  36          */
  37         private $page;
  38         /**
  39          * Total count of results
  40          * @var int
  41          */
  42         private $total;
  43         /**
  44          * items per page
  45          * @var int
  46          */
  47         private $itemsPage;
  48         /**
  49          * Array of results
  50          *
  51          * @var IResult[]
  52          */
  53         private $results;
  54
  55         /**
  56          * @return int
  57          */
  58         public function getPage()
  59         {
  60                 return $this->page;
  61         }
  62
  63         /**
  64          * @return int
  65          */
  66         public function getTotal()
  67         {
  68                 return $this->total;
  69         }
  70
  71         /**
  72          * @return int
  73          */
  74         public function getItemsPage()
  75         {
  76                 return $this->itemsPage;
  77         }
  78
  79         /**
  80          * @return IResult[]
  81          */
  82         public function getResults()
  83         {
  84                 return $this->results;
  85         }
  86
  87         /**
  88          * @param int             $page
  89          * @param int             $total
  90          * @param int             $itemsPage
  91          * @param IResult[] $results
  92          */
  93         public function __construct($page = 0, $total = 0, $itemsPage = 0, array $results = [])
  94         {
  95                 $this->page      = $page;
  96                 $this->total     = $total;
  97                 $this->itemsPage = $itemsPage;
  98
  99                 $this->results = $results;
 100         }
 101
 102         /**
 103          * Adds a result to the result list
 104          *
 105          * @param IResult $result
 106          */
 107         public function addResult(IResult $result)
 108         {
 109                 $this->results[] = $result;
 110         }
 111 }