Conduit
Conduit
- final public function setConduitURI($conduit_uri) — Set the URI which the workflow will open a conduit connection to when @{method:establishConduit} is called. Arcanist makes an effort to set this by default for all workflows (by reading ##.arcconfig## and/or the value of ##--conduit-uri##) even if they don't need Conduit, so a workflow can generally upgrade into a conduit workflow later by just calling @{method:establishConduit}.
- final public function getConduitURI() — Returns the URI the conduit connection within the workflow uses.
- final public function establishConduit() — Open a conduit channel to the server which was previously configured by calling @{method:setConduitURI}. Arcanist will do this automatically if the workflow returns ##true## from @{method:requiresConduit}, or you can later upgrade a workflow and build a conduit by invoking it manually.
- final public function setConduitCredentials($credentials) — Set credentials which will be used to authenticate against Conduit. These credentials can then be used to establish an authenticated connection to conduit by calling @{method:authenticateConduit}. Arcanist sets some defaults for all workflows regardless of whether or not they return true from @{method:requireAuthentication}, based on the ##~/.arcrc## and ##.arcconf## files if they are present. Thus, you can generally upgrade a workflow which does not require authentication into an authenticated workflow by later invoking @{method:requireAuthentication}. You should not normally need to call this method unless you are specifically overriding the defaults.
- final public function getConduitVersion() — Get the protocol version the client should identify with.
- final public function authenticateConduit() — Open and authenticate a conduit connection to a Phabricator server using provided credentials. Normally, Arcanist does this for you automatically when you return true from @{method:requiresAuthentication}, but you can also upgrade an existing workflow to one with an authenticated conduit by invoking this method manually.
- final protected function isConduitAuthenticated()
- public function requiresConduit() — Override this to return true if your workflow requires a conduit channel. Arc will build the channel for you before your workflow executes. This implies that you only need an unauthenticated channel; if you need authentication, override @{method:requiresAuthentication}.
- public function requiresAuthentication() — Override this to return true if your workflow requires an authenticated conduit channel. This implies that it requires a conduit. Arc will build and authenticate the channel for you before the workflow executes.
- final public function getUserPHID() — Returns the PHID for the user once they've authenticated via Conduit.
- final public function getUserName() — Return the username for the user once they've authenticated via Conduit.
- final public function getConduit() — Get the established @{class@libphutil:ConduitClient} in order to make Conduit method calls. Before the client is available it must be connected, either implicitly by making @{method:requireConduit} or @{method:requireAuthentication} return true, or explicitly by calling @{method:establishConduit} or @{method:authenticateConduit}.
Scratch Files
Scratch Files
- final protected function readScratchFile($path) — Try to read a scratch file, if it exists and is readable.
- final protected function readScratchJSONFile($path) — Try to read a scratch JSON file, if it exists and is readable.
- final protected function writeScratchFile($path, $data) — Try to write a scratch file, if there's somewhere to put it and we can write there.
- final protected function writeScratchJSONFile($path, $data) — Try to write a scratch JSON file, if there's somewhere to put it and we can write there.
- final protected function removeScratchFile($path) — Try to remove a scratch file.
- final protected function getReadableScratchFilePath($path) — Get a human-readable description of the scratch file location.
- final protected function getScratchFilePath($path) — Get the path to a scratch file, if possible.
Phabricator Repositories
Phabricator Repositories
- final protected function getRepositoryPHID() — Get the PHID of the Phabricator repository this working copy corresponds to. Returns `null` if no repository can be identified.
- final protected function getRepositoryName() — Get the name of the Phabricator repository this working copy corresponds to. Returns `null` if no repository can be identified.
- final protected function getRepositoryURI() — Get the URI of the Phabricator repository this working copy corresponds to. Returns `null` if no repository can be identified.
- final protected function getRepositoryReasons() — Get human-readable reasoning explaining how `arc` evaluated which Phabricator repository corresponds to this working copy. Used by `arc which` to explain the process to users.
- private function getRepositoryInformation()
- private function loadRepositoryInformation()
- private function getRepositoryQuery()
Other Methods
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.
- final public function setToolset($toolset)
- final public function getToolset()
- final public function setRuntime($runtime)
- final public function getRuntime()
- final public function setConfigurationEngine($engine)
- final public function getConfigurationEngine()
- final public function setConfigurationSourceList($list)
- final public function getConfigurationSourceList()
- public function newPhutilWorkflow()
- final public function newLegacyPhutilWorkflow()
- final protected function newWorkflowArgument($key)
- final protected function newWorkflowInformation()
- final public function executeWorkflow($args)
- final public function getLogEngine()
- protected function runWorkflowCleanup()
- public function __construct()
- public function run()
- public function finalize() — Finalizes any cleanup operations that need to occur regardless of whether the command succeeded or failed.
- abstract public function getWorkflowName() — Return the command used to invoke this workflow from the command like, e.g. "help" for @{class:ArcanistHelpWorkflow}.
- public function getCommandSynopses() — Return console formatted string with all command synopses.
- public function getCommandHelp() — Return console formatted string with command help printed in `arc help`.
- public function supportsToolset($toolset)
- final public function getConfigFromAnySource($key)
- final public function setArcanistConfiguration($arcanist_configuration)
- final public function getArcanistConfiguration()
- final public function setConfigurationManager($arcanist_configuration_manager)
- final public function getConfigurationManager()
- public function requiresWorkingCopy()
- public function desiresWorkingCopy()
- public function requiresRepositoryAPI()
- public function desiresRepositoryAPI()
- final public function setCommand($command)
- final public function getCommand()
- public function getArguments()
- final public function setWorkingDirectory($working_directory)
- final public function getWorkingDirectory()
- private function setParentWorkflow($parent_workflow)
- final protected function getParentWorkflow()
- final public function buildChildWorkflow($command, $argv)
- final public function getArgument($key, $default)
- final public function getCompleteArgumentSpecification()
- final public function parseArguments($args)
- protected function didParseArguments()
- final public function getWorkingCopy()
- final public function getWorkingCopyIdentity()
- final public function setRepositoryAPI($api)
- final public function hasRepositoryAPI()
- final public function getRepositoryAPI()
- final protected function shouldRequireCleanUntrackedFiles()
- final public function setCommitMode($mode)
- final public function finalizeWorkingCopy()
- final public function requireCleanWorkingCopy()
- private function getShouldAmend()
- private function calculateShouldAmend()
- private function askForAdd($files)
- private function getAskForAddPrompt($files)
- final protected function loadDiffBundleFromConduit($conduit, $diff_id)
- final protected function loadRevisionBundleFromConduit($conduit, $revision_id)
- private function loadBundleFromConduit($conduit, $params)
- final protected function getChangedLines($path, $mode) — Return a list of lines changed by the current diff, or ##null## if the change list is meaningless (for example, because the path is a directory or binary file).
- final protected function getChange($path)
- final public function willRunWorkflow()
- final protected function normalizeRevisionID($revision_id)
- protected function shouldShellComplete()
- protected function getShellCompletions($argv)
- public function getSupportedRevisionControlSystems()
- final protected function getPassthruArgumentsAsMap($command)
- final protected function getPassthruArgumentsAsArgv($command)
- final protected function writeStatusMessage($msg) — Write a message to stderr so that '--json' flags or stdout which is meant to be piped somewhere aren't disrupted.
- final public function writeInfo($title, $message)
- final public function writeWarn($title, $message)
- final public function writeOkay($title, $message)
- final protected function isHistoryImmutable()
- final protected function selectPathsForWorkflow($paths, $rev, $omit_mask) — Workflows like 'lint' and 'unit' operate on a list of working copy paths. The user can either specify the paths explicitly ("a.js b.php"), or by specifying a revision ("--rev a3f10f1f") to select all paths modified since that revision, or by omitting both and letting arc choose the default relative revision.
- final protected function renderRevisionList($revisions)
- final protected function getRepositoryEncoding()
- final protected function loadProjectRepository()
- final protected function newInteractiveEditor($text)
- final protected function newDiffParser()
- final protected function dispatchEvent($type, $data)
- final public function parseBaseCommitArgument($argv)
- final protected function getRepositoryVersion()
- final protected function getRepositoryStagingConfiguration()
- protected function newLintEngine($engine_class) — Build a new lint engine for the current working copy.
- protected function newUnitTestEngine($engine_class) — Build a new unit test engine for the current working copy.
- protected function openURIsInBrowser($uris)
- private function getBrowserCommand()
- protected function askForRepositoryUpdate() — Ask Phabricator to update the current repository as soon as possible.
- protected function getModernLintDictionary($map)
- protected function getModernUnitDictionary($map)
- private function getModernCommonDictionary($map)
- final public function setConduitEngine($conduit_engine)
- final public function getConduitEngine()
- final public function getRepositoryRef()
- final public function getToolsetKey()
- final public function getConfig($key)
- public function canHandleSignal($signo)
- public function handleSignal($signo)
- final public function newCommand($future)
- final public function loadHardpoints($objects, $requests)
- protected function newPrompts()
- protected function newPrompt($key)
- public function hasPrompt($key)
- public function getPromptMap()
- final public function getPrompt($key)
- final protected function getSymbolEngine()
- final protected function getViewer()
- final protected function readStdin()
- final public function getAbsoluteURI($raw_uri)
- final public function writeToPager($corpus)