icingadb-web/library/Icingadb/Common/LoadMore.php
Alexander A. Klimov 3c8ed68cc6 Upgrade license from GPLv2 to GPLv2+
This was easy because only README.md and doc/01-About.md were redacted manually, everything else via:
git ls-files -z |xargs -0 perl -pi -e 's/Icinga GmbH \| GPLv2/Icinga GmbH | GPLv2+/'

This is legal because we have only merged PRs with label:cla/signed or made by Icinga staff:
https://github.com/Icinga/icingadb-web/pulls?page=1&q=is%3Apr+is%3Aclosed+-label%3Acla%2Fsigned+-author%3Anilmerg

This has no risk for us in people distributing their own version under GPLv3 only.
After all, we won't take their patches anyway, unless they sign our CLA.

This is the cleanest solution for having e.g. these in one address space:

* Icinga Web, GPLv2+
* K8s Web, AGPLv3
* Thirdparty, some LGPLv3 and Apache-2.0

Apropos, K8s Web is even v3-licensed on purpose, to have a stronger protection against cloud ops.
2025-11-21 13:31:24 +01:00

111 lines
2.4 KiB
PHP

<?php
/* Icinga DB Web | (c) 2021 Icinga GmbH | GPLv2+ */
namespace Icinga\Module\Icingadb\Common;
use Generator;
use Icinga\Module\Icingadb\Widget\ItemList\PageSeparatorItem;
use Icinga\Module\Icingadb\Widget\ShowMore;
use ipl\Orm\ResultSet;
use ipl\Web\Url;
trait LoadMore
{
/** @var int */
protected $pageSize;
/** @var int */
protected $pageNumber;
/** @var Url */
protected $loadMoreUrl;
/**
* Set the page size
*
* @param int $size
*
* @return $this
*/
public function setPageSize(int $size): self
{
$this->pageSize = $size;
return $this;
}
/**
* Set the page number
*
* @param int $number
*
* @return $this
*/
public function setPageNumber(int $number): self
{
$this->pageNumber = $number;
return $this;
}
/**
* Set the url to fetch more items
*
* @param Url $url
*
* @return $this
*/
public function setLoadMoreUrl(Url $url): self
{
$this->loadMoreUrl = $url;
return $this;
}
/**
* Iterate over the given data
*
* Add the page separator and the "LoadMore" button at the desired position
*
* @param ResultSet $result
*
* @return Generator
*/
protected function getIterator(ResultSet $result): Generator
{
$count = 0;
$pageNumber = $this->pageNumber ?: 1;
if ($pageNumber > 1) {
$this->add(new PageSeparatorItem($pageNumber));
}
foreach ($result as $data) {
$count++;
if ($count % $this->pageSize === 0) {
$pageNumber++;
} elseif ($count > $this->pageSize && $count % $this->pageSize === 1) {
$this->add(new PageSeparatorItem($pageNumber));
}
yield $data;
}
if ($count > 0 && $this->loadMoreUrl !== null) {
$showMore = (new ShowMore(
$result,
$this->loadMoreUrl->setParam('page', $pageNumber)
->setAnchor('page-' . ($pageNumber))
))
->setLabel(t('Load More'))
->setAttributes([
'class' => 'load-more',
'data-no-icinga-ajax' => true
]);
$this->add($showMore->setTag('li')->addAttributes(['class' => 'list-item']));
}
}
}