Page MenuHomePhorge
Diviner Arcanist Tech Docs ArcanistConfigurationManager

final class ArcanistConfigurationManager
Arcanist Technical Documentation ()

This class holds everything related to configuration and configuration files.

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.

public function setWorkingCopyIdentity($working_copy)

This method is not documented.
Parameters
ArcanistWorkingCopyIdentity$working_copy
Return
wild

public function getProjectConfig($key)

This method is not documented.
Parameters
$key
Return
wild

public function getLocalConfig($key)

This method is not documented.
Parameters
$key
Return
wild

public function getWorkingCopyIdentity()

This method is not documented.
Return
wild

public function getConfigFromAnySource($key, $default)

Read a configuration directive from any available configuration source. This includes the directive in local, user and system configuration in addition to project configuration, and configuration provided as command arguments ("runtime"). The precedence is runtime > local > project > user > system

Parameters
key$keyKey to read.
wild$defaultDefault value if key is not found.
Return
wildValue, or default value if not found.

public function getConfigFromAllSources($key)

For the advanced case where you want customized configuration handling.

Reads the configuration from all available sources, returning a map (array) of results, with the source as key. Missing values will not be in the map, so an empty array will be returned if no results are found.

The map is ordered by the canonical sources precedence, which is: runtime > local > project > user > system

Parameters
key$keyKey to read
Return
arrayMapping of source => value read. Sources with no value are not in the array.

public function setRuntimeConfig($key, $value)

Sets a runtime config value that takes precedence over any static config values.

Parameters
key$keyKey to set.
value$valueThe value of the key.
Return
wild

public function readLocalArcConfig()

This method is not documented.
Return
wild

public function writeLocalArcConfig($config)

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

public function readUserConfigurationFile()

This is probably not the method you're looking for; try readUserArcConfig().

Return
wild

public function writeUserConfigurationFile($config)

This is probably not the method you're looking for; try writeUserArcConfig().

Parameters
$config
Return
wild

public function setUserConfigurationFileLocation($custom_arcrc)

This method is not documented.
Parameters
$custom_arcrc
Return
wild
This method is not documented.
Return
wild

public function readUserArcConfig()

This method is not documented.
Return
wild

public function writeUserArcConfig($options)

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

public function getSystemArcConfigLocation()

This method is not documented.
Return
wild

public function readSystemArcConfig()

This method is not documented.
Return
wild

public function applyRuntimeArcConfig($args)

This method is not documented.
Parameters
$args
Return
wild

public function readDefaultConfig()

This method is not documented.
Return
wild