16715837382

Committed 04 Aug 2025 06:34AM UTC coverage: 94.728% (+0.01%) from 94.716%

Build # 16715837382

Build Type

push

github

Committed by

keradus

Commit Message

chore: switch to official checkstyle.xsd

Run Details

28212 of 29782 relevant lines covered (94.73%)

45.91 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

90.67

/src/DocBlock/DocBlock.php

<?php

declare(strict_types=1);

/*
 * This file is part of PHP CS Fixer.
 *
 * (c) Fabien Potencier <fabien@symfony.com>
 *     Dariusz Rumiński <dariusz.ruminski@gmail.com>
 *
 * This source file is subject to the MIT license that is bundled
 * with this source code in the file LICENSE.
 */

namespace PhpCsFixer\DocBlock;

use PhpCsFixer\Preg;
use PhpCsFixer\Tokenizer\Analyzer\Analysis\NamespaceAnalysis;
use PhpCsFixer\Tokenizer\Analyzer\Analysis\NamespaceUseAnalysis;

/**
 * This class represents a docblock.
 *
 * It internally splits it up into "lines" that we can manipulate.
 *
 * @author Graham Campbell <hello@gjcampbell.co.uk>
 */
final class DocBlock
{
    /**
     * @var list<Line>
     */
    private array $lines = [];

    /**
     * @var null|list<Annotation>
     */
    private ?array $annotations = null;

    private ?NamespaceAnalysis $namespace;

    /**
     * @var list<NamespaceUseAnalysis>
     */
    private array $namespaceUses;

    /**
     * @param list<NamespaceUseAnalysis> $namespaceUses
     */
    public function __construct(string $content, ?NamespaceAnalysis $namespace = null, array $namespaceUses = [])
    {
        foreach (Preg::split('/([^\n\r]+\R*)/', $content, -1, \PREG_SPLIT_NO_EMPTY | \PREG_SPLIT_DELIM_CAPTURE) as $line) {
            $this->lines[] = new Line($line);
        }

        $this->namespace = $namespace;
        $this->namespaceUses = $namespaceUses;
    }

    public function __toString(): string
    {
        return $this->getContent();
    }

    /**
     * Get this docblock's lines.
     *
     * @return list<Line>
     */
    public function getLines(): array
    {
        return $this->lines;
    }

    /**
     * Get a single line.
     */
    public function getLine(int $pos): ?Line
    {
        return $this->lines[$pos] ?? null;
    }

    /**
     * Get this docblock's annotations.
     *
     * @return list<Annotation>
     */
    public function getAnnotations(): array
    {
        if (null !== $this->annotations) {
            return $this->annotations;
        }

        $this->annotations = [];
        $total = \count($this->lines);

        for ($index = 0; $index < $total; ++$index) {
            if ($this->lines[$index]->containsATag()) {
                // get all the lines that make up the annotation
                $lines = \array_slice($this->lines, $index, $this->findAnnotationLength($index), true);
                $annotation = new Annotation($lines, $this->namespace, $this->namespaceUses);
                // move the index to the end of the annotation to avoid
                // checking it again because we know the lines inside the
                // current annotation cannot be part of another annotation
                $index = $annotation->getEnd();
                // add the current annotation to the list of annotations
                $this->annotations[] = $annotation;
            }
        }

        return $this->annotations;
    }

    public function isMultiLine(): bool
    {
        return 1 !== \count($this->lines);
    }

    /**
     * Take a one line doc block, and turn it into a multi line doc block.
     */
    public function makeMultiLine(string $indent, string $lineEnd): void
    {
        if ($this->isMultiLine()) {
            return;
        }

        $lineContent = $this->getSingleLineDocBlockEntry($this->lines[0]);

        if ('' === $lineContent) {
            $this->lines = [
                new Line('/**'.$lineEnd),
                new Line($indent.' *'.$lineEnd),
                new Line($indent.' */'),
            ];

            return;
        }

        $this->lines = [
            new Line('/**'.$lineEnd),
            new Line($indent.' * '.$lineContent.$lineEnd),
            new Line($indent.' */'),
        ];
    }

    public function makeSingleLine(): void
    {
        if (!$this->isMultiLine()) {
            return;
        }

        $usefulLines = array_filter(
            $this->lines,
            static fn (Line $line): bool => $line->containsUsefulContent()
        );

        if (1 < \count($usefulLines)) {
            return;
        }

        $lineContent = '';
        if (\count($usefulLines) > 0) {
            $lineContent = $this->getSingleLineDocBlockEntry(array_shift($usefulLines));
        }

        $this->lines = [new Line('/** '.$lineContent.' */')];
    }

    public function getAnnotation(int $pos): ?Annotation
    {
        $annotations = $this->getAnnotations();

        return $annotations[$pos] ?? null;
    }

    /**
     * Get specific types of annotations only.
     *
     * @param list<string>|string $types
     *
     * @return list<Annotation>
     */
    public function getAnnotationsOfType($types): array
    {
        $typesToSearchFor = (array) $types;

        $annotations = [];

        foreach ($this->getAnnotations() as $annotation) {
            $tagName = $annotation->getTag()->getName();
            if (\in_array($tagName, $typesToSearchFor, true)) {
                $annotations[] = $annotation;
            }
        }

        return $annotations;
    }

    /**
     * Get the actual content of this docblock.
     */
    public function getContent(): string
    {
        return implode('', $this->lines);
    }

    private function findAnnotationLength(int $start): int
    {
        $index = $start;

        while (($line = $this->getLine(++$index)) !== null) {
            if ($line->containsATag()) {
                // we've 100% reached the end of the description if we get here
                break;
            }

            if (!$line->containsUsefulContent()) {
                // if next line is also non-useful, or contains a tag, then we're done here
                $next = $this->getLine($index + 1);
                if (null === $next || !$next->containsUsefulContent() || $next->containsATag()) {
                    break;
                }
                // otherwise, continue, the annotation must have contained a blank line in its description
            }
        }

        return $index - $start;
    }

    private function getSingleLineDocBlockEntry(Line $line): string
    {
        $lineString = $line->getContent();

        if ('' === $lineString) {
            return $lineString;
        }

        $lineString = str_replace('*/', '', $lineString);
        $lineString = trim($lineString);

        if (str_starts_with($lineString, '/**')) {
            $lineString = substr($lineString, 3);
        } elseif (str_starts_with($lineString, '*')) {
            $lineString = substr($lineString, 1);
        }

        return trim($lineString);
    }
}

1	<?php
2
3	declare(strict_types=1);
4
5	/*
6	* This file is part of PHP CS Fixer.
7	*
8	* (c) Fabien Potencier <fabien@symfony.com>
9	* Dariusz Rumiński <dariusz.ruminski@gmail.com>
10	*
11	* This source file is subject to the MIT license that is bundled
12	* with this source code in the file LICENSE.
13	*/
14
15	namespace PhpCsFixer\DocBlock;
16
17	use PhpCsFixer\Preg;
18	use PhpCsFixer\Tokenizer\Analyzer\Analysis\NamespaceAnalysis;
19	use PhpCsFixer\Tokenizer\Analyzer\Analysis\NamespaceUseAnalysis;
20
21	/**
22	* This class represents a docblock.
23	*
24	* It internally splits it up into "lines" that we can manipulate.
25	*
26	* @author Graham Campbell <hello@gjcampbell.co.uk>
27	*/
28	final class DocBlock
29	{
30	/**
31	* @var list<Line>
32	*/
33	private array $lines = [];
34
35	/**
36	* @var null\|list<Annotation>
37	*/
38	private ?array $annotations = null;
39
40	private ?NamespaceAnalysis $namespace;
41
42	/**
43	* @var list<NamespaceUseAnalysis>
44	*/
45	private array $namespaceUses;
46
47	/**
48	* @param list<NamespaceUseAnalysis> $namespaceUses
49	*/
50	public function __construct(string $content, ?NamespaceAnalysis $namespace = null, array $namespaceUses = [])
51	{
52	foreach (Preg::split('/([^\n\r]+\R*)/', $content, -1, \PREG_SPLIT_NO_EMPTY \| \PREG_SPLIT_DELIM_CAPTURE) as $line) {	21✔
53	$this->lines[] = new Line($line);	20✔
54	}
55
56	$this->namespace = $namespace;	21✔
57	$this->namespaceUses = $namespaceUses;	21✔
58	}
59
60	public function __toString(): string
61	{
62	return $this->getContent();	1✔
63	}
64
65	/**
66	* Get this docblock's lines.
67	*
68	* @return list<Line>
69	*/
70	public function getLines(): array
71	{
72	return $this->lines;	1✔
73	}
74
75	/**
76	* Get a single line.
77	*/
78	public function getLine(int $pos): ?Line
79	{
80	return $this->lines[$pos] ?? null;	6✔
81	}
82
83	/**
84	* Get this docblock's annotations.
85	*
86	* @return list<Annotation>
87	*/
88	public function getAnnotations(): array
89	{
90	if (null !== $this->annotations) {	5✔
91	return $this->annotations;	1✔
92	}
93
94	$this->annotations = [];	5✔
95	$total = \count($this->lines);	5✔
96
97	for ($index = 0; $index < $total; ++$index) {	5✔
98	if ($this->lines[$index]->containsATag()) {	5✔
99	// get all the lines that make up the annotation
100	$lines = \array_slice($this->lines, $index, $this->findAnnotationLength($index), true);	5✔
101	$annotation = new Annotation($lines, $this->namespace, $this->namespaceUses);	5✔
102	// move the index to the end of the annotation to avoid
103	// checking it again because we know the lines inside the
104	// current annotation cannot be part of another annotation
105	$index = $annotation->getEnd();	5✔
106	// add the current annotation to the list of annotations
107	$this->annotations[] = $annotation;	5✔
108	}
109	}
110
111	return $this->annotations;	5✔
112	}
113
114	public function isMultiLine(): bool
115	{
116	return 1 !== \count($this->lines);	13✔
117	}
118
119	/**
120	* Take a one line doc block, and turn it into a multi line doc block.
121	*/
122	public function makeMultiLine(string $indent, string $lineEnd): void
123	{
124	if ($this->isMultiLine()) {	6✔
125	return;	3✔
126	}
127
128	$lineContent = $this->getSingleLineDocBlockEntry($this->lines[0]);	3✔
129
130	if ('' === $lineContent) {	3✔
131	$this->lines = [	×
132	new Line('/**'.$lineEnd),	×
133	new Line($indent.' *'.$lineEnd),	×
134	new Line($indent.' */'),	×
135	];	×
136
137	return;	×
138	}
139
140	$this->lines = [	3✔
141	new Line('/**'.$lineEnd),	3✔
142	new Line($indent.' * '.$lineContent.$lineEnd),	3✔
143	new Line($indent.' */'),	3✔
144	];	3✔
145	}
146
147	public function makeSingleLine(): void
148	{
149	if (!$this->isMultiLine()) {	6✔
150	return;	1✔
151	}
152
153	$usefulLines = array_filter(	5✔
154	$this->lines,	5✔
155	static fn (Line $line): bool => $line->containsUsefulContent()	5✔
156	);	5✔
157
158	if (1 < \count($usefulLines)) {	5✔
159	return;	1✔
160	}
161
162	$lineContent = '';	4✔
163	if (\count($usefulLines) > 0) {	4✔
164	$lineContent = $this->getSingleLineDocBlockEntry(array_shift($usefulLines));	3✔
165	}
166
167	$this->lines = [new Line('/** '.$lineContent.' */')];	4✔
168	}
169
170	public function getAnnotation(int $pos): ?Annotation
171	{
172	$annotations = $this->getAnnotations();	1✔
173
174	return $annotations[$pos] ?? null;	1✔
175	}
176
177	/**
178	* Get specific types of annotations only.
179	*
180	* @param list<string>\|string $types
181	*
182	* @return list<Annotation>
183	*/
184	public function getAnnotationsOfType($types): array
185	{
186	$typesToSearchFor = (array) $types;	4✔
187
188	$annotations = [];	4✔
189
190	foreach ($this->getAnnotations() as $annotation) {	4✔
191	$tagName = $annotation->getTag()->getName();	4✔
192	if (\in_array($tagName, $typesToSearchFor, true)) {	4✔
193	$annotations[] = $annotation;	3✔
194	}
195	}
196
197	return $annotations;	4✔
198	}
199
200	/**
201	* Get the actual content of this docblock.
202	*/
203	public function getContent(): string
204	{
205	return implode('', $this->lines);	14✔
206	}
207
208	private function findAnnotationLength(int $start): int
209	{
210	$index = $start;	5✔
211
212	while (($line = $this->getLine(++$index)) !== null) {	5✔
213	if ($line->containsATag()) {	5✔
214	// we've 100% reached the end of the description if we get here
215	break;	5✔
216	}
217
218	if (!$line->containsUsefulContent()) {	5✔
219	// if next line is also non-useful, or contains a tag, then we're done here
220	$next = $this->getLine($index + 1);	5✔
221	if (null === $next \|\| !$next->containsUsefulContent() \|\| $next->containsATag()) {	5✔
222	break;	5✔
223	}
224	// otherwise, continue, the annotation must have contained a blank line in its description
225	}
226	}
227
228	return $index - $start;	5✔
229	}
230
231	private function getSingleLineDocBlockEntry(Line $line): string
232	{
233	$lineString = $line->getContent();	6✔
234
235	if ('' === $lineString) {	6✔
236	return $lineString;	×
237	}
238
239	$lineString = str_replace('*/', '', $lineString);	6✔
240	$lineString = trim($lineString);	6✔
241
242	if (str_starts_with($lineString, '/**')) {	6✔
243	$lineString = substr($lineString, 3);	3✔
244	} elseif (str_starts_with($lineString, '*')) {	3✔
245	$lineString = substr($lineString, 1);	3✔
246	}
247
248	return trim($lineString);	6✔
249	}
250	}

keradus / PHP-CS-Fixer / 16715837382

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous