[ Index ]

PHP Cross Reference of Phabricator

title

Body

[close]

/src/applications/diffusion/request/ -> DiffusionRequest.php (summary)

Contains logic to parse Diffusion requests, which have a complicated URI structure.

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

Defines 37 functions

  didInitialize()
  newFromDictionary()
  newFromAphrontRequestDictionary()
  __construct()
  newFromCallsign()
  newFromRepository()
  initializeFromDictionary()
  shouldInitFromConduit()
  setUser()
  getUser()
  getRepository()
  getCallsign()
  setPath()
  getPath()
  getLine()
  getCommit()
  getSymbolicCommit()
  updateSymbolicCommit()
  getSymbolicType()
  getStableCommit()
  getBranch()
  getLint()
  getArcanistBranch()
  loadBranch()
  loadCoverage()
  loadCommit()
  loadArcanistProjects()
  loadCommitData()
  generateURI()
  generateDiffusionURI()
  parseRequestBlob()
  validateWorkingCopy()
  raisePermissionException()
  raiseCloneException()
  queryStableCommit()
  getResolvableBranchName()
  resolveRefs()

Functions
Functions that are not part of a class:

didInitialize()   X-Ref
No description

newFromDictionary(array $data)   X-Ref
Create a new synthetic request from a parameter dictionary. If you need
a @{class:DiffusionRequest} object in order to issue a DiffusionQuery, you
can use this method to build one.

Parameters are:

- `callsign` Repository callsign. Provide this or `repository`.
- `user` Viewing user. Required if `callsign` is provided.
- `repository` Repository object. Provide this or `callsign`.
- `branch` Optional, branch name.
- `path` Optional, file path.
- `commit` Optional, commit identifier.
- `line` Optional, line range.

param: map                 See documentation.
return: DiffusionRequest    New request object.

newFromAphrontRequestDictionary(array $data,AphrontRequest $request)   X-Ref
Create a new request from an Aphront request dictionary. This is an
internal method that you generally should not call directly; instead,
call @{method:newFromDictionary}.

param: map                 Map of Aphront request data.
return: DiffusionRequest    New request object.

__construct()   X-Ref
Internal.


newFromCallsign($callsign,PhabricatorUser $viewer)   X-Ref
Internal. Use @{method:newFromDictionary}, not this method.

param: string              Repository callsign.
param: PhabricatorUser     Viewing user.
return: DiffusionRequest    New request object.

newFromRepository(PhabricatorRepository $repository)   X-Ref
Internal. Use @{method:newFromDictionary}, not this method.

param: PhabricatorRepository   Repository object.
return: DiffusionRequest        New request object.

initializeFromDictionary(array $data)   X-Ref
Internal. Use @{method:newFromDictionary}, not this method.

param: map Map of parsed data.
return: void

shouldInitFromConduit()   X-Ref
No description

setUser(PhabricatorUser $user)   X-Ref
No description

getUser()   X-Ref
No description

getRepository()   X-Ref
No description

getCallsign()   X-Ref
No description

setPath($path)   X-Ref
No description

getPath()   X-Ref
No description

getLine()   X-Ref
No description

getCommit()   X-Ref
No description

getSymbolicCommit()   X-Ref
Get the symbolic commit associated with this request.

A symbolic commit may be a commit hash, an abbreviated commit hash, a
branch name, a tag name, or an expression like "HEAD^^^". The symbolic
commit may also be absent.

This method always returns the symbol present in the original request,
in unmodified form.

See also @{method:getStableCommit}.

return: string|null  Symbolic commit, if one was present in the request.

updateSymbolicCommit($symbol)   X-Ref
Modify the request to move the symbolic commit elsewhere.

param: string New symbolic commit.
return: this

getSymbolicType()   X-Ref
Get the ref type (`commit` or `tag`) of the location associated with this
request.

If a symbolic commit is present in the request, this method identifies
the type of the symbol. Otherwise, it identifies the type of symbol of
the location the request is implicitly associated with. This will probably
always be `commit`.

return: string   Symbolic commit type (`commit` or `tag`).

getStableCommit()   X-Ref
Retrieve the stable, permanent commit name identifying the repository
location associated with this request.

This returns a non-symbolic identifier for the current commit: in Git and
Mercurial, a 40-character SHA1; in SVN, a revision number.

See also @{method:getSymbolicCommit}.

return: string Stable commit name, like a git hash or SVN revision. Not

getBranch()   X-Ref
No description

getLint()   X-Ref
No description

getArcanistBranch()   X-Ref
No description

loadBranch()   X-Ref
No description

loadCoverage()   X-Ref
No description

loadCommit()   X-Ref
No description

loadArcanistProjects()   X-Ref
No description

loadCommitData()   X-Ref
No description

generateURI(array $params)   X-Ref
Generate a Diffusion URI using this request to provide defaults. See
@{method:generateDiffusionURI} for details. This method is the same, but
preserves the request parameters if they are not overridden.

param: map         See @{method:generateDiffusionURI}.
return: PhutilURI   Generated URI.

generateDiffusionURI(array $params)   X-Ref
Generate a Diffusion URI from a parameter map. Applies the correct encoding
and formatting to the URI. Parameters are:

- `action` One of `history`, `browse`, `change`, `lastmodified`,
`branch`, `tags`, `branches`,  or `revision-ref`. The action specified
by the URI.
- `callsign` Repository callsign.
- `branch` Optional if action is not `branch`, branch name.
- `path` Optional, path to file.
- `commit` Optional, commit identifier.
- `line` Optional, line range.
- `lint` Optional, lint code.
- `params` Optional, query parameters.

The function generates the specified URI and returns it.

param: map         See documentation.
return: PhutilURI   Generated URI.

parseRequestBlob($blob, $supports_branches)   X-Ref
Internal. Public only for unit tests.

Parse the request URI into components.

param: string  URI blob.
param: bool    True if this VCS supports branches.
return: map     Parsed URI.

validateWorkingCopy($path)   X-Ref
Check that the working copy of the repository is present and readable.

param: string  Path to the working copy.

raisePermissionException()   X-Ref
No description

raiseCloneException()   X-Ref
No description

queryStableCommit()   X-Ref
No description

getResolvableBranchName($branch)   X-Ref
No description

resolveRefs(array $refs)   X-Ref
No description



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