ArcanistLintMessage.php
79be59863e9dmaster

ArcanistLintMessage.php
View Options

			<?php

			/**
			* Message emitted by a linter, like an error or warning.
			*
			* @group lint
			*/
			final class ArcanistLintMessage {

			protected $path;
			protected $line;
			protected $char;
			protected $code;
			protected $severity;
			protected $name;
			protected $description;
			protected $originalText;
			protected $replacementText;
			protected $appliedToDisk;
			protected $dependentMessages = array();
			protected $otherLocations = array();
			protected $obsolete;
			protected $granularity;
			protected $bypassChangedLineFiltering;

			public static function newFromDictionary(array $dict) {
			$message = new ArcanistLintMessage();

			$message->setPath($dict['path']);
			$message->setLine($dict['line']);
			$message->setChar($dict['char']);
			$message->setCode($dict['code']);
			$message->setSeverity($dict['severity']);
			$message->setName($dict['name']);
			$message->setDescription($dict['description']);
			if (isset($dict['original'])) {
			$message->setOriginalText($dict['original']);
			}
			if (isset($dict['replacement'])) {
			$message->setReplacementText($dict['replacement']);
			}
			$message->setGranularity(idx($dict, 'granularity'));
			$message->setOtherLocations(idx($dict, 'locations', array()));
			if (isset($dict['bypassChangedLineFiltering'])) {
			$message->bypassChangedLineFiltering($dict['bypassChangedLineFiltering']);
			}
			return $message;
			}

			public function toDictionary() {
			return array(
			'path' => $this->getPath(),
			'line' => $this->getLine(),
			'char' => $this->getChar(),
			'code' => $this->getCode(),
			'severity' => $this->getSeverity(),
			'name' => $this->getName(),
			'description' => $this->getDescription(),
			'original' => $this->getOriginalText(),
			'replacement' => $this->getReplacementText(),
			'granularity' => $this->getGranularity(),
			'locations' => $this->getOtherLocations(),
			'bypassChangedLineFiltering' => $this->shouldBypassChangedLineFiltering(),
			);
			}

			public function setPath($path) {
			$this->path = $path;
			return $this;
			}

			public function getPath() {
			return $this->path;
			}

			public function setLine($line) {
			$this->line = $line;
			return $this;
			}

			public function getLine() {
			return $this->line;
			}

			public function setChar($char) {
			$this->char = $char;
			return $this;
			}

			public function getChar() {
			return $this->char;
			}

			public function setCode($code) {
			$this->code = $code;
			return $this;
			}

			public function getCode() {
			return $this->code;
			}

			public function setSeverity($severity) {
			$this->severity = $severity;
			return $this;
			}

			public function getSeverity() {
			return $this->severity;
			}

			public function setName($name) {
			$this->name = $name;
			return $this;
			}

			public function getName() {
			return $this->name;
			}

			public function setDescription($description) {
			$this->description = $description;
			return $this;
			}

			public function getDescription() {
			return $this->description;
			}

			public function setOriginalText($original) {
			$this->originalText = $original;
			return $this;
			}

			public function getOriginalText() {
			return $this->originalText;
			}

			public function setReplacementText($replacement) {
			$this->replacementText = $replacement;
			return $this;
			}

			public function getReplacementText() {
			return $this->replacementText;
			}

			/**
			* @param dict Keys 'path', 'line', 'char', 'original'.
			*/
			public function setOtherLocations(array $locations) {
			assert_instances_of($locations, 'array');
			$this->otherLocations = $locations;
			return $this;
			}

			public function getOtherLocations() {
			return $this->otherLocations;
			}

			public function isError() {
			return $this->getSeverity() == ArcanistLintSeverity::SEVERITY_ERROR;
			}

			public function isWarning() {
			return $this->getSeverity() == ArcanistLintSeverity::SEVERITY_WARNING;
			}

			public function isAutofix() {
			return $this->getSeverity() == ArcanistLintSeverity::SEVERITY_AUTOFIX;
			}

			public function hasFileContext() {
			return ($this->getLine() !== null);
			}

			public function setObsolete($obsolete) {
			$this->obsolete = $obsolete;
			return $this;
			}

			public function getObsolete() {
			return $this->obsolete;
			}

			public function isPatchable() {
			return ($this->getReplacementText() !== null) &&
			($this->getReplacementText() !== $this->getOriginalText());
			}

			public function didApplyPatch() {
			if ($this->appliedToDisk) {
			return $this;
			}
			$this->appliedToDisk = true;
			foreach ($this->dependentMessages as $message) {
			$message->didApplyPatch();
			}
			return $this;
			}

			public function isPatchApplied() {
			return $this->appliedToDisk;
			}

			public function setGranularity($granularity) {
			$this->granularity = $granularity;
			return $this;
			}

			public function getGranularity() {
			return $this->granularity;
			}

			public function setDependentMessages(array $messages) {
			assert_instances_of($messages, 'ArcanistLintMessage');
			$this->dependentMessages = $messages;
			return $this;
			}

			public function setBypassChangedLineFiltering($bypass_changed_lines) {
			$this->bypassChangedLineFiltering = $bypass_changed_lines;
			return $this;
			}

			public function shouldBypassChangedLineFiltering() {
			return $this->bypassChangedLineFiltering;
			}

			}

Owner Packages

No Owners

rARC/src/lint/ArcanistLintMessage.php79be59863e9dmaster

ArcanistLintMessage.phpView Options

Owner Packages

rARC/src/lint/ArcanistLintMessage.php
79be59863e9dmaster

ArcanistLintMessage.php
View Options