Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/cartforge.co/vendor/phpmd/phpmd/src/main/php/PHPMD/ |
<?php
/**
* This file is part of PHP Mess Detector.
*
* Copyright (c) Manuel Pichler <[email protected]>.
* All rights reserved.
*
* Licensed under BSD License
* For full copyright and license information, please see the LICENSE file.
* Redistributions of files must retain the above copyright notice.
*
* @author Manuel Pichler <[email protected]>
* @copyright Manuel Pichler. All rights reserved.
* @license https://opensource.org/licenses/bsd-license.php BSD License
* @link http://phpmd.org/
*/
namespace PHPMD;
use PHPMD\Node\AbstractTypeNode;
use PHPMD\Node\ClassNode;
use PHPMD\Node\EnumNode;
use PHPMD\Node\InterfaceNode;
use PHPMD\Node\NodeInfoFactory;
use PHPMD\Node\TraitNode;
/**
* This is the abstract base class for pmd rules.
*
* @SuppressWarnings(PHPMD)
*/
abstract class AbstractRule implements Rule
{
/**
* The name for this rule instance.
*
* @var string $_name
*/
private $name = '';
/**
* The violation message text for this rule.
*
* @var string
*/
private $message = '';
/**
* The version since when this rule is available.
*
* @var string
*/
private $since = null;
/**
* An url will external information for this rule.
*
* @var string
*/
private $externalInfoUrl = '';
/**
* An optional description for this rule.
*
* @var string
*/
private $description = '';
/**
* A list of code examples for this rule.
*
* @var array(string)
*/
private $examples = array();
/**
* The name of the parent rule-set instance.
*
* @var string
*/
private $ruleSetName = '';
/**
* The priority of this rule.
*
* @var integer
*/
private $priority = self::LOWEST_PRIORITY;
/**
* Configuration properties for this rule instance.
*
* @var array(string=>string)
*/
private $properties = array();
/**
* The report for object for this rule.
*
* @var \PHPMD\Report
*/
private $report = null;
/**
* Should this rule force the strict mode.
*
* @var boolean
*/
private $strict = false;
/**
* Returns the name for this rule instance.
*
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Sets the name for this rule instance.
*
* @param string $name The rule name.
* @return void
*/
public function setName($name)
{
$this->name = $name;
}
/**
* Returns the version since when this rule is available or <b>null</b>.
*
* @return string
*/
public function getSince()
{
return $this->since;
}
/**
* Sets the version since when this rule is available.
*
* @param string $since The version number.
* @return void
*/
public function setSince($since)
{
$this->since = $since;
}
/**
* Returns the violation message text for this rule.
*
* @return string
*/
public function getMessage()
{
return $this->message;
}
/**
* Sets the violation message text for this rule.
*
* @param string $message The violation message
* @return void
*/
public function setMessage($message)
{
$this->message = $message;
}
/**
* Returns an url will external information for this rule.
*
* @return string
*/
public function getExternalInfoUrl()
{
return $this->externalInfoUrl;
}
/**
* Sets an url will external information for this rule.
*
* @param string $externalInfoUrl The info url.
* @return void
*/
public function setExternalInfoUrl($externalInfoUrl)
{
$this->externalInfoUrl = $externalInfoUrl;
}
/**
* Returns the description text for this rule instance.
*
* @return string
*/
public function getDescription()
{
return $this->description;
}
/**
* Sets the description text for this rule instance.
*
* @param string $description The description text.
* @return void
*/
public function setDescription($description)
{
$this->description = $description;
}
/**
* Returns a list of examples for this rule.
*
* @return string[]
*/
public function getExamples()
{
return $this->examples;
}
/**
* Adds a code example for this rule.
*
* @param string $example The code example.
* @return void
*/
public function addExample($example)
{
$this->examples[] = $example;
}
/**
* Returns the priority of this rule.
*
* @return integer
*/
public function getPriority()
{
return $this->priority;
}
/**
* Set the priority of this rule.
*
* @param integer $priority The rule priority
* @return void
*/
public function setPriority($priority)
{
$this->priority = $priority;
}
/**
* Returns the name of the parent rule-set instance.
*
* @return string
*/
public function getRuleSetName()
{
return $this->ruleSetName;
}
/**
* Sets the name of the parent rule set instance.
*
* @param string $ruleSetName The rule-set name.
* @return void
*/
public function setRuleSetName($ruleSetName)
{
$this->ruleSetName = $ruleSetName;
}
/**
* Returns the violation report for this rule.
*
* @return \PHPMD\Report
*/
public function getReport()
{
return $this->report;
}
/**
* Sets the violation report for this rule.
*
* @param \PHPMD\Report $report
* @return void
*/
public function setReport(Report $report)
{
$this->report = $report;
}
/**
* Adds a configuration property to this rule instance.
*
* @param string $name
* @param string $value
* @return void
*/
public function addProperty($name, $value)
{
$this->properties[$name] = $value;
}
/**
* Returns the value of a configured property
*
* Throws an exception when no property with <b>$name</b> exists
* and no default value to fall back was given.
*
* @param string $name The name of the property, e.g. "ignore-whitespace".
* @param mixed $default An optional default value to fall back instead of throwing an exception.
* @return mixed The value of a configured property.
* @throws \OutOfBoundsException When no property for <b>$name</b> exists and
* no default value to fall back was given.
*/
protected function getProperty($name, $default = null)
{
if (isset($this->properties[$name])) {
return $this->properties[$name];
}
if ($default !== null) {
return $default;
}
throw new \OutOfBoundsException('Property "' . $name . '" does not exist.');
}
/**
* Returns the value of a configured property as a boolean
*
* Throws an exception when no property with <b>$name</b> exists
* and no default value to fall back was given.
*
* @param string $name The name of the property, e.g. "ignore-whitespace".
* @param bool $default An optional default value to fall back instead of throwing an exception.
* @return bool The value of a configured property as a boolean.
* @throws \OutOfBoundsException When no property for <b>$name</b> exists and
* no default value to fall back was given.
*/
public function getBooleanProperty($name, $default = null)
{
return in_array($this->getProperty($name, $default), array('true', 'on', 1), false);
}
/**
* Returns the value of a configured property as an integer
*
* Throws an exception when no property with <b>$name</b> exists
* and no default value to fall back was given.
*
* @param string $name The name of the property, e.g. "minimum".
* @param int $default An optional default value to fall back instead of throwing an exception.
* @return int The value of a configured property as an integer.
* @throws \OutOfBoundsException When no property for <b>$name</b> exists and
* no default value to fall back was given.
*/
public function getIntProperty($name, $default = null)
{
return (int)$this->getProperty($name, $default);
}
/**
* Returns the raw string value of a configured property
*
* Throws an exception when no property with <b>$name</b> exists
* and no default value to fall back was given.
*
* @param string $name The name of the property, e.g. "exceptions".
* @param string|null $default An optional default value to fall back instead of throwing an exception.
* @return string The raw string value of a configured property.
* @throws \OutOfBoundsException When no property for <b>$name</b> exists and
* no default value to fall back was given.
*/
public function getStringProperty($name, $default = null)
{
return (string)$this->getProperty($name, $default);
}
/**
* @param bool $strict
* @return void
*/
public function setStrict($strict)
{
$this->strict = $strict;
}
/**
* This method adds a violation to all reports for this violation type and
* for the given <b>$node</b> instance.
*
* @param \PHPMD\AbstractNode $node
* @param array $args
* @param mixed $metric
* @return void
*/
protected function addViolation(
AbstractNode $node,
array $args = array(),
$metric = null
) {
$message = array(
'message' => $this->message,
'args' => $args,
);
$ruleViolation = new RuleViolation($this, NodeInfoFactory::fromNode($node), $message, $metric);
$this->report->addRuleViolation($ruleViolation);
}
/**
* Apply the current rule on each method of a class node.
*
* @param ClassNode|InterfaceNode|TraitNode|EnumNode $node class node containing methods.
*/
protected function applyOnClassMethods(AbstractTypeNode $node)
{
foreach ($node->getMethods() as $method) {
if (!$this->strict && $method->hasSuppressWarningsAnnotationFor($this)) {
continue;
}
$this->apply($method);
}
}
/**
* This method should implement the violation analysis algorithm of concrete
* rule implementations. All extending classes must implement this method.
*
* @param \PHPMD\AbstractNode $node
* @return void
*/
abstract public function apply(AbstractNode $node);
}