Homec4science
Diffusion Phabricator (production) Browse

phab/src/applications/policy/codex/PhabricatorPolicyCodex.php
409e207378b4production

Last Change
Raw File

PhabricatorPolicyCodex.php
View Options

<?php
/**
* Rendering extensions that allows an object to render custom strings,
* descriptions and explanations for the policy system to help users
* understand complex policies.
*/
abstract class PhabricatorPolicyCodex
extends Phobject {
private $viewer;
private $object;
private $policy;
private $capability;
public function getPolicyShortName() {
return null;
}
public function getPolicyIcon() {
return null;
}
public function getPolicyTagClasses() {
return array();
}
public function getPolicySpecialRuleDescriptions() {
return array();
}
public function getDefaultPolicy() {
return PhabricatorPolicyQuery::getDefaultPolicyForObject(
$this->viewer,
$this->object,
$this->capability);
}
public function compareToDefaultPolicy(PhabricatorPolicy $policy) {
return null;
}
final public function getPolicySpecialRuleForCapability($capability) {
foreach ($this->getPolicySpecialRuleDescriptions() as $rule) {
if (in_array($capability, $rule->getCapabilities())) {
return $rule;
}
}
return null;
}
final protected function newRule() {
return new PhabricatorPolicyCodexRuleDescription();
}
final public function setViewer(PhabricatorUser $viewer) {
$this->viewer = $viewer;
return $this;
}
final public function getViewer() {
return $this->viewer;
}
final public function setObject(PhabricatorPolicyCodexInterface $object) {
$this->object = $object;
return $this;
}
final public function getObject() {
return $this->object;
}
final public function setCapability($capability) {
$this->capability = $capability;
return $this;
}
final public function getCapability() {
return $this->capability;
}
final public function setPolicy(PhabricatorPolicy $policy) {
$this->policy = $policy;
return $this;
}
final public function getPolicy() {
return $this->policy;
}
final public static function newFromObject(
PhabricatorPolicyCodexInterface $object,
PhabricatorUser $viewer) {
if (!($object instanceof PhabricatorPolicyInterface)) {
throw new Exception(
pht(
'Object (of class "%s") implements interface "%s", but must also '.
'implement interface "%s".',
get_class($object),
'PhabricatorPolicyCodexInterface',
'PhabricatorPolicyInterface'));
}
$codex = $object->newPolicyCodex();
if (!($codex instanceof PhabricatorPolicyCodex)) {
throw new Exception(
pht(
'Object (of class "%s") implements interface "%s", but defines '.
'method "%s" incorrectly: this method must return an object of '.
'class "%s".',
get_class($object),
'PhabricatorPolicyCodexInterface',
'newPolicyCodex()',
__CLASS__));
}
$codex
->setObject($object)
->setViewer($viewer);
return $codex;
}
}
c4science · Help