Page MenuHomePhorge

abstract class ArcanistLandEngine
libphutil Technical Documentation ()

This class is not documented.

Methods

public function __get($name)
Inherited

This method is not documented.
Parameters
$name
Return
wild

public function __set($name, $value)
Inherited

This method is not documented.
Parameters
$name
$value
Return
wild

public function current()
Inherited

This method is not documented.
Return
wild

public function key()
Inherited

This method is not documented.
Return
wild

public function next()
Inherited

This method is not documented.
Return
wild

public function rewind()
Inherited

This method is not documented.
Return
wild

public function valid()
Inherited

This method is not documented.
Return
wild

private function throwOnAttemptedIteration()
Inherited

This method is not documented.
Return
wild

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

Phobject

Read the value of a class constant.

This is the same as just typing self::CONSTANTNAME, but throws a more useful message if the constant is not defined and allows the constant to be limited to a maximum length.

Parameters
string$keyName of the constant.
int|null$byte_limitMaximum number of bytes permitted in the value.
Return
stringValue of the constant.

final public function setViewer($viewer)
Inherited

This method is not documented.
Parameters
$viewer
Return
wild

final public function getViewer()
Inherited

This method is not documented.
Return
wild

final public function setWorkflow($workflow)
Inherited

This method is not documented.
Parameters
ArcanistWorkflow$workflow
Return
wild

final public function getWorkflow()
Inherited

This method is not documented.
Return
wild

final public function setRepositoryAPI($repository_api)
Inherited

This method is not documented.
Parameters
ArcanistRepositoryAPI$repository_api
Return
wild

final public function getRepositoryAPI()
Inherited

This method is not documented.
Return
wild

final public function setLogEngine($log_engine)
Inherited

This method is not documented.
Parameters
ArcanistLogEngine$log_engine
Return
wild

final public function getLogEngine()
Inherited

This method is not documented.
Return
wild

final public function setOntoRemote($onto_remote)

This method is not documented.
Parameters
$onto_remote
Return
wild

final public function getOntoRemote()

This method is not documented.
Return
wild

final public function setOntoRefs($onto_refs)

This method is not documented.
Parameters
$onto_refs
Return
wild

final public function getOntoRefs()

This method is not documented.
Return
wild

final public function setIntoRemote($into_remote)

This method is not documented.
Parameters
$into_remote
Return
wild

final public function getIntoRemote()

This method is not documented.
Return
wild

final public function setIntoRef($into_ref)

This method is not documented.
Parameters
$into_ref
Return
wild

final public function getIntoRef()

This method is not documented.
Return
wild

final public function setIntoEmpty($into_empty)

This method is not documented.
Parameters
$into_empty
Return
wild

final public function getIntoEmpty()

This method is not documented.
Return
wild

final public function setPickArgument($pick_argument)

This method is not documented.
Parameters
$pick_argument
Return
wild

final public function getPickArgument()

This method is not documented.
Return
wild

final public function setIntoLocal($into_local)

This method is not documented.
Parameters
$into_local
Return
wild

final public function getIntoLocal()

This method is not documented.
Return
wild

final public function setShouldHold($should_hold)

This method is not documented.
Parameters
$should_hold
Return
wild

final public function getShouldHold()

This method is not documented.
Return
wild

final public function setShouldKeep($should_keep)

This method is not documented.
Parameters
$should_keep
Return
wild

final public function getShouldKeep()

This method is not documented.
Return
wild

final public function setStrategyArgument($strategy_argument)

This method is not documented.
Parameters
$strategy_argument
Return
wild

final public function getStrategyArgument()

This method is not documented.
Return
wild

final public function setStrategy($strategy)

This method is not documented.
Parameters
$strategy
Return
wild

final public function getStrategy()

This method is not documented.
Return
wild

final public function setRevisionSymbol($revision_symbol)

This method is not documented.
Parameters
$revision_symbol
Return
wild

final public function getRevisionSymbol()

This method is not documented.
Return
wild

final public function setRevisionSymbolRef($revision_ref)

This method is not documented.
Parameters
ArcanistRevisionSymbolRef$revision_ref
Return
wild

final public function getRevisionSymbolRef()

This method is not documented.
Return
wild

final public function setShouldPreview($should_preview)

This method is not documented.
Parameters
$should_preview
Return
wild

final public function getShouldPreview()

This method is not documented.
Return
wild

final public function setSourceRefs($source_refs)

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

final public function getSourceRefs()

This method is not documented.
Return
wild

final public function setOntoRemoteArgument($remote_argument)

This method is not documented.
Parameters
$remote_argument
Return
wild

final public function getOntoRemoteArgument()

This method is not documented.
Return
wild

final public function setOntoArguments($onto_arguments)

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

final public function getOntoArguments()

This method is not documented.
Return
wild

final public function setIsIncremental($is_incremental)

This method is not documented.
Parameters
$is_incremental
Return
wild

final public function getIsIncremental()

This method is not documented.
Return
wild

final public function setIntoEmptyArgument($into_empty_argument)

This method is not documented.
Parameters
$into_empty_argument
Return
wild

final public function getIntoEmptyArgument()

This method is not documented.
Return
wild

final public function setIntoLocalArgument($into_local_argument)

This method is not documented.
Parameters
$into_local_argument
Return
wild

final public function getIntoLocalArgument()

This method is not documented.
Return
wild

final public function setIntoRemoteArgument($into_remote_argument)

This method is not documented.
Parameters
$into_remote_argument
Return
wild

final public function getIntoRemoteArgument()

This method is not documented.
Return
wild

final public function setIntoArgument($into_argument)

This method is not documented.
Parameters
$into_argument
Return
wild

final public function getIntoArgument()

This method is not documented.
Return
wild

private function setLocalState($local_state)

This method is not documented.
Parameters
ArcanistRepositoryLocalState$local_state
Return
wild

final protected function getLocalState()

This method is not documented.
Return
wild

private function setHasUnpushedChanges($unpushed)

This method is not documented.
Parameters
$unpushed
Return
wild

final protected function getHasUnpushedChanges()

This method is not documented.
Return
wild

final protected function getOntoConfigurationKey()

This method is not documented.
Return
wild

final protected function getOntoFromConfiguration()

This method is not documented.
Return
wild

final protected function getOntoRemoteConfigurationKey()

This method is not documented.
Return
wild

final protected function getOntoRemoteFromConfiguration()

This method is not documented.
Return
wild

final protected function getStrategyConfigurationKey()

This method is not documented.
Return
wild

final protected function getStrategyFromConfiguration()

This method is not documented.
Return
wild

final protected function confirmRevisions($sets)

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

private function confirmBuilds($revision_refs)

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

final protected function confirmImplicitCommits($sets, $symbols)

This method is not documented.
Parameters
array$sets
array$symbols
Return
wild

final protected function getDisplaySymbols($symbols)

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

final protected function printCommitSet($set)

This method is not documented.
Parameters
ArcanistLandCommitSet$set
Return
wild

final protected function loadRevisionRefs($commit_map)

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

final protected function confirmCommits($into_commit, $symbols, $commit_map)

This method is not documented.
Parameters
$into_commit
array$symbols
array$commit_map
Return
wild

public function execute()

This method is not documented.
Return
wild

protected function validateArguments()

This method is not documented.
Return
wild

abstract protected function getDefaultSymbols()

This method is not documented.
Return
wild

abstract protected function resolveSymbols($symbols)

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

abstract protected function selectOntoRemote($symbols)

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

abstract protected function selectOntoRefs($symbols)

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

abstract protected function confirmOntoRefs($onto_refs)

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

abstract protected function selectIntoRemote()

This method is not documented.
Return
wild

abstract protected function selectIntoRef()

This method is not documented.
Return
wild

abstract protected function selectIntoCommit()

This method is not documented.
Return
wild

abstract protected function selectCommits($into_commit, $symbols)

This method is not documented.
Parameters
$into_commit
array$symbols
Return
wild

abstract protected function executeMerge($set, $into_commit)

This method is not documented.
Parameters
ArcanistLandCommitSet$set
$into_commit
Return
wild

abstract protected function pushChange($into_commit)

This method is not documented.
Parameters
$into_commit
Return
wild

abstract protected function cascadeState($set, $into_commit)

Update all local refs that depend on refs selected-and-modified during the land. E.g. with branches named change1 -> change2 -> change3 and using arc land change2, in the general case the local change3 should be rebased onto the landed version of change2 so that it no longer has out-of-date ancestors.

When multiple revisions are landed at once this will be called in a loop for each set, in order of max to min, where max is the latest descendant and min is the earliest ancestor. This is done so that non-landing commits that are descendants of the latest revision will only be rebased once.

Parameters
ArcanistLandCommitSet$setThe current commit set to cascade.
$into_commit
Return
wild

protected function isSquashStrategy()

This method is not documented.
Return
wild

abstract protected function pruneBranches($sets)

Prunes the given sets of commits. This should be called after the sets have been merged.

Parameters
array$setsThe list of ArcanistLandCommitSet to prune, in order of min to max commit set, where min is the earliest ancestor and max is the latest descendant.
Return
wild

abstract protected function reconcileLocalState($into_commit, $state)

Restore the local repository to an expected state after landing. This should only be called after all changes have been merged, pruned, and pushed.

Parameters
string$into_commitThe commit hash that was landed into.
ArcanistRepositoryLocalState$stateThe local state that was captured at the beginning of the land process. This may include stashed changes.
Return
wild

abstract protected function didHoldChanges($into_commit)

Display information to the user about how to proceed since the land process was not fully completed. The merged branch has not been pushed.

Parameters
string$into_commitThe commit hash that was landed into.
Return
wild

private function selectMergeStrategy()

This method is not documented.
Return
wild

private function filterCommitSets($sets)

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

final protected function newPassthruCommand($pattern)

This method is not documented.
Parameters
$pattern
Return
wild

final protected function newPassthru($pattern)

This method is not documented.
Parameters
$pattern
Return
wild

final protected function getOntoRemoteRef()

This method is not documented.
Return
wild