Diviner Tech Docs PhabricatorRepositoryRefEngine

final class PhabricatorRepositoryRefEngine
Phorge Technical Documentation (Repositories)

Update the ref cursors for a repository, which track the positions of branches, bookmarks, and tags.

Tasks

Configuring Repository Engines

public function setRepository($repository)
protected function getRepository()
public function setVerbose($verbose)
public function getVerbose()

Internals

protected function log($pattern)

Other Methods

public function __get($name)
public function __set($name, $value)
public function current()
public function key()
public function next()
public function rewind()
public function valid()
private function throwOnAttemptedIteration()
public function getPhobjectClassConstant($key, $byte_limit) — Read the value of a class constant.
public function getViewer()
protected function newRepositoryLock($repository, $lock_key, $lock_device_only)
final protected function queueCommitImportTask($repository, $commit_phid, $task_priority, $via)
final protected function getImportTaskPriority($repository, $refs)
public function setRebuild($rebuild)
public function getRebuild()
public function updateRefs()
private function getCursorsForUpdate($repository, $cursors)
private function updateBranchStates($repository, $branches)
private function markPositionNew($position)
private function markPositionDead($position)
private function markPermanentCommits($identifiers)
private function removeMissingCommits($identifiers) — Remove commits which no longer exist in the repository from a list.
private function updateCursors($cursors, $new_refs, $ref_type, $all_closing_heads)
private function loadNewCommitIdentifiers($new_head, $all_closing_heads) — Find all ancestors of a new closing branch head which are not ancestors of any old closing branch head.
private function setPermanentFlagOnCommits($identifiers) — Mark a list of commits as permanent, and queue workers for those commits which don't already have the flag.
private function newRefCursor($repository, $ref_type, $ref_name)
private function saveNewPositions()
private function deleteDeadPositions()

git

private function loadGitRefPositions($repository)

hg

private function loadMercurialBranchPositions($repository)
private function loadMercurialBookmarkPositions($repository)

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	$key	Name of the constant.
int\|null	$byte_limit	Maximum number of bytes permitted in the value.

Return

string

Value of the constant.

public function setRepository($repository)
Inherited

This method is not documented.

Parameters

PhabricatorRepository

$repository

Return

wild

protected function getRepository()
Inherited

This method is not documented.

Return

wild

public function setVerbose($verbose)
Inherited

This method is not documented.

Parameters

$verbose

Return

wild

public function getVerbose()
Inherited

This method is not documented.

Return

wild

public function getViewer()
Inherited

This method is not documented.

Return

wild

protected function newRepositoryLock($repository, $lock_key, $lock_device_only)
Inherited

This method is not documented.

Parameters

PhabricatorRepository	$repository
	$lock_key
	$lock_device_only

Return

wild

protected function log($pattern)
Inherited

This method is not documented.

Parameters

$pattern

Return

wild

final protected function queueCommitImportTask($repository, $commit_phid, $task_priority, $via)
Inherited

This method is not documented.

Parameters

PhabricatorRepository	$repository
	$commit_phid
	$task_priority
	$via

Return

wild

final protected function getImportTaskPriority($repository, $refs)
Inherited

This method is not documented.

Parameters

PhabricatorRepository	$repository
array	$refs

Return

wild

public function setRebuild($rebuild)

This method is not documented.

Parameters

$rebuild

Return

wild

public function getRebuild()

This method is not documented.

Return

wild

public function updateRefs()

This method is not documented.

Return

wild

private function getCursorsForUpdate($repository, $cursors)

This method is not documented.

Parameters

PhabricatorRepository	$repository
array	$cursors

Return

wild

private function updateBranchStates($repository, $branches)

This method is not documented.

Parameters

PhabricatorRepository	$repository
array	$branches

Return

wild

private function markPositionNew($position)

This method is not documented.

Parameters

PhabricatorRepositoryRefPosition

$position

Return

wild

private function markPositionDead($position)

This method is not documented.

Parameters

PhabricatorRepositoryRefPosition

$position

Return

wild

private function markPermanentCommits($identifiers)

This method is not documented.

Parameters

array

$identifiers

Return

wild

private function removeMissingCommits($identifiers)

Remove commits which no longer exist in the repository from a list.

After a force push and garbage collection, we may have branch cursors which point at commits which no longer exist. This can make commands issued later fail. See T5839 for discussion.

Parameters

list<string>

$identifiers

List of commit identifiers.

Return

list<string>

List with nonexistent identifiers removed.

private function updateCursors($cursors, $new_refs, $ref_type, $all_closing_heads)

This method is not documented.

Parameters

array	$cursors
array	$new_refs
	$ref_type
array	$all_closing_heads

Return

wild

private function loadNewCommitIdentifiers($new_head, $all_closing_heads)

Find all ancestors of a new closing branch head which are not ancestors of any old closing branch head.

Parameters

	$new_head
array	$all_closing_heads

Return

wild

private function setPermanentFlagOnCommits($identifiers)

Mark a list of commits as permanent, and queue workers for those commits which don't already have the flag.

Parameters

array

$identifiers

Return

wild

private function newRefCursor($repository, $ref_type, $ref_name)

This method is not documented.

Parameters

PhabricatorRepository	$repository
	$ref_type
	$ref_name

Return

wild

private function saveNewPositions()

This method is not documented.

Return

wild

private function deleteDeadPositions()

This method is not documented.

Return

wild

private function loadGitRefPositions($repository)

This method is not documented.

Parameters

PhabricatorRepository

$repository

Return

wild

private function loadMercurialBranchPositions($repository)

This method is not documented.

Parameters

PhabricatorRepository

$repository

Return

wild

private function loadMercurialBookmarkPositions($repository)

This method is not documented.

Parameters

PhabricatorRepository

$repository

Return

wild

Defined: src/applications/repository/engine/PhabricatorRepositoryRefEngine.php:7
Extends: PhobjectPhabricatorRepositoryEngine

final class PhabricatorRepositoryRefEnginePhorge Technical Documentation (Repositories)

Tasks

Configuring Repository Engines

Internals

Other Methods

git

hg

Methods

public function __get($name)Inherited

public function __set($name, $value)Inherited

public function current()Inherited

public function key()Inherited

public function next()Inherited

public function rewind()Inherited

public function valid()Inherited

private function throwOnAttemptedIteration()Inherited

public function getPhobjectClassConstant($key, $byte_limit)Inherited

public function setRepository($repository)Inherited

protected function getRepository()Inherited

public function setVerbose($verbose)Inherited

public function getVerbose()Inherited

public function getViewer()Inherited

protected function newRepositoryLock($repository, $lock_key, $lock_device_only)Inherited

protected function log($pattern)Inherited

final protected function queueCommitImportTask($repository, $commit_phid, $task_priority, $via)Inherited

final protected function getImportTaskPriority($repository, $refs)Inherited

public function setRebuild($rebuild)

public function getRebuild()

public function updateRefs()

private function getCursorsForUpdate($repository, $cursors)

private function updateBranchStates($repository, $branches)

private function markPositionNew($position)

private function markPositionDead($position)

private function markPermanentCommits($identifiers)

private function removeMissingCommits($identifiers)

private function updateCursors($cursors, $new_refs, $ref_type, $all_closing_heads)

private function loadNewCommitIdentifiers($new_head, $all_closing_heads)

private function setPermanentFlagOnCommits($identifiers)

private function newRefCursor($repository, $ref_type, $ref_name)

private function saveNewPositions()

private function deleteDeadPositions()

private function loadGitRefPositions($repository)

private function loadMercurialBranchPositions($repository)

private function loadMercurialBookmarkPositions($repository)

final class PhabricatorRepositoryRefEngine
Phorge Technical Documentation (Repositories)

public function __get($name)
Inherited

public function __set($name, $value)
Inherited

public function current()
Inherited

public function key()
Inherited

public function next()
Inherited

public function rewind()
Inherited

public function valid()
Inherited

private function throwOnAttemptedIteration()
Inherited

public function getPhobjectClassConstant($key, $byte_limit)
Inherited

public function setRepository($repository)
Inherited

protected function getRepository()
Inherited

public function setVerbose($verbose)
Inherited

public function getVerbose()
Inherited

public function getViewer()
Inherited

protected function newRepositoryLock($repository, $lock_key, $lock_device_only)
Inherited

protected function log($pattern)
Inherited

final protected function queueCommitImportTask($repository, $commit_phid, $task_priority, $via)
Inherited

final protected function getImportTaskPriority($repository, $refs)
Inherited