ExampleTag::process() - Code Metrics - jasny/phpdoc-parser - Measure and Improve Code Quality continuously with Scrutinizer

ExampleTag::process() A
last analyzed 2023-06-09 11:53 UTC

↳ Parent: ExampleTag

Complexity

Conditions	2
Paths	2

Size

Total Lines	15
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	2

Importance

Changes

Metric	Value
cc	2
eloc	8
nc	2
nop	2
dl	0
loc	15
ccs	9
cts	9
cp	1
crap	2
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Jasny\PhpdocParser\Tag\PhpDocumentor;

use Jasny\PhpdocParser\Tag\AbstractTag;
use Jasny\PhpdocParser\PhpdocException;
use function Jasny\array_only;

/**
 * Custom logic for PhpDocumentor 'example' tag
 */
class ExampleTag extends AbstractTag
{
    /**
     * Process a notation.
     *
     * @param array  $notations
     * @param string $value
     * @return array
     */
    public function process(array $notations, string $value): array
    {
        $regexp = '/^(?<location>(?:[^"]\S*|"[^"]+"))(?:\s*(?<start_line>\d+)'
          . '(?:\s*(?<number_of_lines>\d+))?)?(?:\s*(?<description>.+))?/';

        if (!preg_match($regexp, $value, $matches)) {
            throw new PhpdocException("Failed to parse '@{$this->name} $value': invalid syntax");
        }

        $this->normalizeValues($matches);
        $matches = array_only($matches, ['location', 'start_line', 'number_of_lines', 'description']);

        $notations[$this->name] = $matches;

        return $notations;
    }

    /**
     * Normalize parsed values
     *
     * @param array $values
     */
    protected function normalizeValues(array &$values): void
    {
        $values['location'] = trim($values['location'], '"');

        foreach (['start_line', 'number_of_lines'] as $name) {
            if (!isset($values[$name])) {
                continue;
            }

            if ($values[$name] === '') {
                unset($values[$name]);
            } else {
                $values[$name] = (int)$values[$name];
            }
        }
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Jasny\PhpdocParser\Tag\PhpDocumentor;
6
7		use Jasny\PhpdocParser\Tag\AbstractTag;
8		use Jasny\PhpdocParser\PhpdocException;
9		use function Jasny\array_only;
10
11		/**
12		* Custom logic for PhpDocumentor 'example' tag
13		*/
14		class ExampleTag extends AbstractTag
15		{
16		/**
17		* Process a notation.
18		*
19		* @param array $notations
20		* @param string $value
21		* @return array
22		*/
23	9	public function process(array $notations, string $value): array
24		{
25	9	$regexp = '/^(?<location>(?:[^"]\S\|"[^"]+"))(?:\s(?<start_line>\d+)'
26	9	. '(?:\s(?<number_of_lines>\d+))?)?(?:\s(?<description>.+))?/';
27
28	9	if (!preg_match($regexp, $value, $matches)) {
29	2	throw new PhpdocException("Failed to parse '@{$this->name} $value': invalid syntax");
30		}
31
32	7	$this->normalizeValues($matches);
33	7	$matches = array_only($matches, ['location', 'start_line', 'number_of_lines', 'description']);
34
35	7	$notations[$this->name] = $matches;
36
37	7	return $notations;
38		}
39
40		/**
41		* Normalize parsed values
42		*
43		* @param array $values
44		*/
45	7	protected function normalizeValues(array &$values): void
46		{
47	7	$values['location'] = trim($values['location'], '"');
48
49	7	foreach (['start_line', 'number_of_lines'] as $name) {
50	7	if (!isset($values[$name])) {
51	2	continue;
52		}
53
54	6	if ($values[$name] === '') {
55	2	unset($values[$name]);
56		} else {
57	5	$values[$name] = (int)$values[$name];
58		}
59		}
60		}
61		}
62

jasny / phpdoc-parser

ExampleTag::process() A last analyzed 2023-06-09 11:53 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ExampleTag::process() A
last analyzed 2023-06-09 11:53 UTC