[ Index ]

PHP Cross Reference of Phabricator

title

Body

[close]

/src/applications/policy/interface/ -> PhabricatorPolicyInterface.php (summary)

(no description)

File Size: 65 lines (2 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

PhabricatorPolicyInterface:: (4 methods):
  getCapabilities()
  getPolicy()
  hasAutomaticCapability()
  describeAutomaticCapability()


Interface: PhabricatorPolicyInterface  - X-Ref

getCapabilities()   X-Ref
No description

getPolicy($capability)   X-Ref
No description

hasAutomaticCapability($capability, PhabricatorUser $viewer)   X-Ref
No description

describeAutomaticCapability($capability)   X-Ref
Describe exceptions to an object's policy setting.

The intent of this method is to explain and inform users about special
cases which override configured policy settings. If this object has any
such exceptions, explain them by returning one or more human-readable
strings which describe the exception in a broad, categorical way. For
example:

- "The owner of an X can always view and edit it."
- "Members of a Y can always view it."

You can return `null`, a single string, or a list of strings.

The relevant capability to explain (like "view") is passed as a parameter.
You should tailor any messages to be relevant to that capability, although
they do not need to exclusively describe the capability, and in some cases
being more general ("The author can view and edit...") will be more clear.

Messages should describe general rules, not specific objects, because the
main goal is to teach the user the rules. For example, write "the author",
not the specific author's name.

param: const @{class:PhabricatorPolicyCapability} constant.
return: wild Description of policy exceptions. See above.



Generated: Sun Nov 30 09:20:46 2014 Cross-referenced by PHPXref 0.7.1