Page MenuHomePhabricator
Diviner Arcanist Tech Docs ArcanistRepositoryAPI

abstract class ArcanistRepositoryAPI
Arcanist Technical Documentation ()

Interfaces with the VCS in the working copy.

Tasks

Path Status

Other Methods

scratch

  • public function readScratchFile($path) — Try to read a scratch file, if it exists and is readable.
  • public function writeScratchFile($path, $data) — Try to write a scratch file, if there's somewhere to put it and we can write there.
  • public function removeScratchFile($path) — Try to remove a scratch file.
  • public function getReadableScratchFilePath($path) — Get a human-readable description of the scratch file location.
  • public function getScratchFilePath($path) — Get the path to a scratch file, if possible.

Methods

abstract public function getSourceControlSystemName()

This method is not documented.
Return
wild

public function getDiffLinesOfContext()

This method is not documented.
Return
wild

public function setDiffLinesOfContext($lines)

This method is not documented.
Parameters
$lines
Return
wild

public function getWorkingCopyIdentity()

This method is not documented.
Return
wild

public function getConfigurationManager()

This method is not documented.
Return
wild

public static function newAPIFromConfigurationManager($configuration_manager)

This method is not documented.
Parameters
ArcanistConfigurationManager$configuration_manager
Return
wild

public function __construct($path)

This method is not documented.
Parameters
$path
Return
this//Implicit.//

public function getPath($to_file)

This method is not documented.
Parameters
$to_file
Return
wild

abstract protected function buildUncommittedStatus()

This method is not documented.
Return
wild

abstract protected function buildCommitRangeStatus()

This method is not documented.
Return
wild

final public function getUncommittedStatus()

Get a list of uncommitted paths in the working copy that have been changed or are affected by other status effects, like conflicts or untracked files.

Convenience methods getUntrackedChanges(), getUnstagedChanges(), getUncommittedChanges(), getMergeConflicts(), and getIncompleteChanges() allow simpler selection of paths in a specific state.

This method returns a map of paths to bitmasks with status, using FLAG_ constants. For example:

array(
  'some/uncommitted/file.txt' => ArcanistRepositoryAPI::FLAG_UNSTAGED,
);

A file may be in several states. Not all states are possible with all version control systems.

Return
map<string, bitmask>Map of paths, see above.

final public function getUntrackedChanges()

This method is not documented.
Return
wild

final public function getUnstagedChanges()

This method is not documented.
Return
wild

final public function getUncommittedChanges()

This method is not documented.
Return
wild

final public function getMergeConflicts()

This method is not documented.
Return
wild

final public function getIncompleteChanges()

This method is not documented.
Return
wild

final public function getMissingChanges()

This method is not documented.
Return
wild

final public function getDirtyExternalChanges()

This method is not documented.
Return
wild

private function getUncommittedPathsWithMask($mask)

This method is not documented.
Parameters
$mask
Return
wild

final public function getCommitRangeStatus()

Get a list of paths affected by the commits in the current commit range.

See getUncommittedStatus() for a description of the return value.

Return
map<string, bitmask>Map from paths to status.

final public function getWorkingCopyStatus()

Get a list of paths affected by commits in the current commit range, or uncommitted changes in the working copy. See getUncommittedStatus() or getCommitRangeStatus() to retrieve smaller parts of the status.

See getUncommittedStatus() for a description of the return value.

Return
map<string, bitmask>Map from paths to status.

final public function reloadWorkingCopy()

Drops caches after changes to the working copy. By default, some queries against the working copy are cached. They

Return
this

protected function didReloadWorkingCopy()

Hook for implementations to dirty working copy caches after the working copy has been updated.

Return
void

public function getBulkOriginalFileData($paths)

Fetches the original file data for each path provided.

Parameters
$paths
Return
map<string, string>Map from path to file data.

public function getBulkCurrentFileData($paths)

Fetches the current file data for each path provided.

Parameters
$paths
Return
map<string, string>Map from path to file data.

abstract public function getAllFiles()

This method is not documented.
Return
Traversable

abstract public function getBlame($path)

This method is not documented.
Parameters
$path
Return
wild

abstract public function getRawDiffText($path)

This method is not documented.
Parameters
$path
Return
wild

abstract public function getOriginalFileData($path)

This method is not documented.
Parameters
$path
Return
wild

abstract public function getCurrentFileData($path)

This method is not documented.
Parameters
$path
Return
wild

abstract public function getLocalCommitInformation()

This method is not documented.
Return
wild

abstract public function getSourceControlBaseRevision()

This method is not documented.
Return
wild

abstract public function getCanonicalRevisionName($string)

This method is not documented.
Parameters
$string
Return
wild

abstract public function getBranchName()

This method is not documented.
Return
wild

abstract public function getSourceControlPath()

This method is not documented.
Return
wild

abstract public function isHistoryDefaultImmutable()

This method is not documented.
Return
wild

abstract public function supportsAmend()

This method is not documented.
Return
wild

abstract public function getWorkingCopyRevision()

This method is not documented.
Return
wild

abstract public function updateWorkingCopy()

This method is not documented.
Return
wild

abstract public function getMetadataPath()

This method is not documented.
Return
wild

abstract public function loadWorkingCopyDifferentialRevisions($conduit, $query)

This method is not documented.
Parameters
ConduitClient$conduit
array$query
Return
wild

abstract public function getRemoteURI()

This method is not documented.
Return
wild

public function getChangedFiles($since_commit)

This method is not documented.
Parameters
$since_commit
Return
wild

public function getAuthor()

This method is not documented.
Return
wild

public function addToCommit($paths)

This method is not documented.
Parameters
array$paths
Return
wild

abstract public function supportsLocalCommits()

This method is not documented.
Return
wild

public function doCommit($message)

This method is not documented.
Parameters
$message
Return
wild

public function amendCommit($message)

This method is not documented.
Parameters
$message
Return
wild

public function getBaseCommitRef()

This method is not documented.
Return
wild

public function hasLocalCommit($commit)

This method is not documented.
Parameters
$commit
Return
wild

public function getCommitMessage($commit)

This method is not documented.
Parameters
$commit
Return
wild

public function getCommitSummary($commit)

This method is not documented.
Parameters
$commit
Return
wild

public function getAllLocalChanges()

This method is not documented.
Return
wild

public function getFinalizedRevisionMessage()

This method is not documented.
Return
wild

public function execxLocal($pattern)

This method is not documented.
Parameters
$pattern
Return
wild

public function execManualLocal($pattern)

This method is not documented.
Parameters
$pattern
Return
wild

public function execFutureLocal($pattern)

This method is not documented.
Parameters
$pattern
Return
wild

abstract protected function buildLocalFuture($argv)

This method is not documented.
Parameters
array$argv
Return
wild

public function canStashChanges()

This method is not documented.
Return
wild

public function stashChanges()

This method is not documented.
Return
wild

public function unstashChanges()

This method is not documented.
Return
wild

public function readScratchFile($path)

Try to read a scratch file, if it exists and is readable.

Parameters
string$pathScratch file name.
Return
mixedString for file contents, or false for failure.

public function writeScratchFile($path, $data)

Try to write a scratch file, if there's somewhere to put it and we can write there.

Parameters
string$pathScratch file name to write.
string$dataData to write.
Return
boolTrue on success, false on failure.

public function removeScratchFile($path)

Try to remove a scratch file.

Parameters
string$pathScratch file name to remove.
Return
boolTrue if the file was removed successfully.

public function getReadableScratchFilePath($path)

Get a human-readable description of the scratch file location.

Parameters
string$pathScratch file name.
Return
mixedString, or false on failure.

public function getScratchFilePath($path)

Get the path to a scratch file, if possible.

Parameters
string$pathScratch file name.
Return
mixedFile path, or false on failure.

abstract public function supportsCommitRanges()

This method is not documented.
Return
wild

final public function setBaseCommit($symbolic_commit)

This method is not documented.
Parameters
$symbolic_commit
Return
wild

public function setHeadCommit($symbolic_commit)

This method is not documented.
Parameters
$symbolic_commit
Return
wild

final public function getBaseCommit()

This method is not documented.
Return
wild

public function getHeadCommit()

This method is not documented.
Return
wild

final public function reloadCommitRange()

This method is not documented.
Return
wild

protected function didReloadCommitRange()

This method is not documented.
Return
wild

protected function buildBaseCommit($symbolic_commit)

This method is not documented.
Parameters
$symbolic_commit
Return
wild

public function getBaseCommitExplanation()

This method is not documented.
Return
wild

public function setBaseCommitExplanation($explanation)

This method is not documented.
Parameters
$explanation
Return
wild

public function resolveBaseCommitRule($rule, $source)

This method is not documented.
Parameters
$rule
$source
Return
wild

public function setBaseCommitArgumentRules($base_commit_argument_rules)

This method is not documented.
Parameters
$base_commit_argument_rules
Return
wild

public function getBaseCommitArgumentRules()

This method is not documented.
Return
wild

public function resolveBaseCommit()

This method is not documented.
Return
wild

public function getRepositoryUUID()

This method is not documented.
Return
wild

final public function newFuture($pattern)

This method is not documented.
Parameters
$pattern
Return
wild

public function newPassthru($pattern)

This method is not documented.
Parameters
$pattern
Return
wild

final public function execPassthru($pattern)

This method is not documented.
Parameters
$pattern
Return
wild

final public function setRuntime($runtime)

This method is not documented.
Parameters
ArcanistRuntime$runtime
Return
wild

final public function getRuntime()

This method is not documented.
Return
wild

final protected function getSymbolEngine()

This method is not documented.
Return
wild

final public function getCurrentWorkingCopyStateRef()

This method is not documented.
Return
wild

protected function newCurrentWorkingCopyStateRef()

This method is not documented.
Return
wild

final public function getCurrentCommitRef()

This method is not documented.
Return
wild

protected function newCurrentCommitRef()

This method is not documented.
Return
wild

protected function newCurrentCommitSymbol()

This method is not documented.
Return
wild

final public function newCommitRef()

This method is not documented.
Return
wild

final public function newMarkerRef()

This method is not documented.
Return
wild

final public function getLandEngine()

This method is not documented.
Return
wild

protected function newLandEngine()

This method is not documented.
Return
wild

final public function getWorkEngine()

This method is not documented.
Return
wild

protected function newWorkEngine()

This method is not documented.
Return
wild

final public function getSupportedMarkerTypes()

This method is not documented.
Return
wild

protected function newSupportedMarkerTypes()

This method is not documented.
Return
wild

final public function newMarkerRefQuery()

This method is not documented.
Return
wild

protected function newMarkerRefQueryTemplate()

This method is not documented.
Return
wild

final public function newRemoteRefQuery()

This method is not documented.
Return
wild

protected function newRemoteRefQueryTemplate()

This method is not documented.
Return
wild

final public function newCommitGraphQuery()

This method is not documented.
Return
wild

protected function newCommitGraphQueryTemplate()

This method is not documented.
Return
wild

final public function getDisplayHash($hash)

This method is not documented.
Parameters
$hash
Return
wild

final public function getNormalizedURI($uri)

This method is not documented.
Parameters
$uri
Return
wild

protected function newNormalizedURI($uri)

This method is not documented.
Parameters
$uri
Return
wild

final public function getPublishedCommitHashes()

This method is not documented.
Return
wild

protected function newPublishedCommitHashes()

This method is not documented.
Return
wild

final public function getGraph()

This method is not documented.
Return
wild