Page MenuHomePhabricator
Diviner Phabricator Tech Docs DiffusionRefsQueryConduitAPIMethod

final class DiffusionRefsQueryConduitAPIMethod
Phabricator Technical Documentation (Diffusion)

This class is not documented.

Methods

final public function getApplication()
Inherited

This method is not documented.
Return
wild

public function shouldAllowPublic()
Inherited

This method is not documented.
Return
wild

protected function setDiffusionRequest($request)
Inherited

This method is not documented.
Parameters
DiffusionRequest$request
Return
wild

protected function getDiffusionRequest()
Inherited

This method is not documented.
Return
wild

protected function getRepository($request)
Inherited

This method is not documented.
Parameters
ConduitAPIRequest$request
Return
wild

final protected function defineErrorTypes()
Inherited

This method is not documented.
Return
wild

protected function defineCustomErrorTypes()
Inherited

DiffusionQueryConduitAPIMethod

Subclasses should override this to specify custom error types.

Return
wild

final protected function defineParamTypes()
Inherited

This method is not documented.
Return
wild

protected function defineCustomParamTypes()

DiffusionQueryConduitAPIMethod

Subclasses should override this to specify custom param types.

DiffusionRefsQueryConduitAPIMethod
This method is not documented.
Return
wild

protected function getGitResult($request)

DiffusionQueryConduitAPIMethod

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.

DiffusionRefsQueryConduitAPIMethod
This method is not documented.
Parameters
ConduitAPIRequest$request
Return
wild

protected function getSVNResult($request)
Inherited

This method is not documented.
Parameters
ConduitAPIRequest$request
Return
wild

protected function getMercurialResult($request)
Inherited

This method is not documented.
Parameters
ConduitAPIRequest$request
Return
wild

final protected function execute($request)
Inherited

DiffusionQueryConduitAPIMethod

This method is final because most queries will need to construct a DiffusionRequest and use it. Consolidating this codepath and enforcing getDiffusionRequest() works when we need it is good.

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

Parameters
ConduitAPIRequest$request
Return
wild

protected function newConduitCallProxyClient($request)
Inherited

This method is not documented.
Parameters
ConduitAPIRequest$request
Return
wild

protected function getResult($request)
Inherited

This method is not documented.
Parameters
ConduitAPIRequest$request
Return
wild

public function getAPIMethodName()

This method is not documented.
Return
wild

public function getMethodDescription()

This method is not documented.
Return
wild

protected function defineReturnType()

This method is not documented.
Return
wild