Issues in Annotations.php - All Issues - Inspection of "Merge pull request #865 from lukasbestle/feature/s..." - phpmd/phpmd - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 902a34...c826a7 )

by Kyle

created 2021-04-16 22:41 UTC

src/main/php/PHPMD/Node/Annotations.php (1 issue)

Labels

Severity

Minor 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?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\Node;

use PHPMD\Rule;

/**
 * Collection of code annotations.
 */
class Annotations
{
    /**
     * Detected annotations.
     *
     * @var \PHPMD\Node\Annotation[]
     */
    private $annotations = array();

    /**
     * Regexp used to extract code annotations.
     *
     * @var string
     */
    private $regexp = '(@([a-z_][a-z0-9_]+)\(([^\)]+)\))i';

    /**
     * Constructs a new collection instance.
     *
     * @param \PHPMD\AbstractNode $node
     */
    public function __construct(\PHPMD\AbstractNode $node)
    {
        preg_match_all($this->regexp, $node->getDocComment(), $matches);
class ParentClass {
    private $data = array();

    public function __call($method, array $args) {
        if (0 === strpos($method, 'get')) {
            return $this->data[strtolower(substr($method, 3))];
        }

        throw new \LogicException(sprintf('Unsupported method: %s', $method));
    }
}

/**
 * If this class knows which fields exist, you can specify the methods here:
 *
 * @method string getName()
 */
class SomeClass extends ParentClass { }
        foreach (array_keys($matches[0]) as $i) {
            $name = $matches[1][$i];
            $value = trim($matches[2][$i], '" ');

            $this->annotations[] = new Annotation($name, $value);
        }
    }

    /**
     * Checks if one of the annotations suppresses the given rule.
     *
     * @param \PHPMD\Rule $rule
     * @return boolean
     */
    public function suppresses(Rule $rule)
    {
        foreach ($this->annotations as $annotation) {
            if ($annotation->suppresses($rule)) {
                return true;
            }
        }

        return false;
    }
}


1		<?php
2		/**
3		* This file is part of PHP Mess Detector.
4		*
5		* Copyright (c) Manuel Pichler <[email protected]>.
6		* All rights reserved.
7		*
8		* Licensed under BSD License
9		* For full copyright and license information, please see the LICENSE file.
10		* Redistributions of files must retain the above copyright notice.
11		*
12		* @author Manuel Pichler <[email protected]>
13		* @copyright Manuel Pichler. All rights reserved.
14		* @license https://opensource.org/licenses/bsd-license.php BSD License
15		* @link http://phpmd.org/
16		*/
17
18		namespace PHPMD\Node;
19
20		use PHPMD\Rule;
21
22		/**
23		* Collection of code annotations.
24		*/
25		class Annotations
26		{
27		/**
28		* Detected annotations.
29		*
30		* @var \PHPMD\Node\Annotation[]
31		*/
32		private $annotations = array();
33
34		/**
35		* Regexp used to extract code annotations.
36		*
37		* @var string
38		*/
39		private $regexp = '(@([a-z_][a-z0-9_]+)\(([^\)]+)\))i';
40
41		/**
42		* Constructs a new collection instance.
43		*
44		* @param \PHPMD\AbstractNode $node
45		*/
46	12	public function __construct(\PHPMD\AbstractNode $node)
47		{
48	12	preg_match_all($this->regexp, $node->getDocComment(), $matches);
		0 ignored issues – show Documentation Bug introduced 2015-11-24 14:03 UTC by Report Bug Copy Issue Report Show Similar Issues like this The method `getDocComment` does not exist on `object<PHPMD\AbstractNode>`? Since you implemented `__call`, maybe consider adding a @method annotation. If you implement `__call` and you know which methods are available, you can improve IDE auto-completion and static analysis by adding a @method annotation to the class. This is often the case, when `__call` is implemented by a parent class and only the child class knows which methods exist: class ParentClass { private $data = array(); public function __call($method, array $args) { if (0 === strpos($method, 'get')) { return $this->data[strtolower(substr($method, 3))]; } throw new \LogicException(sprintf('Unsupported method: %s', $method)); } } /** * If this class knows which fields exist, you can specify the methods here: * * @method string getName() */ class SomeClass extends ParentClass { } Loading history...
49	12	foreach (array_keys($matches[0]) as $i) {
50	6	$name = $matches[1][$i];
51	6	$value = trim($matches[2][$i], '" ');
52
53	6	$this->annotations[] = new Annotation($name, $value);
54		}
55	12	}
56
57		/**
58		* Checks if one of the annotations suppresses the given rule.
59		*
60		* @param \PHPMD\Rule $rule
61		* @return boolean
62		*/
63	12	public function suppresses(Rule $rule)
64		{
65	12	foreach ($this->annotations as $annotation) {
66	6	if ($annotation->suppresses($rule)) {
67	5	return true;
68		}
69		}
70	9
71		return false;
72		}
73		}
74

phpmd / phpmd

Push — master ( 902a34...c826a7 )

src/main/php/PHPMD/Node/Annotations.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like