Diviner Arcanist Tech Docs PhutilArgumentSpecification

final class PhutilArgumentSpecification
Arcanist Technical Documentation ()

This class is not documented.

Methods

public static function newQuickSpec($spec)

Convenience constructor for building an argument specification from a dictionary. This just wraps all the setter methods, but allows you to define things a little more compactly. Pass an array of properties:

$spec = PhutilArgumentSpecification::newQuickSpec(
  array(
    'name'  => 'verbose',
    'short' => 'v',
  ));

Recognized keys and equivalent verbose methods are:

name        setName()
help        setHelp()
short       setShortAlias()
param       setParamName()
default     setDefault()
conflicts   setConflicts()
wildcard    setWildcard()
repeat      setRepeatable()

Parameters

dict

$spec

Dictionary of quick parameter definitions.

Return

PhutilArgumentSpecification

Constructed argument specification.

public static function newSpecsFromList($specs)

This method is not documented.

Parameters

array

$specs

Return

wild

public function setName($name)

This method is not documented.

Parameters

$name

Return

wild

private static function validateName($name)

This method is not documented.

Parameters

$name

Return

wild

public function getName()

This method is not documented.

Return

wild

public function setHelp($help)

This method is not documented.

Parameters

$help

Return

wild

public function getHelp()

This method is not documented.

Return

wild

public function setShortAlias($short_alias)

This method is not documented.

Parameters

$short_alias

Return

wild

private static function validateShortAlias($alias)

This method is not documented.

Parameters

$alias

Return

wild

public function getShortAlias()

This method is not documented.

Return

wild

public function setParamName($param_name)

This method is not documented.

Parameters

$param_name

Return

wild

public function getParamName()

This method is not documented.

Return

wild

public function setDefault($default)

This method is not documented.

Parameters

$default

Return

wild

public function getDefault()

This method is not documented.

Return

wild

public function setConflicts($conflicts)

This method is not documented.

Parameters

array

$conflicts

Return

wild

public function getConflicts()

This method is not documented.

Return

wild

public function setWildcard($wildcard)

This method is not documented.

Parameters

$wildcard

Return

wild

public function getWildcard()

This method is not documented.

Return

wild

public function setRepeatable($repeatable)

This method is not documented.

Parameters

$repeatable

Return

wild

public function getRepeatable()

This method is not documented.

Return

wild

public function setStandard($standard)

This method is not documented.

Parameters

$standard

Return

wild

public function getStandard()

This method is not documented.

Return

wild

public function validate()

This method is not documented.

Return

wild

Defined: src/parser/argument/PhutilArgumentSpecification.php:3

final class PhutilArgumentSpecificationArcanist Technical Documentation ()

Methods

public static function newQuickSpec($spec)

public static function newSpecsFromList($specs)

public function setName($name)

private static function validateName($name)

public function getName()

public function setHelp($help)

public function getHelp()

public function setShortAlias($short_alias)

private static function validateShortAlias($alias)

public function getShortAlias()

public function setParamName($param_name)

public function getParamName()

public function setDefault($default)

public function getDefault()

public function setConflicts($conflicts)

public function getConflicts()

public function setWildcard($wildcard)

public function getWildcard()

public function setRepeatable($repeatable)

public function getRepeatable()

public function setStandard($standard)

public function getStandard()

public function validate()

final class PhutilArgumentSpecification
Arcanist Technical Documentation ()