summaryrefslogtreecommitdiffstats
path: root/library/Icingadb/Command/Object/ObjectsCommand.php
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--library/Icingadb/Command/Object/ObjectsCommand.php67
1 files changed, 67 insertions, 0 deletions
diff --git a/library/Icingadb/Command/Object/ObjectsCommand.php b/library/Icingadb/Command/Object/ObjectsCommand.php
new file mode 100644
index 0000000..3de6c83
--- /dev/null
+++ b/library/Icingadb/Command/Object/ObjectsCommand.php
@@ -0,0 +1,67 @@
+<?php
+
+/* Icinga DB Web | (c) 2021 Icinga GmbH | GPLv2 */
+
+namespace Icinga\Module\Icingadb\Command\Object;
+
+use ArrayIterator;
+use Icinga\Module\Icingadb\Command\IcingaCommand;
+use ipl\Orm\Model;
+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
+ *
+ * @return $this
+ */
+ public function setObjects(Traversable $objects): self
+ {
+ $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;
+ }
+}