mirror/processwire
1
0
Fork 0
mirror of https://github.com/processwire/processwire.git synced 2025-08-16 11:44:42 +02:00
Code Issues Releases Wiki Activity

Update PaginatedArray::getPaginationString() to allow specifying an alternate label (zeroLabel) when there are zero items available.

Browse Source
This commit is contained in:
Ryan Cramer
2019-02-21 09:57:42 -05:00
parent 0c150eec42
commit 65e283055a
1 changed files with 17 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
wire/core/PaginatedArray.php
View File

@@ -216,8 +216,16 @@ class PaginatedArray extends WireArray implements WirePaginatable {
* *
* This returns a string of `1 to 10 of 30` (items) or `1 of 10` (pages) for example. * This returns a string of `1 to 10 of 30` (items) or `1 of 10` (pages) for example.
* *
* You can optionally replace either of the arguments with an $options array instead. * Since 3.0.108 you can optionally replace either of the arguments with an $options o
* See the third example below for all options you can specify. (since 3.0.108) * array instead, and you can specify any of these options:
*
* - `label` (string): Label to use for items, same as $label argument (default='').
* - `zeroLabel` (string): Alternate label to use if there are zero items, since 3.0.127 (default='').
* - `usePageNum` (bool): Specify true to show page numbers rather than item numbers (default=false).
* - `count` (int): Use this count rather than count in this PaginatedArray (default=-1, disabled).
* - `start` (int): Use this start rather than start in this PaginatedArray (default=-1, disabled).
* - `limit` (int): Use this limit rather than limit in this PaginatedArray (default=-1, disabled).
* - `total` (int): Use this total rather than total in this PaginatedArray (default=-1, disabled).
* *
* ~~~~~ * ~~~~~
* // Get string like "Items 1 to 25 of 500" * // Get string like "Items 1 to 25 of 500"
@@ -229,6 +237,7 @@ class PaginatedArray extends WireArray implements WirePaginatable {
* // Get string where you specify all options * // Get string where you specify all options
* echo $items->getPaginationString(array( * echo $items->getPaginationString(array(
* 'label' => 'Items', * 'label' => 'Items',
* 'zeroLabel' => 'No items found', // 3.0.127+ only
* 'usePageNum' => false, * 'usePageNum' => false,
* 'count' => 10, * 'count' => 10,
* 'start' => 0, * 'start' => 0,
@@ -248,6 +257,7 @@ class PaginatedArray extends WireArray implements WirePaginatable {
$options = array( $options = array(
'label' => is_string($label) ? $label : '', 'label' => is_string($label) ? $label : '',
'zeroLabel' => '',
'usePageNum' => is_bool($usePageNum) ? $usePageNum : false, 'usePageNum' => is_bool($usePageNum) ? $usePageNum : false,
'count' => -1, 'count' => -1,
'start' => -1, 'start' => -1,
@@ -266,7 +276,11 @@ class PaginatedArray extends WireArray implements WirePaginatable {
$limit = $options['limit'] > -1 ? $options['limit'] : $this->getLimit(); $limit = $options['limit'] > -1 ? $options['limit'] : $this->getLimit();
$total = $options['total'] > -1 ? $options['total'] : $this->getTotal(); $total = $options['total'] > -1 ? $options['total'] : $this->getTotal();
if($usePageNum) { if(empty($total) && !empty($options['zeroLabel'])) {
$str = $options['zeroLabel'];
} else if($usePageNum) {
$pageNum = $start ? ($start / $limit) + 1 : 1; $pageNum = $start ? ($start / $limit) + 1 : 1;
$totalPages = ceil($total / $limit); $totalPages = ceil($total / $limit);