X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=src%2FContent%2FPager.php;h=bf5a5f691442032346a97ee0e9eda73efcb70375;hb=1239ce1e7e53298154ed9f1fa50c9dc8f6c02c98;hp=185c5506d9df57f2bfa0f6f70713120704d5ba8c;hpb=f1ebaf5e7d6b276c92c2fb436f5258596a6f0975;p=friendica.git

diff --git a/src/Content/Pager.php b/src/Content/Pager.php
index 185c5506d9..bf5a5f6914 100644
--- a/src/Content/Pager.php
+++ b/src/Content/Pager.php
@@ -1,49 +1,64 @@
 <?php
+/**
+ * @copyright Copyright (C) 2010-2022, 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\Content;
 
 use Friendica\Core\L10n;
+use Friendica\Core\Renderer;
+use Friendica\Util\Strings;
 
 /**
  * The Pager has two very different output, Minimal and Full, see renderMinimal() and renderFull() for more details.
- *
- * @author Hypolite Petovan <mrpetovan@gmail.com>
  */
 class Pager
 {
-	/**
-	 * @var integer
-	 */
+	/** @var int Default count of items per page */
+	const ITEMS_PER_PAGE = 50;
+
+	/** @var integer */
 	private $page = 1;
-	/**
-	 * @var integer
-	 */
-	private $itemsPerPage = 50;
-	/**
-	 * @var integer
-	 */
-	private $itemCount = 0;
+	/** @var integer */
+	protected $itemsPerPage = self::ITEMS_PER_PAGE;
+	/** @var string */
+	protected $baseQueryString = '';
 
-	/**
-	 * @var string
-	 */
-	private $baseQueryString = '';
+	/** @var L10n */
+	protected $l10n;
 
 	/**
 	 * Instantiates a new Pager with the base parameters.
 	 *
 	 * Guesses the page number from the GET parameter 'page'.
 	 *
+	 * @param L10n    $l10n
 	 * @param string  $queryString  The query string of the current page
-	 * @param integer $itemCount    The total item count (for the full mode) or null (for the minimal mode)
 	 * @param integer $itemsPerPage An optional number of items per page to override the default value
 	 */
-	public function __construct($queryString, $itemCount = null, $itemsPerPage = 50)
+	public function __construct(L10n $l10n, $queryString, $itemsPerPage = 50)
 	{
+		$this->l10n = $l10n;
+
 		$this->setQueryString($queryString);
 		$this->setItemsPerPage($itemsPerPage);
-		$this->setItemCount(defaults($itemCount, $this->getItemsPerPage()));
-		$this->setPage(defaults($_GET, 'page', 1));
+		$this->setPage(($_GET['page'] ?? 0) ?: 1);
 	}
 
 	/**
@@ -69,7 +84,7 @@ class Pager
 	/**
 	 * Returns the current page number
 	 *
-	 * @return type
+	 * @return int
 	 */
 	public function getPage()
 	{
@@ -80,14 +95,14 @@ class Pager
 	 * Returns the base query string.
 	 *
 	 * Warning: this isn't the same value as passed to the constructor.
-	 * See setQueryString for the inventory of transformations
+	 * See setQueryString() for the inventory of transformations
 	 *
 	 * @see setBaseQuery()
 	 * @return string
 	 */
 	public function getBaseQueryString()
 	{
-		return $this->baseQueryString;
+		return Strings::ensureQueryParameter($this->baseQueryString);
 	}
 
 	/**
@@ -110,20 +125,10 @@ class Pager
 		$this->page = max(1, intval($page));
 	}
 
-	/**
-	 * Sets the item count, 0 minimum.
-	 *
-	 * @param integer $itemCount
-	 */
-	public function setItemCount($itemCount)
-	{
-		$this->itemCount = max(0, intval($itemCount));
-	}
-
 	/**
 	 * Sets the base query string from a full query string.
 	 *
-	 * Strips the 'page' parameter, and remove the 'q=' string for some reason.
+	 * Strips the 'page' parameter
 	 *
 	 * @param string $queryString
 	 */
@@ -131,29 +136,13 @@ class Pager
 	{
 		$stripped = preg_replace('/([&?]page=[0-9]*)/', '', $queryString);
 
-		$stripped = str_replace('q=', '', $stripped);
 		$stripped = trim($stripped, '/');
 
 		$this->baseQueryString = $stripped;
 	}
 
 	/**
-	 * Ensures the provided URI has its query string punctuation in order.
-	 *
-	 * @param string $uri
-	 * @return string
-	 */
-	private function ensureQueryParameter($uri)
-	{
-		if (strpos($uri, '?') === false && ($pos = strpos($uri, '&')) !== false) {
-			$uri = substr($uri, 0, $pos) . '?' . substr($uri, $pos + 1);
-		}
-
-		return $uri;
-	}
-
-	/**
-	 * @brief Minimal pager (newer/older)
+	 * Minimal pager (newer/older)
 	 *
 	 * This mode is intended for reverse chronological pages and presents only two links, newer (previous) and older (next).
 	 * The itemCount is the number of displayed items. If no items are displayed, the older button is disabled.
@@ -167,33 +156,34 @@ class Pager
 	 *
 	 * $html = $pager->renderMinimal(count($items));
 	 *
-	 * @param integer $itemCount The number of displayed items on the page
+	 * @param int $itemCount The number of displayed items on the page
 	 * @return string HTML string of the pager
+	 * @throws \Exception
 	 */
-	public function renderMinimal($itemCount)
+	public function renderMinimal(int $itemCount)
 	{
-		$this->setItemCount($itemCount);
+		$displayedItemCount = max(0, intval($itemCount));
 
 		$data = [
 			'class' => 'pager',
 			'prev'  => [
-				'url'   => $this->ensureQueryParameter($this->baseQueryString . '&page=' . ($this->getPage() - 1)),
-				'text'  => L10n::t('newer'),
+				'url'   => Strings::ensureQueryParameter($this->baseQueryString . '&page=' . ($this->getPage() - 1)),
+				'text'  => $this->l10n->t('newer'),
 				'class' => 'previous' . ($this->getPage() == 1 ? ' disabled' : '')
 			],
 			'next'  => [
-				'url'   => $this->ensureQueryParameter($this->baseQueryString . '&page=' . ($this->getPage() + 1)),
-				'text'  => L10n::t('older'),
-				'class' =>  'next' . ($this->itemCount <= 0 ? ' disabled' : '')
+				'url'   => Strings::ensureQueryParameter($this->baseQueryString . '&page=' . ($this->getPage() + 1)),
+				'text'  => $this->l10n->t('older'),
+				'class' =>  'next' . ($displayedItemCount < $this->getItemsPerPage() ? ' disabled' : '')
 			]
 		];
 
-		$tpl = get_markup_template('paginate.tpl');
-		return replace_macros($tpl, ['pager' => $data]);
+		$tpl = Renderer::getMarkupTemplate('paginate.tpl');
+		return Renderer::replaceMacros($tpl, ['pager' => $data]);
 	}
 
 	/**
-	 * @brief Full pager (first / prev / 1 / 2 / ... / 14 / 15 / next / last)
+	 * Full pager (first / prev / 1 / 2 / ... / 14 / 15 / next / last)
 	 *
 	 * This mode presents page numbers as well as first, previous, next and last links.
 	 * The itemCount is the total number of items including those not displayed.
@@ -209,26 +199,30 @@ class Pager
 	 *
 	 * $html = $pager->renderFull();
 	 *
+	 * @param integer $itemCount The total number of items including those note displayed on the page
 	 * @return string HTML string of the pager
+	 * @throws \Friendica\Network\HTTPException\InternalServerErrorException
 	 */
-	public function renderFull()
+	public function renderFull($itemCount)
 	{
+		$totalItemCount = max(0, intval($itemCount));
+
 		$data = [];
 
 		$data['class'] = 'pagination';
-		if ($this->itemCount > $this->getItemsPerPage()) {
+		if ($totalItemCount > $this->getItemsPerPage()) {
 			$data['first'] = [
-				'url'   => $this->ensureQueryParameter($this->baseQueryString . '&page=1'),
-				'text'  => L10n::t('first'),
+				'url'   => Strings::ensureQueryParameter($this->baseQueryString . '&page=1'),
+				'text'  => $this->l10n->t('first'),
 				'class' => $this->getPage() == 1 ? 'disabled' : ''
 			];
 			$data['prev'] = [
-				'url'   => $this->ensureQueryParameter($this->baseQueryString . '&page=' . ($this->getPage() - 1)),
-				'text'  => L10n::t('prev'),
+				'url'   => Strings::ensureQueryParameter($this->baseQueryString . '&page=' . ($this->getPage() - 1)),
+				'text'  => $this->l10n->t('prev'),
 				'class' => $this->getPage() == 1 ? 'disabled' : ''
 			];
 
-			$numpages = $this->itemCount / $this->getItemsPerPage();
+			$numpages = $totalItemCount / $this->getItemsPerPage();
 
 			$numstart = 1;
 			$numstop = $numpages;
@@ -250,14 +244,14 @@ class Pager
 					];
 				} else {
 					$pages[$i] = [
-						'url'   => $this->ensureQueryParameter($this->baseQueryString . '&page=' . $i),
+						'url'   => Strings::ensureQueryParameter($this->baseQueryString . '&page=' . $i),
 						'text'  => $i,
 						'class' => 'n'
 					];
 				}
 			}
 
-			if (($this->itemCount % $this->getItemsPerPage()) != 0) {
+			if (($totalItemCount % $this->getItemsPerPage()) != 0) {
 				if ($i == $this->getPage()) {
 					$pages[$i] = [
 						'url'   => '#',
@@ -266,7 +260,7 @@ class Pager
 					];
 				} else {
 					$pages[$i] = [
-						'url'   => $this->ensureQueryParameter($this->baseQueryString . '&page=' . $i),
+						'url'   => Strings::ensureQueryParameter($this->baseQueryString . '&page=' . $i),
 						'text'  => $i,
 						'class' => 'n'
 					];
@@ -278,18 +272,18 @@ class Pager
 			$lastpage = (($numpages > intval($numpages)) ? intval($numpages)+1 : $numpages);
 
 			$data['next'] = [
-				'url'   => $this->ensureQueryParameter($this->baseQueryString . '&page=' . ($this->getPage() + 1)),
-				'text'  => L10n::t('next'),
+				'url'   => Strings::ensureQueryParameter($this->baseQueryString . '&page=' . ($this->getPage() + 1)),
+				'text'  => $this->l10n->t('next'),
 				'class' => $this->getPage() == $lastpage ? 'disabled' : ''
 			];
 			$data['last'] = [
-				'url'   => $this->ensureQueryParameter($this->baseQueryString . '&page=' . $lastpage),
-				'text'  => L10n::t('last'),
+				'url'   => Strings::ensureQueryParameter($this->baseQueryString . '&page=' . $lastpage),
+				'text'  => $this->l10n->t('last'),
 				'class' => $this->getPage() == $lastpage ? 'disabled' : ''
 			];
 		}
 
-		$tpl = get_markup_template('paginate.tpl');
-		return replace_macros($tpl, ['pager' => $data]);
+		$tpl = Renderer::getMarkupTemplate('paginate.tpl');
+		return Renderer::replaceMacros($tpl, ['pager' => $data]);
 	}
 }