PHPMD::getOptions() - Code Metrics - Inspection of "test" - SomeBlackMagic/phpmd - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#18)

by Andru

created 2019-01-18 11:52 UTC

PHPMD::getOptions() A

↳ Parent: PHPMD

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	4
rs	10
c	0
b	0
f	0
ccs	2
cts	2
cp	1
crap	1

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

/**
 * This is the main facade of the PHP PMD application
 */
class PHPMD
{
    /**
     * The current PHPMD version.
     */
    const VERSION = '@project.version@';

    /**
     * List of valid file extensions for analyzed files.
     *
     * @var array(string)
     */
    private $fileExtensions = array('php', 'php3', 'php4', 'php5', 'inc');

    /**
     * List of exclude directory patterns.
     *
     * @var array(string)
     */
    private $ignorePatterns = array('.git', '.svn', 'CVS', '.bzr', '.hg', 'SCCS');

    /**
     * The input source file or directory.
     *
     * @var string
     */
    private $input;

    /**
     * This property will be set to <b>true</b> when an error or a violation
     * was found in the processed source code.
     *
     * @var boolean
     * @since 0.2.5
     */
    private $violations = false;

    /**
     * Additional options for PHPMD or one of it's parser backends.
     *
     * @var array
     * @since 1.2.0
     */
    private $options = array();

    /**
     * This method will return <b>true</b> when the processed source code
     * contains violations.
     *
     * @return boolean
     * @since 0.2.5
     */
    public function hasViolations()
    {
        return $this->violations;
    }

    /**
     * Returns the input source file or directory path.
     *
     * @return string
     */
    public function getInput()
    {
        return $this->input;
    }

    /**
     * Returns an array with valid php source file extensions.
     *
     * @return string[]
     * @since 0.2.0
     */
    public function getFileExtensions()
    {
        return $this->fileExtensions;
    }

    /**
     * Sets a list of filename extensions for valid php source code files.
     *
     * @param array(string) $fileExtensions Extensions without leading dot.

     * @return void
     */
    public function setFileExtensions(array $fileExtensions)
    {
        $this->fileExtensions = $fileExtensions;
    }

    /**
     * Returns an array with string patterns that mark a file path as invalid.
     *
     * @return string[]
     * @since 0.2.0
     */
    public function getIgnorePattern()
    {
        return $this->ignorePatterns;
    }

    /**
     * Sets a list of ignore patterns that is used to exclude directories from
     * the source analysis.
     *
     * @param array(string) $ignorePatterns List of ignore patterns.

     * @return void
     */
    public function setIgnorePattern(array $ignorePatterns)
    {
        $this->ignorePatterns = array_merge(
            $this->ignorePatterns,
            $ignorePatterns
        );
    }

    /**
     * Returns additional options for PHPMD or one of it's parser backends.
     *
     * @return array
     */
    public function getOptions()
    {
        return $this->options;
    }

    /**
     * Sets additional options for PHPMD or one of it's parser backends.
     *
     * @param array $options Additional backend or PHPMD options.
     * @return void
     */
    public function setOptions(array $options)
    {
        $this->options = $options;
    }

    /**
     * This method will process all files that can be found in the given input
     * path. It will apply rules defined in the comma-separated <b>$ruleSets</b>
     * argument. The result will be passed to all given renderer instances.
     *
     * @param string $inputPath
     * @param string $ruleSets
     * @param \PHPMD\AbstractRenderer[] $renderers
     * @param \PHPMD\RuleSetFactory $ruleSetFactory
     * @return void
     */
    public function processFiles(
        $inputPath,
        $ruleSets,
        array $renderers,
        RuleSetFactory $ruleSetFactory
    ) {

        // Merge parsed excludes
        $this->ignorePatterns = array_merge($this->ignorePatterns, $ruleSetFactory->getIgnorePattern($ruleSets));

        $this->input = $inputPath;

        $report = new Report();

        $factory = new ParserFactory();
        $parser  = $factory->create($this);

        foreach ($ruleSetFactory->createRuleSets($ruleSets) as $ruleSet) {
            $parser->addRuleSet($ruleSet);
        }

        $report->start();
        $parser->parse($report);
        $report->end();

        foreach ($renderers as $renderer) {
            $renderer->start();
        }

        foreach ($renderers as $renderer) {
            $renderer->renderReport($report);
        }

        foreach ($renderers as $renderer) {
            $renderer->end();
        }

        $this->violations = !$report->isEmpty();
    }
}


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;
19
20		/**
21		* This is the main facade of the PHP PMD application
22		*/
23		class PHPMD
24		{
25		/**
26		* The current PHPMD version.
27		*/
28		const VERSION = '@project.version@';
29
30		/**
31		* List of valid file extensions for analyzed files.
32		*
33		* @var array(string)
34		*/
35		private $fileExtensions = array('php', 'php3', 'php4', 'php5', 'inc');
36
37		/**
38		* List of exclude directory patterns.
39		*
40		* @var array(string)
41		*/
42		private $ignorePatterns = array('.git', '.svn', 'CVS', '.bzr', '.hg', 'SCCS');
43
44		/**
45		* The input source file or directory.
46		*
47		* @var string
48		*/
49		private $input;
50
51		/**
52		* This property will be set to <b>true</b> when an error or a violation
53		* was found in the processed source code.
54		*
55		* @var boolean
56		* @since 0.2.5
57		*/
58		private $violations = false;
59
60		/**
61		* Additional options for PHPMD or one of it's parser backends.
62		*
63		* @var array
64		* @since 1.2.0
65		*/
66		private $options = array();
67
68		/**
69		* This method will return <b>true</b> when the processed source code
70		* contains violations.
71		*
72		* @return boolean
73		* @since 0.2.5
74		*/
75	7	public function hasViolations()
76		{
77	7	return $this->violations;
78		}
79
80		/**
81		* Returns the input source file or directory path.
82		*
83		* @return string
84		*/
85	11	public function getInput()
86		{
87	11	return $this->input;
88		}
89
90		/**
91		* Returns an array with valid php source file extensions.
92		*
93		* @return string[]
94		* @since 0.2.0
95		*/
96	11	public function getFileExtensions()
97		{
98	11	return $this->fileExtensions;
99		}
100
101		/**
102		* Sets a list of filename extensions for valid php source code files.
103		*
104		* @param array(string) $fileExtensions Extensions without leading dot.
		0 ignored issues – show Documentation introduced 2019-01-15 20:34 UTC by Report Bug Copy Issue Report The doc-type `array(string)` could not be parsed: Expected "\|" or "end of type", but got "(" at position 5. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
105		* @return void
106		*/
107		public function setFileExtensions(array $fileExtensions)
108		{
109		$this->fileExtensions = $fileExtensions;
110		}
111
112		/**
113		* Returns an array with string patterns that mark a file path as invalid.
114		*
115		* @return string[]
116		* @since 0.2.0
117		*/
118	11	public function getIgnorePattern()
119		{
120	11	return $this->ignorePatterns;
121		}
122
123		/**
124		* Sets a list of ignore patterns that is used to exclude directories from
125		* the source analysis.
126		*
127		* @param array(string) $ignorePatterns List of ignore patterns.
		0 ignored issues – show Documentation introduced 2019-01-15 20:34 UTC by Report Bug Copy Issue Report The doc-type `array(string)` could not be parsed: Expected "\|" or "end of type", but got "(" at position 5. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
128		* @return void
129		*/
130		public function setIgnorePattern(array $ignorePatterns)
131		{
132		$this->ignorePatterns = array_merge(
133		$this->ignorePatterns,
134		$ignorePatterns
135		);
136		}
137
138		/**
139		* Returns additional options for PHPMD or one of it's parser backends.
140		*
141		* @return array
142		*/
143	11	public function getOptions()
144		{
145	11	return $this->options;
146		}
147
148		/**
149		* Sets additional options for PHPMD or one of it's parser backends.
150		*
151		* @param array $options Additional backend or PHPMD options.
152		* @return void
153		*/
154	4	public function setOptions(array $options)
155		{
156	4	$this->options = $options;
157	4	}
158
159		/**
160		* This method will process all files that can be found in the given input
161		* path. It will apply rules defined in the comma-separated <b>$ruleSets</b>
162		* argument. The result will be passed to all given renderer instances.
163		*
164		* @param string $inputPath
165		* @param string $ruleSets
166		* @param \PHPMD\AbstractRenderer[] $renderers
167		* @param \PHPMD\RuleSetFactory $ruleSetFactory
168		* @return void
169		*/
170	11	public function processFiles(
171		$inputPath,
172		$ruleSets,
173		array $renderers,
174		RuleSetFactory $ruleSetFactory
175		) {
176
177		// Merge parsed excludes
178	11	$this->ignorePatterns = array_merge($this->ignorePatterns, $ruleSetFactory->getIgnorePattern($ruleSets));
179
180	11	$this->input = $inputPath;
181
182	11	$report = new Report();
183
184	11	$factory = new ParserFactory();
185	11	$parser = $factory->create($this);
186
187	11	foreach ($ruleSetFactory->createRuleSets($ruleSets) as $ruleSet) {
188	11	$parser->addRuleSet($ruleSet);
189		}
190
191	11	$report->start();
192	11	$parser->parse($report);
193	11	$report->end();
194
195	11	foreach ($renderers as $renderer) {
196	11	$renderer->start();
197		}
198
199	11	foreach ($renderers as $renderer) {
200	11	$renderer->renderReport($report);
201		}
202
203	11	foreach ($renderers as $renderer) {
204	11	$renderer->end();
205		}
206
207	11	$this->violations = !$report->isEmpty();
208	11	}
209		}
210

SomeBlackMagic / phpmd

Pull Request — master (#18)

PHPMD::getOptions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like