Human Readable Information
Human Readable Information
- public function getInfoURI() — Return an optional informative URI where humans can learn more about this linter.
- public function getInfoDescription() — Return a brief human-readable description of the linter.
- public function getAdditionalInformation() — Return arbitrary additional information.
- public function getInfoName() — Return a human-readable linter name.
Runtime State
Runtime State
- final public function getActivePath()
- final public function setActivePath($path)
- final public function setEngine($engine)
- final protected function getEngine()
- final public function setLinterID($id) — Set the internal ID for this linter.
- final public function getLinterID() — Get the internal ID for this linter.
Executing Linters
Executing Linters
- public function willLintPaths($paths) — Hook called before a list of paths are linted.
- public function lintPath($path) — Hook called for each path to be linted.
- public function didLintPaths($paths) — Hook called after a list of paths are linted.
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.
- public function getLinterPriority()
- public function setCustomSeverityMap($map)
- public function addCustomSeverityMap($map)
- public function setCustomSeverityRules($rules)
- final public function getProjectRoot()
- final public function getOtherLocation($offset, $path)
- final public function stopAllLinters()
- final public function didStopAllLinters()
- final public function addPath($path)
- final public function setPaths($paths)
- private function filterPaths($paths) — Filter out paths which this linter doesn't act on (for example, because they are binaries and the linter doesn't apply to binaries).
- final public function getPaths()
- final public function addData($path, $data)
- final protected function getData($path)
- public function getCacheVersion()
- final public function getLintMessageFullCode($short_code)
- final public function getLintMessageSeverity($code)
- protected function getDefaultMessageSeverity($code)
- final public function isMessageEnabled($code)
- final public function getLintMessageName($code)
- final protected function addLintMessage($message)
- final public function getLintMessages()
- final public function raiseLintAtLine($line, $char, $code, $description, $original, $replacement)
- final public function raiseLintAtPath($code, $desc)
- final public function raiseLintAtOffset($offset, $code, $description, $original, $replacement)
- public function canRun()
- abstract public function getLinterName()
- public function getVersion()
- final protected function isCodeEnabled($code)
- public function getLintSeverityMap()
- public function getLintNameMap()
- public function getCacheGranularity()
- public function getLinterConfigurationName() — If this linter is selectable via `.arclint` configuration files, return a short, human-readable name to identify it. For example, `"jshint"` or `"pep8"`.
- public function getLinterConfigurationOptions()
- public function setLinterConfigurationValue($key, $value)
- protected function canCustomizeLintSeverities()
- protected function shouldLintBinaryFiles()
- protected function shouldLintDeletedFiles()
- protected function shouldLintDirectories()
- protected function shouldLintSymbolicLinks()
- protected function getLintCodeFromLinterConfigurationKey($code) — Map a configuration lint code to an `arc` lint code. Primarily, this is intended for validation, but can also be used to normalize case or otherwise be more permissive in accepted inputs.