Page MenuHomePhabricator
Diviner Phabricator Tech Docs DiffusionMercurialSSHWorkflow

abstract class DiffusionMercurialSSHWorkflow
Phabricator Technical Documentation (Diffusion)

This class is not documented.

Methods

final public function __construct()
Inherited

This method is not documented.
Return
this//Implicit.//

public function setName($name)
Inherited

This method is not documented.
Parameters
$name
Return
wild

public function getName()
Inherited

This method is not documented.
Return
wild

final public function setExamples($examples)
Inherited

PhutilArgumentWorkflow

Provide brief usage examples of common calling conventions, like:

$workflow->setExamples("**delete** __file__ [__options__]");

This text is shown in both brief and detailed help, and should give the user a quick reference for common uses. You can separate several common uses with newlines, but usually should not provide more than 2-3 examples.

Parameters
$examples
Return
wild

final public function getExamples()
Inherited

This method is not documented.
Return
wild

final public function setSynopsis($synopsis)
Inherited

PhutilArgumentWorkflow

Provide a brief description of the command, like "Delete a file.".

This text is shown in both brief and detailed help, and should give the user a general idea of what the workflow does.

Parameters
$synopsis
Return
wild

final public function getSynopsis()
Inherited

This method is not documented.
Return
wild

final public function getHelp()
Inherited

PhutilArgumentWorkflow

Provide a full explanation of the command. This text is shown only in detailed help.

Return
wild

final public function setHelp($help)
Inherited

This method is not documented.
Parameters
$help
Return
wild

final public function setArguments($specs)
Inherited

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

final public function getArguments()
Inherited

This method is not documented.
Return
wild

final public function setArgv($argv)
Inherited

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

final public function getArgv()
Inherited

This method is not documented.
Return
wild

protected function didConstruct()
Inherited

This method is not documented.
Return
wild

public function isExecutable()
Inherited

This method is not documented.
Return
wild

final public function execute($args)
Inherited

This method is not documented.
Parameters
PhutilArgumentParser$args
Return
wild

public function shouldParsePartial()
Inherited

PhutilArgumentWorkflow

Normally, workflow arguments are parsed fully, so unexpected arguments will raise an error. You can return true from this method to parse workflow arguments only partially. This will allow you to manually parse remaining arguments or delegate to a second level of workflows.

Return
boolTrue to partially parse workflow arguments (default false).

public function setErrorChannel($error_channel)
Inherited

This method is not documented.
Parameters
PhutilChannel$error_channel
Return
wild

public function getErrorChannel()
Inherited

This method is not documented.
Return
wild

public function setSSHUser($ssh_user)
Inherited

This method is not documented.
Parameters
PhabricatorUser$ssh_user
Return
wild

public function getSSHUser()
Inherited

This method is not documented.
Return
wild

public function setIOChannel($channel)
Inherited

This method is not documented.
Parameters
PhutilChannel$channel
Return
wild

public function getIOChannel()
Inherited

This method is not documented.
Return
wild

public function readAllInput()
Inherited

This method is not documented.
Return
wild

public function writeIO($data)
Inherited

This method is not documented.
Parameters
$data
Return
wild

public function writeErrorIO($data)
Inherited

This method is not documented.
Parameters
$data
Return
wild

protected function newPassthruCommand()
Inherited

This method is not documented.
Return
wild

public function setIsClusterRequest($is_cluster_request)
Inherited

This method is not documented.
Parameters
$is_cluster_request
Return
wild

public function getIsClusterRequest()
Inherited

This method is not documented.
Return
wild

public function setOriginalArguments($original_arguments)
Inherited

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

public function getOriginalArguments()
Inherited

This method is not documented.
Return
wild

public function setRequestIdentifier($request_identifier)
Inherited

This method is not documented.
Parameters
$request_identifier
Return
wild

public function getRequestIdentifier()
Inherited

This method is not documented.
Return
wild

public function getSSHRemoteAddress()
Inherited

This method is not documented.
Return
wild

public function getRepository()
Inherited

This method is not documented.
Return
wild

private function setRepository($repository)
Inherited

This method is not documented.
Parameters
PhabricatorRepository$repository
Return
wild

public function getArgs()
Inherited

This method is not documented.
Return
wild

public function getEnvironment()
Inherited

This method is not documented.
Return
wild

abstract protected function identifyRepository()
Inherited

DiffusionSSHWorkflow

Identify and load the affected repository.

Return
wild

abstract protected function executeRepositoryOperations()
Inherited

This method is not documented.
Return
wild

abstract protected function raiseWrongVCSException($repository)
Inherited

This method is not documented.
Parameters
PhabricatorRepository$repository
Return
wild

protected function getBaseRequestPath()
Inherited

This method is not documented.
Return
wild

protected function writeError($message)
Inherited

This method is not documented.
Parameters
$message
Return
wild

protected function getCurrentDeviceName()
Inherited

This method is not documented.
Return
wild

protected function shouldProxy()
Inherited

This method is not documented.
Return
wild

final protected function getAlmanacServiceRefs($for_write)
Inherited

This method is not documented.
Parameters
$for_write
Return
wild

final protected function getProxyCommand($for_write)
Inherited

This method is not documented.
Parameters
$for_write
Return
wild

final protected function getProxyCommandForServiceRef($ref)
Inherited

This method is not documented.
Parameters
DiffusionServiceRef$ref
Return
wild

protected function loadRepositoryWithPath($path, $vcs)
Inherited

This method is not documented.
Parameters
$path
$vcs
Return
wild

protected function requireWriteAccess($protocol_command)
Inherited

This method is not documented.
Parameters
$protocol_command
Return
wild

protected function shouldSkipReadSynchronization()
Inherited

This method is not documented.
Return
wild

protected function newPullEvent()
Inherited

This method is not documented.
Return
wild
Defined
src/applications/diffusion/ssh/DiffusionMercurialSSHWorkflow.php:3
Extends
PhutilArgumentWorkflowPhabricatorSSHWorkflowDiffusionSSHWorkflow
Phabricator · Built by Phacility