icingaweb2-module-director/library/Director/Web/Controller/BranchHelper.php

94 lines
2.4 KiB
PHP

<?php
namespace Icinga\Module\Director\Web\Controller;
use Icinga\Module\Director\Data\Db\DbObjectStore;
use Icinga\Module\Director\Db\Branch\Branch;
use Icinga\Module\Director\Db\Branch\BranchStore;
use Icinga\Module\Director\Db\Branch\BranchSupport;
use Icinga\Module\Director\Db\Branch\PreferredBranchSupport;
use Icinga\Module\Director\Objects\IcingaObject;
use Icinga\Module\Director\Web\Widget\NotInBranchedHint;
trait BranchHelper
{
/** @var Branch */
protected $branch;
/** @var BranchStore */
protected $branchStore;
/** @var ?bool */
protected $hasPreferredBranch = null;
/**
* @return false|\Ramsey\Uuid\UuidInterface
*/
protected function getBranchUuid()
{
return $this->getBranch()->getUuid();
}
protected function getBranch()
{
if ($this->branch === null) {
/** @var ActionController $this */
$this->branch = Branch::forRequest($this->getRequest(), $this->getBranchStore(), $this->Auth());
}
return $this->branch;
}
/**
* @return BranchStore
*/
protected function getBranchStore()
{
if ($this->branchStore === null) {
$this->branchStore = new BranchStore($this->db());
}
return $this->branchStore;
}
protected function hasBranch()
{
return $this->getBranchUuid() !== null;
}
protected function enableStaticObjectLoader($table)
{
if (BranchSupport::existsForTableName($table)) {
IcingaObject::setDbObjectStore(new DbObjectStore($this->db(), $this->getBranch()));
}
}
/**
* @param string $subject
* @return bool
*/
protected function showNotInBranch($subject)
{
if ($this->getBranch()->isBranch()) {
$this->content()->add(new NotInBranchedHint($subject, $this->getBranch(), $this->Auth()));
return true;
}
return false;
}
protected function hasPreferredBranch()
{
if ($this->hasPreferredBranch === null) {
$implementation = Branch::optionalHook();
if ($implementation instanceof PreferredBranchSupport) {
$this->hasPreferredBranch = $implementation->hasPreferredBranch($this->Auth());
} else {
$this->hasPreferredBranch = false;
}
}
return $this->hasPreferredBranch;
}
}