Page MenuHomePhorge
Diviner Arcanist Tech Docs ArcanistXHPASTLinterRule

abstract class ArcanistXHPASTLinterRule
Arcanist Technical Documentation (Lint)

This class is not documented.

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.

final public static function loadAllRules()

This method is not documented.
Return
wild

final public function getLintID()

This method is not documented.
Return
wild

abstract public function getLintName()

This method is not documented.
Return
wild

public function getLintSeverity()

This method is not documented.
Return
wild
This method is not documented.
Return
wild

public function setLinterConfigurationValue($key, $value)

This method is not documented.
Parameters
$key
$value
Return
wild

abstract public function process($root)

This method is not documented.
Parameters
XHPASTNode$root
Return
wild

final public function setLinter($linter)

This method is not documented.
Parameters
ArcanistXHPASTLinter$linter
Return
wild

final public function getActivePath()

This method is not documented.
Return
wild

final public function getOtherLocation($offset, $path)

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

final protected function raiseLintAtPath($desc)

This method is not documented.
Parameters
$desc
Return
wild

final public function raiseLintAtOffset($offset, $description, $original, $replacement)

This method is not documented.
Parameters
$offset
$description
$original
$replacement
Return
wild

final protected function raiseLintAtToken($token, $description, $replace)

This method is not documented.
Parameters
XHPASTToken$token
$description
$replace
Return
wild

final protected function raiseLintAtNode($node, $description, $replace)

This method is not documented.
Parameters
XHPASTNode$node
$description
$replace
Return
wild

protected function evaluateStaticBoolean($string)

Statically evaluate a boolean value from an XHP tree.

TODO: Improve this and move it to XHPAST proper?

Parameters
string$stringThe "semantic string" of a single value.
Return
mixed`true` or `false` if the value could be evaluated statically; `null` if static evaluation was not possible.

protected function getAnonymousClosures($root)

Retrieve all anonymous closure(s).

Returns all descendant nodes which represent an anonymous function declaration.

Parameters
XHPASTNode$rootRoot node.
Return
AASTNodeList

protected function getConcreteVariableString($variable)

TODO

Parameters
XHPASTNode$variable
Return
string

protected function getFunctionCalls($root, $function_names)

Retrieve all calls to some specified function(s).

Returns all descendant nodes which represent a function call to one of the specified functions.

Parameters
XHPASTNode$rootRoot node.
list<string>$function_namesFunction names.
Return
AASTNodeList

final protected function getModifiers($node)

Get class/method modifiers.

Parameters
XHPASTNode$nodeA node of type `n_CLASS_DECLARATION` or `n_METHOD_DECLARATION`.
Return
map<string, bool>Class/method modifiers.

public function getSuperGlobalNames()

Get PHP superglobals.

Return
list<string>