blob: f1a50d7ecf64b27ce2a7e4710fddc0f0315b037f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
|
<?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 LogicException;
use Traversable;
/**
* Base class for commands that involve monitored objects, i.e. hosts or services
*/
abstract class ObjectsCommand extends IcingaCommand
{
/**
* Involved objects
*
* @var Traversable<Model>
*/
protected $objects;
/**
* Set the involved objects
*
* @param Traversable<Model> $objects Except generators
*
* @return $this
*
* @throws InvalidArgumentException If a generator is passed
*/
public function setObjects(Traversable $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 Traversable
*/
public function getObjects(): Traversable
{
if ($this->objects === null) {
throw new LogicException(
'You are accessing an unset property. Please make sure to set it beforehand.'
);
}
return $this->objects;
}
}
|
