Issues in ResolveInlineMarkers.php - All Issues - Inspection of "Simplified Twig writer" - phpDocumentor/phpDocumentor - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — develop ( 0cc20e...dccdc9 )

by Mike

created 2019-06-16 07:55 UTC

Compiler/Pass/ResolveInlineMarkers.php (1 issue)

Labels

Bug 1

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 phpDocumentor.
 *
 *  For the full copyright and license information, please view the LICENSE
 *  file that was distributed with this source code.
 *
 * @copyright 2010-2018 Mike van Riel<[email protected]>
 * @license   http://www.opensource.org/licenses/mit-license.php MIT
 * @link      http://phpdoc.org
 */

namespace phpDocumentor\Compiler\Pass;

use phpDocumentor\Compiler\CompilerPassInterface;
use phpDocumentor\Descriptor\Collection;
use phpDocumentor\Descriptor\ProjectDescriptor;

final class ResolveInlineMarkers implements CompilerPassInterface
{
    const COMPILER_PRIORITY = 9000;

    /**
     * {@inheritDoc}
     */
    public function getDescription(): string
    {
        return 'Collect all markers in a file';
    }

    /**
     * Scans the files for markers and records them in the markers property of a file.
     */
    public function execute(ProjectDescriptor $project): void
    {
        $markerTerms = $project->getSettings()->getMarkers();

        foreach ($project->getFiles() as $file) {
            $marker_data = [];
            $matches = [];
            preg_match_all(
                '~//[\s]*(' . implode('|', $markerTerms) . ')\:?[\s]*(.*)~',
                $file->getSource(),
                $matches,
                PREG_SET_ORDER | PREG_OFFSET_CAPTURE
            );

            foreach ($matches as $match) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                list($before) = str_split($file->getSource(), $match[1][1]); // fetches all the text before the match

                $line_number = strlen($before) - strlen(str_replace("\n", '', $before)) + 1;

                $marker_data[] = ['type' => trim($match[1][0], '@'), 'line' => $line_number, $match[2][0]];
            }

            $file->setMarkers(new Collection($marker_data));
        }
    }
}


1		<?php
2		/**
3		* This file is part of phpDocumentor.
4		*
5		* For the full copyright and license information, please view the LICENSE
6		* file that was distributed with this source code.
7		*
8		* @copyright 2010-2018 Mike van Riel<[email protected]>
9		* @license http://www.opensource.org/licenses/mit-license.php MIT
10		* @link http://phpdoc.org
11		*/
12
13		namespace phpDocumentor\Compiler\Pass;
14
15		use phpDocumentor\Compiler\CompilerPassInterface;
16		use phpDocumentor\Descriptor\Collection;
17		use phpDocumentor\Descriptor\ProjectDescriptor;
18
19		final class ResolveInlineMarkers implements CompilerPassInterface
20		{
21		const COMPILER_PRIORITY = 9000;
22
23		/**
24		* {@inheritDoc}
25		*/
26		public function getDescription(): string
27		{
28		return 'Collect all markers in a file';
29		}
30
31		/**
32		* Scans the files for markers and records them in the markers property of a file.
33		*/
34	1	public function execute(ProjectDescriptor $project): void
35		{
36	1	$markerTerms = $project->getSettings()->getMarkers();
37
38	1	foreach ($project->getFiles() as $file) {
39	1	$marker_data = [];
40	1	$matches = [];
41	1	preg_match_all(
42	1	'~//[\s](' . implode('\|', $markerTerms) . ')\:?[\s](.*)~',
43	1	$file->getSource(),
44	1	$matches,
45	1	PREG_SET_ORDER \| PREG_OFFSET_CAPTURE
46		);
47
48	1	foreach ($matches as $match) {
		0 ignored issues – show Bug introduced 2018-04-30 11:10 UTC by Report Bug Copy Issue Report Show Similar Issues like this The expression `$matches` of type `null\|array<integer,array<integer,string>>` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
49	1	list($before) = str_split($file->getSource(), $match[1][1]); // fetches all the text before the match
50
51	1	$line_number = strlen($before) - strlen(str_replace("\n", '', $before)) + 1;
52
53	1	$marker_data[] = ['type' => trim($match[1][0], '@'), 'line' => $line_number, $match[2][0]];
54		}
55
56	1	$file->setMarkers(new Collection($marker_data));
57		}
58	1	}
59		}
60

phpDocumentor / phpDocumentor

Push — develop ( 0cc20e...dccdc9 )

Compiler/Pass/ResolveInlineMarkers.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like