Page MenuHomePhabricator
Diviner Phabricator Tech Docs PhabricatorPolicyCapability

abstract class PhabricatorPolicyCapability
Phabricator Technical Documentation (Policy)

This class is not documented.

Methods

final public function getCapabilityKey()

Get the unique key identifying this capability. This key must be globally unique. Application capabilities should be namespaced. For example:

application.create
Return
stringGlobally unique capability key.

abstract public function getCapabilityName()

Return a human-readable descriptive name for this capability, like "Can View".

Return
stringHuman-readable name describing the capability.

public function describeCapabilityRejection()

Return a human-readable string describing what not having this capability prevents the user from doing. For example:

  • You do not have permission to edit this object.
  • You do not have permission to create new tasks.
Return
stringHuman-readable name describing what failing a check for this capability prevents the user from doing.

Can this capability be set to "public"? Broadly, this is only appropriate for view and view-related policies.

Return
boolTrue to allow the "public" policy. Returns false by default.

final public static function getCapabilityByKey($key)

This method is not documented.
Parameters
$key
Return
wild

final public static function getCapabilityMap()

This method is not documented.
Return
wild