CommandLineOptions::getListOfAvailableRenderers() - Code Metrics - Inspection of "Fix Scrutinizer" - SomeBlackMagic/phpmd - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#18)

by Andru

created 2019-01-18 12:33 UTC

CommandLineOptions::getListOfAvailableRenderers() A

↳ Parent: CommandLineOptions

Complexity

Conditions	4
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	4.016

Importance

Changes

Metric	Value
cc	4
nc	6
nop	0
dl	0
loc	19
rs	9.6333
c	0
b	0
f	0
ccs	9
cts	10
cp	0.9
crap	4.016

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

use PHPMD\Renderer\HTMLRenderer;
use PHPMD\Renderer\JSONRenderer;
use PHPMD\Renderer\TextRenderer;
use PHPMD\Renderer\XMLRenderer;
use PHPMD\Rule;

/**
 * This is a helper class that collects the specified cli arguments and puts them
 * into accessible properties.
 */
class CommandLineOptions
{
    /**
     * Error code for invalid input
     */
    const INPUT_ERROR = 23;

    /**
     * The minimum rule priority.
     *
     * @var integer
     */
    protected $minimumPriority = Rule::LOWEST_PRIORITY;

    /**
     * The maximum rule priority.
     *
     * @var integer
     */
    protected $maximumPriority = Rule::HIGHEST_PRIORITY;

    /**
     * A php source code filename or directory.
     *
     * @var string
     */
    protected $inputPath;

    /**
     * The specified report format.
     *
     * @var string
     */
    protected $reportFormat;

    /**
     * An optional filename for the generated report.
     *
     * @var string
     */
    protected $reportFile;

    /**
     * Additional report files.
     *
     * @var array
     */
    protected $reportFiles = array();

    /**
     * A ruleset filename or a comma-separated string of ruleset filenames.
     *
     * @var string
     */
    protected $ruleSets;

    /**
     * File name of a PHPUnit code coverage report.
     *
     * @var string
     */
    protected $coverageReport;

    /**
     * A string of comma-separated extensions for valid php source code filenames.
     *
     * @var string
     */
    protected $extensions;

    /**
     * A string of comma-separated pattern that is used to exclude directories.
     *
     * @var string
     */
    protected $ignore;

    /**
     * Should the shell show the current phpmd version?
     *
     * @var boolean
     */
    protected $version = false;

    /**
     * Should PHPMD run in strict mode?
     *
     * @var boolean
     * @since 1.2.0
     */
    protected $strict = false;

    /**
     * Should PHPMD exit without error code even if violation is found?
     *
     * @var boolean
     */
    protected $ignoreViolationsOnExit = false;

    /**
     * List of available rule-sets.
     *
     * @var array(string)
     */
    protected $availableRuleSets = array();

    /**
     * Constructs a new command line options instance.
     *
     * @param array $args
     * @param array $availableRuleSets
     * @throws \InvalidArgumentException
     */
    public function __construct(array $args, array $availableRuleSets = array())
    {
        // Remove current file name
        array_shift($args);

        $this->availableRuleSets = $availableRuleSets;

        $arguments = array();
        while (($arg = array_shift($args)) !== null) {
            switch ($arg) {
                case '--min-priority':
                case '--minimum-priority':
                case '--minimumpriority':
                    $this->minimumPriority = (int)array_shift($args);
                    break;
                case '--max-priority':
                case '--maximum-priority':
                case '--maximumpriority':
                    $this->maximumPriority = (int)array_shift($args);
                    break;
                case '--report-file':
                case '--reportfile':
                    $this->reportFile = array_shift($args);
                    break;
                case '--input-file':
                case '--inputfile':
                    array_unshift($arguments, $this->readInputFile(array_shift($args)));
                    break;
                case '--coverage':
                    $this->coverageReport = array_shift($args);
                    break;
                case '--extensions':
                    $this->logDeprecated('extensions', 'suffixes');
                    /* Deprecated: We use the suffixes option now */
                    $this->extensions = array_shift($args);
                    break;
                case '--suffixes':
                    $this->extensions = array_shift($args);
                    break;
                case '--ignore':
                    $this->logDeprecated('ignore', 'exclude');
                    /* Deprecated: We use the exclude option now */
                    $this->ignore = array_shift($args);
                    break;
                case '--exclude':
                    $this->ignore = array_shift($args);
                    break;
                case '--version':
                    $this->version = true;

                    return;
                case '--strict':
                    $this->strict = true;
                    break;
                case '--not-strict':
                    $this->strict = false;
                    break;
                case '--ignore-violations-on-exit':
                    $this->ignoreViolationsOnExit = true;
                    break;
                case '--reportfile-html':
                case '--reportfile-text':
                case '--reportfile-xml':
                case '--reportfile-json':
                    preg_match('(^\-\-reportfile\-(xml|html|text|json)$)', $arg, $match);
                    $this->reportFiles[$match[1]] = array_shift($args);
                    break;
                default:
                    $arguments[] = $arg;
                    break;
            }
        }

        if (count($arguments) < 3) {
            throw new \InvalidArgumentException($this->usage(), self::INPUT_ERROR);
        }

        $this->inputPath = (string)array_shift($arguments);
        $this->reportFormat = (string)array_shift($arguments);
        $this->ruleSets = (string)array_shift($arguments);
    }

    /**
     * Returns a php source code filename or directory.
     *
     * @return string
     */
    public function getInputPath()
    {
        return $this->inputPath;
    }

    /**
     * Returns the specified report format.
     *
     * @return string
     */
    public function getReportFormat()
    {
        return $this->reportFormat;
    }

    /**
     * Returns the output filename for a generated report or <b>null</b> when
     * the report should be displayed in STDOUT.
     *
     * @return string
     */
    public function getReportFile()
    {
        return $this->reportFile;
    }

    /**
     * Returns a hash with report files specified for different renderers. The
     * key represents the report format and the value the report file location.
     *
     * @return array
     */
    public function getReportFiles()
    {
        return $this->reportFiles;
    }

    /**
     * Returns a ruleset filename or a comma-separated string of ruleset
     *
     * @return string
     */
    public function getRuleSets()
    {
        return $this->ruleSets;
    }

    /**
     * Returns the minimum rule priority.
     *
     * @return integer
     */
    public function getMinimumPriority()
    {
        return $this->minimumPriority;
    }

    /**
     * Returns the maximum rule priority.
     *
     * @return integer
     */
    public function getMaximumPriority()
    {
        return $this->maximumPriority;
    }

    /**
     * Returns the file name of a supplied code coverage report or <b>NULL</b>
     * if the user has not supplied the --coverage option.
     *
     * @return string
     */
    public function getCoverageReport()
    {
        return $this->coverageReport;
    }

    /**
     * Returns a string of comma-separated extensions for valid php source code
     * filenames or <b>null</b> when this argument was not set.
     *
     * @return string
     */
    public function getExtensions()
    {
        return $this->extensions;
    }

    /**
     * Returns  string of comma-separated pattern that is used to exclude
     * directories or <b>null</b> when this argument was not set.
     *
     * @return string
     */
    public function getIgnore()
    {
        return $this->ignore;
    }

    /**
     * Was the <b>--version</b> passed to PHPMD's command line interface?
     *
     * @return boolean
     */
    public function hasVersion()
    {
        return $this->version;
    }

    /**
     * Was the <b>--strict</b> option passed to PHPMD's command line interface?
     *
     * @return boolean
     * @since 1.2.0
     */
    public function hasStrict()
    {
        return $this->strict;
    }

    /**
     * Was the <b>--ignore-violations-on-exit</b> passed to PHPMD's command line interface?
     *
     * @return boolean
     */
    public function ignoreViolationsOnExit()
    {
        return $this->ignoreViolationsOnExit;
    }

    /**
     * Creates a report renderer instance based on the user's command line
     * argument.
     *
     * Valid renderers are:
     * <ul>
     *   <li>xml</li>
     *   <li>html</li>
     *   <li>text</li>
     *   <li>json</li>
     * </ul>
     *
     * @param string $reportFormat
     * @return \PHPMD\AbstractRenderer
     * @throws \InvalidArgumentException When the specified renderer does not exist.
     */
    public function createRenderer($reportFormat = null)
    {
        $reportFormat = $reportFormat ?: $this->reportFormat;

        switch ($reportFormat) {
            case 'xml':
                return $this->createXmlRenderer();
            case 'html':
                return $this->createHtmlRenderer();
            case 'text':
                return $this->createTextRenderer();
            case 'json':
                return $this->createJsonRenderer();
            default:
                return $this->createCustomRenderer();
        }
    }

    /**
     * @return \PHPMD\Renderer\XMLRenderer
     */
    protected function createXmlRenderer()
    {
        return new XMLRenderer();
    }

    /**
     * @return \PHPMD\Renderer\TextRenderer
     */
    protected function createTextRenderer()
    {
        return new TextRenderer();
    }

    /**
     * @return \PHPMD\Renderer\HTMLRenderer
     */
    protected function createHtmlRenderer()
    {
        return new HTMLRenderer();
    }

    /**
     * @return \PHPMD\Renderer\JSONRenderer
     */
    protected function createJsonRenderer()
    {
        return new JSONRenderer();
    }

    /**
     * @return \PHPMD\AbstractRenderer
     * @throws \InvalidArgumentException
     */
    protected function createCustomRenderer()
    {
        if ('' === $this->reportFormat) {
            throw new \InvalidArgumentException(
                'Can\'t create report with empty format.',
                self::INPUT_ERROR
            );
        }

        if (class_exists($this->reportFormat)) {
            return new $this->reportFormat();
        }

        // Try to load a custom renderer
        $fileName = strtr($this->reportFormat, '_\\', '//') . '.php';

        $fileHandle = @fopen($fileName, 'r', true);
        if (is_resource($fileHandle) === false) {
            throw new \InvalidArgumentException(
                sprintf(
                    'Can\'t find the custom report class: %s',
                    $this->reportFormat
                ),
                self::INPUT_ERROR
            );
        }
        @fclose($fileHandle);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}

        include_once $fileName;

        return new $this->reportFormat();
    }

    /**
     * Returns usage information for the PHPMD command line interface.
     *
     * @return string
     */
    public function usage()
    {
        $availableRenderers = $this->getListOfAvailableRenderers();

        return 'Mandatory arguments:' . \PHP_EOL .
            '1) A php source code filename or directory. Can be a comma-' .
            'separated string' . \PHP_EOL .
            '2) A report format' . \PHP_EOL .
            '3) A ruleset filename or a comma-separated string of ruleset' .
            'filenames' . \PHP_EOL . \PHP_EOL .
            'Available formats: ' . $availableRenderers . '.' . \PHP_EOL .
            'Available rulesets: ' . implode(', ', $this->availableRuleSets) . '.' . \PHP_EOL . \PHP_EOL .
            'Optional arguments that may be put after the mandatory arguments:' .
            \PHP_EOL .
            '--minimumpriority: rule priority threshold; rules with lower ' .
            'priority than this will not be used' . \PHP_EOL .
            '--reportfile: send report output to a file; default to STDOUT' .
            \PHP_EOL .
            '--suffixes: comma-separated string of valid source code ' .
            'filename extensions, e.g. php,phtml' . \PHP_EOL .
            '--exclude: comma-separated string of patterns that are used to ' .
            'ignore directories' . \PHP_EOL .
            '--strict: also report those nodes with a @SuppressWarnings ' .
            'annotation' . \PHP_EOL .
            '--ignore-violations-on-exit: will exit with a zero code, ' .
            'even if any violations are found' . \PHP_EOL;
    }

    /**
     * Get a list of available renderers
     *
     * @return string The list of renderers found.
     */
    protected function getListOfAvailableRenderers()
    {
        $renderersDirPathName=__DIR__.'/../Renderer';
        $renderers = array();

        foreach (scandir($renderersDirPathName) as $rendererFileName) {
            if (preg_match('/^(\w+)Renderer.php$/i', $rendererFileName, $rendererName)) {
                $renderers[] =  strtolower($rendererName[1]);
            }
        }

        sort($renderers);

        if (count($renderers) > 1) {
            return implode(', ', $renderers);
        }

        return array_pop($list);
    }

    /**
     * Logs a deprecated option to the current user interface.
     *
     * @param string $deprecatedName
     * @param string $newName
     * @return void
     */
    protected function logDeprecated($deprecatedName, $newName)
    {
        $message = sprintf(
            'The --%s option is deprecated, please use --%s instead.',
            $deprecatedName,
            $newName
        );

        fwrite(STDERR, $message . PHP_EOL . PHP_EOL);
    }

    /**
     * This method takes the given input file, reads the newline separated paths
     * from that file and creates a comma separated string of the file paths. If
     * the given <b>$inputFile</b> not exists, this method will throw an
     * exception.
     *
     * @param string $inputFile Specified input file name.
     * @return string
     * @throws \InvalidArgumentException If the specified input file does not exist.
     * @since 1.1.0
     */
    protected function readInputFile($inputFile)
    {
        if (file_exists($inputFile)) {
            return join(',', array_map('trim', file($inputFile)));
        }
        throw new \InvalidArgumentException("Input file '{$inputFile}' not exists.");
    }
}


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\TextUI;
19
20		use PHPMD\Renderer\HTMLRenderer;
21		use PHPMD\Renderer\JSONRenderer;
22		use PHPMD\Renderer\TextRenderer;
23		use PHPMD\Renderer\XMLRenderer;
24		use PHPMD\Rule;
25
26		/**
27		* This is a helper class that collects the specified cli arguments and puts them
28		* into accessible properties.
29		*/
30		class CommandLineOptions
31		{
32		/**
33		* Error code for invalid input
34		*/
35		const INPUT_ERROR = 23;
36
37		/**
38		* The minimum rule priority.
39		*
40		* @var integer
41		*/
42		protected $minimumPriority = Rule::LOWEST_PRIORITY;
43
44		/**
45		* The maximum rule priority.
46		*
47		* @var integer
48		*/
49		protected $maximumPriority = Rule::HIGHEST_PRIORITY;
50
51		/**
52		* A php source code filename or directory.
53		*
54		* @var string
55		*/
56		protected $inputPath;
57
58		/**
59		* The specified report format.
60		*
61		* @var string
62		*/
63		protected $reportFormat;
64
65		/**
66		* An optional filename for the generated report.
67		*
68		* @var string
69		*/
70		protected $reportFile;
71
72		/**
73		* Additional report files.
74		*
75		* @var array
76		*/
77		protected $reportFiles = array();
78
79		/**
80		* A ruleset filename or a comma-separated string of ruleset filenames.
81		*
82		* @var string
83		*/
84		protected $ruleSets;
85
86		/**
87		* File name of a PHPUnit code coverage report.
88		*
89		* @var string
90		*/
91		protected $coverageReport;
92
93		/**
94		* A string of comma-separated extensions for valid php source code filenames.
95		*
96		* @var string
97		*/
98		protected $extensions;
99
100		/**
101		* A string of comma-separated pattern that is used to exclude directories.
102		*
103		* @var string
104		*/
105		protected $ignore;
106
107		/**
108		* Should the shell show the current phpmd version?
109		*
110		* @var boolean
111		*/
112		protected $version = false;
113
114		/**
115		* Should PHPMD run in strict mode?
116		*
117		* @var boolean
118		* @since 1.2.0
119		*/
120		protected $strict = false;
121
122		/**
123		* Should PHPMD exit without error code even if violation is found?
124		*
125		* @var boolean
126		*/
127		protected $ignoreViolationsOnExit = false;
128
129		/**
130		* List of available rule-sets.
131		*
132		* @var array(string)
133		*/
134		protected $availableRuleSets = array();
135
136		/**
137		* Constructs a new command line options instance.
138		*
139		* @param array $args
140		* @param array $availableRuleSets
141		* @throws \InvalidArgumentException
142		*/
143	40	public function __construct(array $args, array $availableRuleSets = array())
144		{
145		// Remove current file name
146	40	array_shift($args);
147
148	40	$this->availableRuleSets = $availableRuleSets;
149
150	40	$arguments = array();
151	40	while (($arg = array_shift($args)) !== null) {
152	40	switch ($arg) {
153		case '--min-priority':
154		case '--minimum-priority':
155		case '--minimumpriority':
156	1	$this->minimumPriority = (int)array_shift($args);
157	1	break;
158		case '--max-priority':
159		case '--maximum-priority':
160		case '--maximumpriority':
161	1	$this->maximumPriority = (int)array_shift($args);
162	1	break;
163		case '--report-file':
164		case '--reportfile':
165	4	$this->reportFile = array_shift($args);
166	4	break;
167		case '--input-file':
168		case '--inputfile':
169	6	array_unshift($arguments, $this->readInputFile(array_shift($args)));
170	5	break;
171		case '--coverage':
172	1	$this->coverageReport = array_shift($args);
173	1	break;
174		case '--extensions':
175	1	$this->logDeprecated('extensions', 'suffixes');
176		/* Deprecated: We use the suffixes option now */
177	1	$this->extensions = array_shift($args);
178	1	break;
179		case '--suffixes':
180		$this->extensions = array_shift($args);
181		break;
182		case '--ignore':
183	1	$this->logDeprecated('ignore', 'exclude');
184		/* Deprecated: We use the exclude option now */
185	1	$this->ignore = array_shift($args);
186	1	break;
187		case '--exclude':
188		$this->ignore = array_shift($args);
189		break;
190		case '--version':
191	1	$this->version = true;
192
193	1	return;
194		case '--strict':
195	1	$this->strict = true;
196	1	break;
197		case '--not-strict':
198		$this->strict = false;
199		break;
200		case '--ignore-violations-on-exit':
201	1	$this->ignoreViolationsOnExit = true;
202	1	break;
203		case '--reportfile-html':
204		case '--reportfile-text':
205		case '--reportfile-xml':
206		case '--reportfile-json':
207	4	preg_match('(^\-\-reportfile\-(xml\|html\|text\|json)$)', $arg, $match);
208	4	$this->reportFiles[$match[1]] = array_shift($args);
209	4	break;
210		default:
211	39	$arguments[] = $arg;
212	39	break;
213		}
214		}
215
216	38	if (count($arguments) < 3) {
217	1	throw new \InvalidArgumentException($this->usage(), self::INPUT_ERROR);
218		}
219
220	37	$this->inputPath = (string)array_shift($arguments);
221	37	$this->reportFormat = (string)array_shift($arguments);
222	37	$this->ruleSets = (string)array_shift($arguments);
223	37	}
224
225		/**
226		* Returns a php source code filename or directory.
227		*
228		* @return string
229		*/
230	6	public function getInputPath()
231		{
232	6	return $this->inputPath;
233		}
234
235		/**
236		* Returns the specified report format.
237		*
238		* @return string
239		*/
240	2	public function getReportFormat()
241		{
242	2	return $this->reportFormat;
243		}
244
245		/**
246		* Returns the output filename for a generated report or <b>null</b> when
247		* the report should be displayed in STDOUT.
248		*
249		* @return string
250		*/
251	4	public function getReportFile()
252		{
253	4	return $this->reportFile;
254		}
255
256		/**
257		* Returns a hash with report files specified for different renderers. The
258		* key represents the report format and the value the report file location.
259		*
260		* @return array
261		*/
262	8	public function getReportFiles()
263		{
264	8	return $this->reportFiles;
265		}
266
267		/**
268		* Returns a ruleset filename or a comma-separated string of ruleset
269		*
270		* @return string
271		*/
272	6	public function getRuleSets()
273		{
274	6	return $this->ruleSets;
275		}
276
277		/**
278		* Returns the minimum rule priority.
279		*
280		* @return integer
281		*/
282	6	public function getMinimumPriority()
283		{
284	6	return $this->minimumPriority;
285		}
286
287		/**
288		* Returns the maximum rule priority.
289		*
290		* @return integer
291		*/
292	5	public function getMaximumPriority()
293		{
294	5	return $this->maximumPriority;
295		}
296
297		/**
298		* Returns the file name of a supplied code coverage report or <b>NULL</b>
299		* if the user has not supplied the --coverage option.
300		*
301		* @return string
302		*/
303	6	public function getCoverageReport()
304		{
305	6	return $this->coverageReport;
306		}
307
308		/**
309		* Returns a string of comma-separated extensions for valid php source code
310		* filenames or <b>null</b> when this argument was not set.
311		*
312		* @return string
313		*/
314	4	public function getExtensions()
315		{
316	4	return $this->extensions;
317		}
318
319		/**
320		* Returns string of comma-separated pattern that is used to exclude
321		* directories or <b>null</b> when this argument was not set.
322		*
323		* @return string
324		*/
325	4	public function getIgnore()
326		{
327	4	return $this->ignore;
328		}
329
330		/**
331		* Was the <b>--version</b> passed to PHPMD's command line interface?
332		*
333		* @return boolean
334		*/
335	6	public function hasVersion()
336		{
337	6	return $this->version;
338		}
339
340		/**
341		* Was the <b>--strict</b> option passed to PHPMD's command line interface?
342		*
343		* @return boolean
344		* @since 1.2.0
345		*/
346	6	public function hasStrict()
347		{
348	6	return $this->strict;
349		}
350
351		/**
352		* Was the <b>--ignore-violations-on-exit</b> passed to PHPMD's command line interface?
353		*
354		* @return boolean
355		*/
356	6	public function ignoreViolationsOnExit()
357		{
358	6	return $this->ignoreViolationsOnExit;
359		}
360
361		/**
362		* Creates a report renderer instance based on the user's command line
363		* argument.
364		*
365		* Valid renderers are:
366		* <ul>
367		* <li>xml</li>
368		* <li>html</li>
369		* <li>text</li>
370		* <li>json</li>
371		* </ul>
372		*
373		* @param string $reportFormat
374		* @return \PHPMD\AbstractRenderer
375		* @throws \InvalidArgumentException When the specified renderer does not exist.
376		*/
377	12	public function createRenderer($reportFormat = null)
378		{
379	12	$reportFormat = $reportFormat ?: $this->reportFormat;
380
381	12	switch ($reportFormat) {
382		case 'xml':
383	1	return $this->createXmlRenderer();
384		case 'html':
385	1	return $this->createHtmlRenderer();
386		case 'text':
387	5	return $this->createTextRenderer();
388		case 'json':
389		return $this->createJsonRenderer();
390		default:
391	5	return $this->createCustomRenderer();
392		}
393		}
394
395		/**
396		* @return \PHPMD\Renderer\XMLRenderer
397		*/
398	1	protected function createXmlRenderer()
399		{
400	1	return new XMLRenderer();
401		}
402
403		/**
404		* @return \PHPMD\Renderer\TextRenderer
405		*/
406	5	protected function createTextRenderer()
407		{
408	5	return new TextRenderer();
409		}
410
411		/**
412		* @return \PHPMD\Renderer\HTMLRenderer
413		*/
414	1	protected function createHtmlRenderer()
415		{
416	1	return new HTMLRenderer();
417		}
418
419		/**
420		* @return \PHPMD\Renderer\JSONRenderer
421		*/
422		protected function createJsonRenderer()
423		{
424		return new JSONRenderer();
425		}
426
427		/**
428		* @return \PHPMD\AbstractRenderer
429		* @throws \InvalidArgumentException
430		*/
431	5	protected function createCustomRenderer()
432		{
433	5	if ('' === $this->reportFormat) {
434	1	throw new \InvalidArgumentException(
435	1	'Can\'t create report with empty format.',
436	1	self::INPUT_ERROR
437		);
438		}
439
440	4	if (class_exists($this->reportFormat)) {
441	1	return new $this->reportFormat();
442		}
443
444		// Try to load a custom renderer
445	3	$fileName = strtr($this->reportFormat, '_\\', '//') . '.php';
446
447	3	$fileHandle = @fopen($fileName, 'r', true);
448	3	if (is_resource($fileHandle) === false) {
449	1	throw new \InvalidArgumentException(
450	1	sprintf(
451	1	'Can\'t find the custom report class: %s',
452	1	$this->reportFormat
453		),
454	1	self::INPUT_ERROR
455		);
456		}
457	2	@fclose($fileHandle);
		0 ignored issues – show Security Best Practice introduced 2019-01-15 20:34 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
458
459	2	include_once $fileName;
460
461	2	return new $this->reportFormat();
462		}
463
464		/**
465		* Returns usage information for the PHPMD command line interface.
466		*
467		* @return string
468		*/
469	4	public function usage()
470		{
471	4	$availableRenderers = $this->getListOfAvailableRenderers();
472
473		return 'Mandatory arguments:' . \PHP_EOL .
474		'1) A php source code filename or directory. Can be a comma-' .
475		'separated string' . \PHP_EOL .
476		'2) A report format' . \PHP_EOL .
477		'3) A ruleset filename or a comma-separated string of ruleset' .
478		'filenames' . \PHP_EOL . \PHP_EOL .
479	4	'Available formats: ' . $availableRenderers . '.' . \PHP_EOL .
480	4	'Available rulesets: ' . implode(', ', $this->availableRuleSets) . '.' . \PHP_EOL . \PHP_EOL .
481	4	'Optional arguments that may be put after the mandatory arguments:' .
482	4	\PHP_EOL .
483	4	'--minimumpriority: rule priority threshold; rules with lower ' .
484	4	'priority than this will not be used' . \PHP_EOL .
485	4	'--reportfile: send report output to a file; default to STDOUT' .
486	4	\PHP_EOL .
487	4	'--suffixes: comma-separated string of valid source code ' .
488	4	'filename extensions, e.g. php,phtml' . \PHP_EOL .
489	4	'--exclude: comma-separated string of patterns that are used to ' .
490	4	'ignore directories' . \PHP_EOL .
491	4	'--strict: also report those nodes with a @SuppressWarnings ' .
492	4	'annotation' . \PHP_EOL .
493	4	'--ignore-violations-on-exit: will exit with a zero code, ' .
494	4	'even if any violations are found' . \PHP_EOL;
495		}
496
497		/**
498		* Get a list of available renderers
499		*
500		* @return string The list of renderers found.
501		*/
502	4	protected function getListOfAvailableRenderers()
503		{
504	4	$renderersDirPathName=__DIR__.'/../Renderer';
505	4	$renderers = array();
506
507	4	foreach (scandir($renderersDirPathName) as $rendererFileName) {
508	4	if (preg_match('/^(\w+)Renderer.php$/i', $rendererFileName, $rendererName)) {
509	4	$renderers[] = strtolower($rendererName[1]);
510		}
511		}
512
513	4	sort($renderers);
514
515	4	if (count($renderers) > 1) {
516	4	return implode(', ', $renderers);
517		}
518
519		return array_pop($list);
520		}
521
522		/**
523		* Logs a deprecated option to the current user interface.
524		*
525		* @param string $deprecatedName
526		* @param string $newName
527		* @return void
528		*/
529	2	protected function logDeprecated($deprecatedName, $newName)
530		{
531	2	$message = sprintf(
532	2	'The --%s option is deprecated, please use --%s instead.',
533	2	$deprecatedName,
534	2	$newName
535		);
536
537	2	fwrite(STDERR, $message . PHP_EOL . PHP_EOL);
538	2	}
539
540		/**
541		* This method takes the given input file, reads the newline separated paths
542		* from that file and creates a comma separated string of the file paths. If
543		* the given <b>$inputFile</b> not exists, this method will throw an
544		* exception.
545		*
546		* @param string $inputFile Specified input file name.
547		* @return string
548		* @throws \InvalidArgumentException If the specified input file does not exist.
549		* @since 1.1.0
550		*/
551	6	protected function readInputFile($inputFile)
552		{
553	6	if (file_exists($inputFile)) {
554	5	return join(',', array_map('trim', file($inputFile)));
555		}
556	1	throw new \InvalidArgumentException("Input file '{$inputFile}' not exists.");
557		}
558		}
559

SomeBlackMagic / phpmd

Pull Request — master (#18)

CommandLineOptions::getListOfAvailableRenderers() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like