1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
<?php
/*
* 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 Symfony\CS\DocBlock;
/**
* This represents a line of a docblock.
*
* @author Graham Campbell <graham@alt-three.com>
*/
class Line
{
/**
* The content of this line.
*
* @var string
*/
private $content;
/**
* Create a new line instance.
*
* @param string $content
*/
public function __construct($content)
{
$this->content = $content;
}
/**
* Get the string representation of object.
*
* @return string
*/
public function __toString()
{
return $this->content;
}
/**
* Get the content of this line.
*
* @return int
*/
public function getContent()
{
return $this->content;
}
/**
* Does this line contain useful content?
*
* If the line contains text or tags, then this is true.
*
* @return bool
*/
public function containsUsefulContent()
{
return 0 !== preg_match('/\\*\s*\S+/', $this->content) && !$this->isTheStart() && !$this->isTheEnd();
}
/**
* Does the line contain a tag?
*
* If this is true, then it must be the first line of an annotation.
*
* @return bool
*/
public function containsATag()
{
return 0 !== preg_match('/\\*\s*@/', $this->content);
}
/**
* Is the line the start of a docblock?
*
* @return bool
*/
public function isTheStart()
{
return false !== strpos($this->content, '/**');
}
/**
* Is the line the end of a docblock?
*
* @return bool
*/
public function isTheEnd()
{
return false !== strpos($this->content, '*/');
}
/**
* Set the content of this line.
*
* @param string $content
*/
public function setContent($content)
{
$this->content = $content;
}
/**
* Remove this line by clearing its contents.
*
* Note that this method technically brakes the internal state of the
* docblock, but is useful when we need to retain the indexes of lines
* during the execution of an algorithm.
*/
public function remove()
{
$this->content = '';
}
/**
* Append a blank docblock line to this line's contents.
*
* Note that this method technically brakes the internal state of the
* docblock, but is useful when we need to retain the indexes of lines
* during the execution of an algorithm.
*/
public function addBlank()
{
preg_match_all('/\ *\*/', $this->content, $matches);
$this->content .= $matches[0][0]."\n";
}
}