summaryrefslogtreecommitdiffstats
path: root/library/Icingadb/Command/Object/ObjectCommand.php
blob: 7dae79976862d3ddc15b099d57c652ec8b0e7099 (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
<?php

/* Icinga DB Web | (c) 2021 Icinga GmbH | GPLv2 */

namespace Icinga\Module\Icingadb\Command\Object;

use Icinga\Module\Icingadb\Command\IcingaCommand;
use ipl\Orm\Model;

/**
 * Base class for commands that involve a monitored object, i.e. a host or service
 */
abstract class ObjectCommand extends IcingaCommand
{
    /**
     * Involved object
     *
     * @var Model
     */
    protected $object;

    /**
     * Set the involved object
     *
     * @param   Model $object
     *
     * @return  $this
     */
    public function setObject(Model $object): self
    {
        $this->object = $object;

        return $this;
    }

    /**
     * Get the involved object
     *
     * @return Model
     */
    public function getObject(): Model
    {
        if ($this->object === null) {
            throw new \LogicException(
                'You are accessing an unset property. Please make sure to set it beforehand.'
            );
        }

        return $this->object;
    }
}