mirror of
https://github.com/Icinga/icingadb-web.git
synced 2026-05-28 04:36:06 -04:00
3c8ed68cc6
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.
108 lines
2.2 KiB
PHP
108 lines
2.2 KiB
PHP
<?php
|
|
|
|
/* Icinga DB Web | (c) 2021 Icinga GmbH | GPLv2+ */
|
|
|
|
namespace Icinga\Module\Icingadb\Command\Object;
|
|
|
|
use ArrayIterator;
|
|
use Generator;
|
|
use Icinga\Module\Icingadb\Command\IcingaCommand;
|
|
use InvalidArgumentException;
|
|
use ipl\Orm\Model;
|
|
use Iterator;
|
|
use LogicException;
|
|
use Traversable;
|
|
|
|
/**
|
|
* Base class for commands that involve monitored objects, i.e. hosts or services
|
|
*/
|
|
abstract class ObjectsCommand extends IcingaCommand
|
|
{
|
|
/**
|
|
* Involved objects
|
|
*
|
|
* @var ?Iterator<Model>
|
|
*/
|
|
protected $objects;
|
|
|
|
/**
|
|
* How many objects to process at once
|
|
*
|
|
* @var ?int
|
|
*/
|
|
protected ?int $chunkSize = null;
|
|
|
|
/**
|
|
* Set the involved objects
|
|
*
|
|
* @param Iterator<Model> $objects Except generators
|
|
*
|
|
* @return $this
|
|
*
|
|
* @throws InvalidArgumentException If a generator is passed
|
|
*/
|
|
public function setObjects(Iterator $objects): self
|
|
{
|
|
if ($objects instanceof Generator) {
|
|
throw new InvalidArgumentException('Generators are not supported');
|
|
}
|
|
|
|
$this->objects = $objects;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set the involved object
|
|
*
|
|
* @param Model $object
|
|
*
|
|
* @return $this
|
|
*
|
|
* @deprecated Use setObjects() instead
|
|
*/
|
|
public function setObject(Model $object): self
|
|
{
|
|
return $this->setObjects(new ArrayIterator([$object]));
|
|
}
|
|
|
|
/**
|
|
* Get the involved objects
|
|
*
|
|
* @return Iterator
|
|
*/
|
|
public function getObjects(): Iterator
|
|
{
|
|
if ($this->objects === null) {
|
|
throw new LogicException(
|
|
'You are accessing an unset property. Please make sure to set it beforehand.'
|
|
);
|
|
}
|
|
|
|
return $this->objects;
|
|
}
|
|
|
|
/**
|
|
* Set how many objects to process at once
|
|
*
|
|
* @param ?int $chunkSize
|
|
*
|
|
* @return $this
|
|
*/
|
|
public function setChunkSize(?int $chunkSize): static
|
|
{
|
|
$this->chunkSize = $chunkSize;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Get how many objects to process at once
|
|
*
|
|
* @return ?int
|
|
*/
|
|
public function getChunkSize(): ?int
|
|
{
|
|
return $this->chunkSize;
|
|
}
|
|
}
|