Add new BoundariesPager

src/Content/BoundariesPager.php

@@ -0,0 +1,135 @@
+<?php
+/**
+ * @copyright Copyright (C) 2020, Friendica
+ *
+ * @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\Renderer;
+use Friendica\DI;
+use Friendica\Util\Network;
+use Friendica\Util\Strings;
+
+/**
+ * This pager should be used by lists using the since_id/max_id parameters
+ *
+ * In this context, "id" refers to the value of the column that the list is ordered by.
+ * This pager automatically identifies if the sorting is done increasingly or decreasingly if the first item id
+ * and last item id are different. Otherwise it defaults to decreasingly like reverse chronological lists.
+ */
+class BoundariesPager extends Pager
+{
+	protected $first_item_id;
+	protected $last_item_id;
+	protected $first_page = true;
+
+	/**
+	 * Instantiates a new Pager with the base parameters.
+	 *
+	 * @param string  $queryString   The query string of the current page
+	 * @param string  $first_item_id The i
+	 * @param string  $last_item_id
+	 * @param integer $itemsPerPage An optional number of items per page to override the default value
+	 */
+	public function __construct($queryString, $first_item_id = null, $last_item_id = null, $itemsPerPage = 50)
+	{
+		parent::__construct($queryString, $itemsPerPage);
+
+		$this->first_item_id = $first_item_id;
+		$this->last_item_id = $last_item_id;
+
+		$parsed = parse_url($this->getBaseQueryString());
+		if ($parsed) {
+			parse_str($parsed['query'], $queryParameters);
+
+			$this->first_page = !($queryParameters['since_id'] ?? null) && !($queryParameters['max_id'] ?? null);
+
+			unset($queryParameters['since_id']);
+			unset($queryParameters['max_id']);
+
+			$parsed['query'] = http_build_query($queryParameters);
+
+			$url = Network::unparseURL($parsed);
+
+			$this->setQueryString($url);
+		}
+	}
+
+	public function getStart()
+	{
+		throw new \BadMethodCallException();
+	}
+
+	public function getPage()
+	{
+		throw new \BadMethodCallException();
+	}
+
+	/**
+	 * 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.
+	 *
+	 * Example usage:
+	 *
+	 * $params = ['order' => ['sort_field' => true], 'limit' => $itemsPerPage];
+	 * $items = DBA::toArray(DBA::select($table, $fields, $condition, $params));
+	 *
+	 * $pager = new BoundariesPager($a->query_string, $items[0]['sort_field'], $items[coutn($items) - 1]['sort_field'], $itemsPerPage);
+	 *
+	 * $html = $pager->renderMinimal(count($items));
+	 *
+	 * @param int $itemCount The number of displayed items on the page
+	 * @return string HTML string of the pager
+	 * @throws \Exception
+	 */
+	public function renderMinimal(int $itemCount)
+	{
+		$displayedItemCount = max(0, intval($itemCount));
+
+		$data = [
+			'class' => 'pager',
+			'prev'  => [
+				'url'   => Strings::ensureQueryParameter($this->baseQueryString .
+					($this->first_item_id >= $this->last_item_id ?
+						'&since_id=' . $this->first_item_id : '&max_id=' . $this->first_item_id)
+				),
+				'text'  => DI::l10n()->t('newer'),
+				'class' => 'previous' . ($this->first_page ? ' disabled' : '')
+			],
+			'next'  => [
+				'url'   => Strings::ensureQueryParameter($this->baseQueryString .
+					($this->first_item_id >= $this->last_item_id ?
+					'&max_id=' . $this->last_item_id : '&since_id=' . $this->last_item_id)
+				),
+				'text'  => DI::l10n()->t('older'),
+				'class' =>  'next' . ($displayedItemCount < $this->getItemsPerPage() ? ' disabled' : '')
+			]
+		];
+
+		$tpl = Renderer::getMarkupTemplate('paginate.tpl');
+		return Renderer::replaceMacros($tpl, ['pager' => $data]);
+	}
+
+	public function renderFull($itemCount)
+	{
+		throw new \BadMethodCallException();
+	}
+}

src/Content/Pager.php

@@ -37,12 +37,12 @@ class Pager
 	/**
 	 * @var integer
 	 */
-	private $itemsPerPage = 50;
+	protected $itemsPerPage = 50;
 
 	/**
 	 * @var string
 	 */
-	private $baseQueryString = '';
+	protected $baseQueryString = '';
 
 	/**
 	 * Instantiates a new Pager with the base parameters.
@@ -154,11 +154,11 @@ 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 \Friendica\Network\HTTPException\InternalServerErrorException
+	 * @throws \Exception
 	 */
-	public function renderMinimal($itemCount)
+	public function renderMinimal(int $itemCount)
 	{
 		$displayedItemCount = max(0, intval($itemCount));