Page MenuHomePhorge
Diviner Tech Docs PhabricatorPolicyCodex

abstract class PhabricatorPolicyCodex
Phorge Technical Documentation (Policy)

Rendering extensions that allows an object to render custom strings, descriptions and explanations for the policy system to help users understand complex policies.

Methods

public function __get($name)
Inherited

This method is not documented.
Parameters
$name
Return
wild

public function __set($name, $value)
Inherited

This method is not documented.
Parameters
$name
$value
Return
wild

public function current()
Inherited

This method is not documented.
Return
wild

public function key()
Inherited

This method is not documented.
Return
wild

public function next()
Inherited

This method is not documented.
Return
wild

public function rewind()
Inherited

This method is not documented.
Return
wild

public function valid()
Inherited

This method is not documented.
Return
wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.
Return
wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters
string$keyName of the constant.
int|null$byte_limitMaximum number of bytes permitted in the value.
Return
stringValue of the constant.

public function getPolicyShortName()

This method is not documented.
Return
wild

public function getPolicyIcon()

This method is not documented.
Return
wild

public function getPolicyTagClasses()

This method is not documented.
Return
wild
This method is not documented.
Return
wild

public function getPolicyForEdit($capability)

This method is not documented.
Parameters
$capability
Return
wild

public function getDefaultPolicy()

This method is not documented.
Return
wild

final protected function newRule()

This method is not documented.
Return
wild

final public function setViewer($viewer)

This method is not documented.
Parameters
PhabricatorUser$viewer
Return
wild

final public function getViewer()

This method is not documented.
Return
wild

final public function setObject($object)

This method is not documented.
Parameters
PhabricatorPolicyCodexInterface$object
Return
wild

final public function getObject()

This method is not documented.
Return
wild

final public function setCapability($capability)

This method is not documented.
Parameters
$capability
Return
wild

final public function getCapability()

This method is not documented.
Return
wild

final public function setPolicy($policy)

This method is not documented.
Parameters
PhabricatorPolicy$policy
Return
wild

final public function getPolicy()

This method is not documented.
Return
wild

final public static function newFromObject($object, $viewer)

This method is not documented.
Parameters
PhabricatorPolicyCodexInterface$object
PhabricatorUser$viewer
Return
wild