[ Index ]

PHP Cross Reference of Phabricator

title

Body

[close]

/src/applications/conduit/method/ -> ConduitAPIMethod.php (summary)

(no description)

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

Defines 25 functions

  __construct()
  getID()
  getMethodStatus()
  getMethodStatusDescription()
  getErrorDescription()
  getRequiredScope()
  executeMethod()
  getSortOrder()
  getApplicationName()
  getConduitMethod()
  shouldRequireAuthentication()
  shouldAllowPublic()
  shouldAllowUnguardedWrites()
  getApplication()
  formatStringConstants()
  getPagerParamTypes()
  newPager()
  addPagerResults()
  getPHID()
  getCapabilities()
  getPolicy()
  hasAutomaticCapability()
  describeAutomaticCapability()
  hasApplicationCapability()
  requireApplicationCapability()

Functions
Functions that are not part of a class:

__construct()   X-Ref


getID()   X-Ref
This is mostly for compatibility with
@{class:PhabricatorCursorPagedPolicyAwareQuery}.


getMethodStatus()   X-Ref
Get the status for this method (e.g., stable, unstable or deprecated).
Should return a METHOD_STATUS_* constant. By default, methods are
"stable".

return: const  METHOD_STATUS_* constant.

getMethodStatusDescription()   X-Ref
Optional description to supplement the method status. In particular, if
a method is deprecated, you can return a string here describing the reason
for deprecation and stable alternatives.

return: string|null  Description of the method status, if available.

getErrorDescription($error_code)   X-Ref
No description

getRequiredScope()   X-Ref
No description

executeMethod(ConduitAPIRequest $request)   X-Ref
No description

getSortOrder()   X-Ref
Return a key which sorts methods by application name, then method status,
then method name.


getApplicationName()   X-Ref
No description

getConduitMethod($method_name)   X-Ref
No description

shouldRequireAuthentication()   X-Ref
No description

shouldAllowPublic()   X-Ref
No description

shouldAllowUnguardedWrites()   X-Ref
No description

getApplication()   X-Ref
Optionally, return a @{class:PhabricatorApplication} which this call is
part of. The call will be disabled when the application is uninstalled.

return: PhabricatorApplication|null  Related application.

formatStringConstants($constants)   X-Ref
No description

getPagerParamTypes()   X-Ref


newPager(ConduitAPIRequest $request)   X-Ref


addPagerResults(array $results,AphrontCursorPagerView $pager)   X-Ref


getPHID()   X-Ref
No description

getCapabilities()   X-Ref
No description

getPolicy($capability)   X-Ref
No description

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

describeAutomaticCapability($capability)   X-Ref
No description

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

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



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