[ Index ]

PHP Cross Reference of Phabricator

title

Body

[close]

/src/applications/diffusion/conduit/ -> DiffusionQueryConduitAPIMethod.php (summary)

(no description)

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

Defines 15 functions

  shouldAllowPublic()
  getMethodStatus()
  getMethodStatusDescription()
  setDiffusionRequest()
  getDiffusionRequest()
  getRepository()
  defineErrorTypes()
  defineCustomErrorTypes()
  defineParamTypes()
  defineCustomParamTypes()
  getGitResult()
  getSVNResult()
  getMercurialResult()
  execute()
  getResult()

Functions
Functions that are not part of a class:

shouldAllowPublic()   X-Ref
No description

getMethodStatus()   X-Ref
No description

getMethodStatusDescription()   X-Ref
No description

setDiffusionRequest(DiffusionRequest $request)   X-Ref
No description

getDiffusionRequest()   X-Ref
No description

getRepository(ConduitAPIRequest $request)   X-Ref
No description

defineErrorTypes()   X-Ref
No description

defineCustomErrorTypes()   X-Ref
Subclasses should override this to specify custom error types.


defineParamTypes()   X-Ref
No description

defineCustomParamTypes()   X-Ref
Subclasses should override this to specify custom param types.


getGitResult(ConduitAPIRequest $request)   X-Ref
Subclasses should override these methods with the proper result for the
pertinent version control system, e.g. getGitResult for Git.

If the result is not supported for that VCS, do not implement it. e.g.
Subversion (SVN) does not support branches.

getSVNResult(ConduitAPIRequest $request)   X-Ref
No description

getMercurialResult(ConduitAPIRequest $request)   X-Ref
No description

execute(ConduitAPIRequest $request)   X-Ref
This method is final because most queries will need to construct a
@{class:DiffusionRequest} and use it. Consolidating this codepath and
enforcing @{method:getDiffusionRequest} works when we need it is good.

@{method:getResult} should be overridden by subclasses as necessary, e.g.
there is a common operation across all version control systems that
should occur after @{method:getResult}, like formatting a timestamp.

getResult(ConduitAPIRequest $request)   X-Ref
No description



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