@@ -22,9 +22,9 @@ |
||
22 | 22 | { |
23 | 23 | public const ERROR_INVALID_CALLBACK = 62101; |
24 | 24 | |
25 | - /** |
|
26 | - * @var callable |
|
27 | - */ |
|
25 | + /** |
|
26 | + * @var callable |
|
27 | + */ |
|
28 | 28 | private $callback; |
29 | 29 | |
30 | 30 | public function __construct($callback) |
@@ -38,17 +38,17 @@ discard block |
||
38 | 38 | */ |
39 | 39 | protected $classes = array(); |
40 | 40 | |
41 | - /** |
|
42 | - * The namespace detected in the file, if any. |
|
43 | - * @var string |
|
44 | - */ |
|
41 | + /** |
|
42 | + * The namespace detected in the file, if any. |
|
43 | + * @var string |
|
44 | + */ |
|
45 | 45 | protected $namespace = ''; |
46 | 46 | |
47 | - /** |
|
48 | - * @param string $path The path to the PHP file to parse. |
|
49 | - * @throws FileHelper_Exception |
|
50 | - * @see FileHelper::findPHPClasses() |
|
51 | - */ |
|
47 | + /** |
|
48 | + * @param string $path The path to the PHP file to parse. |
|
49 | + * @throws FileHelper_Exception |
|
50 | + * @see FileHelper::findPHPClasses() |
|
51 | + */ |
|
52 | 52 | public function __construct(string $path) |
53 | 53 | { |
54 | 54 | $this->path = realpath($path); |
@@ -68,58 +68,58 @@ discard block |
||
68 | 68 | $this->parseFile(); |
69 | 69 | } |
70 | 70 | |
71 | - /** |
|
72 | - * The name of the namespace of the classes in the file, if any. |
|
73 | - * @return string |
|
74 | - */ |
|
71 | + /** |
|
72 | + * The name of the namespace of the classes in the file, if any. |
|
73 | + * @return string |
|
74 | + */ |
|
75 | 75 | public function getNamespace() : string |
76 | 76 | { |
77 | 77 | return $this->namespace; |
78 | 78 | } |
79 | 79 | |
80 | - /** |
|
81 | - * Whether the file contains a namespace. |
|
82 | - * @return bool |
|
83 | - */ |
|
80 | + /** |
|
81 | + * Whether the file contains a namespace. |
|
82 | + * @return bool |
|
83 | + */ |
|
84 | 84 | public function hasNamespace() : bool |
85 | 85 | { |
86 | 86 | return !empty($this->namespace); |
87 | 87 | } |
88 | 88 | |
89 | - /** |
|
90 | - * The absolute path to the file. |
|
91 | - * @return string |
|
92 | - */ |
|
89 | + /** |
|
90 | + * The absolute path to the file. |
|
91 | + * @return string |
|
92 | + */ |
|
93 | 93 | public function getPath() : string |
94 | 94 | { |
95 | 95 | return $this->path; |
96 | 96 | } |
97 | 97 | |
98 | - /** |
|
99 | - * Whether any classes were found in the file. |
|
100 | - * @return bool |
|
101 | - */ |
|
98 | + /** |
|
99 | + * Whether any classes were found in the file. |
|
100 | + * @return bool |
|
101 | + */ |
|
102 | 102 | public function hasClasses() : bool |
103 | 103 | { |
104 | 104 | return !empty($this->classes); |
105 | 105 | } |
106 | 106 | |
107 | - /** |
|
108 | - * The names of the classes that were found in the file (with namespace if any). |
|
109 | - * @return string[] |
|
110 | - */ |
|
107 | + /** |
|
108 | + * The names of the classes that were found in the file (with namespace if any). |
|
109 | + * @return string[] |
|
110 | + */ |
|
111 | 111 | public function getClassNames() : array |
112 | 112 | { |
113 | 113 | return array_keys($this->classes); |
114 | 114 | } |
115 | 115 | |
116 | - /** |
|
117 | - * Retrieves all classes that were detected in the file, |
|
118 | - * which can be used to retrieve more information about |
|
119 | - * them. |
|
120 | - * |
|
121 | - * @return FileHelper_PHPClassInfo_Class[] |
|
122 | - */ |
|
116 | + /** |
|
117 | + * Retrieves all classes that were detected in the file, |
|
118 | + * which can be used to retrieve more information about |
|
119 | + * them. |
|
120 | + * |
|
121 | + * @return FileHelper_PHPClassInfo_Class[] |
|
122 | + */ |
|
123 | 123 | public function getClasses() : array |
124 | 124 | { |
125 | 125 | return array_values($this->classes); |
@@ -165,13 +165,13 @@ discard block |
||
165 | 165 | } |
166 | 166 | } |
167 | 167 | |
168 | - /** |
|
169 | - * Strips all whitespace from the string, replacing it with |
|
170 | - * regular spaces (newlines, tabs, etc.). |
|
171 | - * |
|
172 | - * @param string $string |
|
173 | - * @return string |
|
174 | - */ |
|
168 | + /** |
|
169 | + * Strips all whitespace from the string, replacing it with |
|
170 | + * regular spaces (newlines, tabs, etc.). |
|
171 | + * |
|
172 | + * @param string $string |
|
173 | + * @return string |
|
174 | + */ |
|
175 | 175 | protected function stripWhitespace(string $string) : string |
176 | 176 | { |
177 | 177 | return preg_replace('/[\s]/', ' ', $string); |
@@ -22,44 +22,44 @@ discard block |
||
22 | 22 | */ |
23 | 23 | class FileHelper_PHPClassInfo_Class |
24 | 24 | { |
25 | - /** |
|
26 | - * @var FileHelper_PHPClassInfo |
|
27 | - */ |
|
25 | + /** |
|
26 | + * @var FileHelper_PHPClassInfo |
|
27 | + */ |
|
28 | 28 | protected $info; |
29 | 29 | |
30 | - /** |
|
31 | - * @var bool |
|
32 | - */ |
|
30 | + /** |
|
31 | + * @var bool |
|
32 | + */ |
|
33 | 33 | protected $abstract = false; |
34 | 34 | |
35 | - /** |
|
36 | - * @var bool |
|
37 | - */ |
|
35 | + /** |
|
36 | + * @var bool |
|
37 | + */ |
|
38 | 38 | protected $final = false; |
39 | 39 | |
40 | - /** |
|
41 | - * @var string |
|
42 | - */ |
|
40 | + /** |
|
41 | + * @var string |
|
42 | + */ |
|
43 | 43 | protected $extends = ''; |
44 | 44 | |
45 | - /** |
|
46 | - * @var string[] |
|
47 | - */ |
|
45 | + /** |
|
46 | + * @var string[] |
|
47 | + */ |
|
48 | 48 | protected $implements = array(); |
49 | 49 | |
50 | - /** |
|
51 | - * @var string |
|
52 | - */ |
|
50 | + /** |
|
51 | + * @var string |
|
52 | + */ |
|
53 | 53 | protected $name; |
54 | 54 | |
55 | - /** |
|
56 | - * @var string |
|
57 | - */ |
|
55 | + /** |
|
56 | + * @var string |
|
57 | + */ |
|
58 | 58 | protected $declaration; |
59 | 59 | |
60 | - /** |
|
61 | - * @var string |
|
62 | - */ |
|
60 | + /** |
|
61 | + * @var string |
|
62 | + */ |
|
63 | 63 | protected $keyword; |
64 | 64 | |
65 | 65 | /** |
@@ -68,10 +68,10 @@ discard block |
||
68 | 68 | private $type; |
69 | 69 | |
70 | 70 | /** |
71 | - * @param FileHelper_PHPClassInfo $info The class info instance. |
|
72 | - * @param string $declaration The full class declaration, e.g. "class SomeName extends SomeOtherClass". |
|
73 | - * @param string $keyword The class keyword, if any, i.e. "abstract" or "final". |
|
74 | - */ |
|
71 | + * @param FileHelper_PHPClassInfo $info The class info instance. |
|
72 | + * @param string $declaration The full class declaration, e.g. "class SomeName extends SomeOtherClass". |
|
73 | + * @param string $keyword The class keyword, if any, i.e. "abstract" or "final". |
|
74 | + */ |
|
75 | 75 | public function __construct(FileHelper_PHPClassInfo $info, string $declaration, string $keyword, string $type) |
76 | 76 | { |
77 | 77 | $this->info = $info; |
@@ -82,31 +82,31 @@ discard block |
||
82 | 82 | $this->analyzeCode(); |
83 | 83 | } |
84 | 84 | |
85 | - /** |
|
86 | - * Check if this class is a subclass of the specified |
|
87 | - * class name. |
|
88 | - * |
|
89 | - * @param string $className |
|
90 | - * @return bool |
|
91 | - */ |
|
85 | + /** |
|
86 | + * Check if this class is a subclass of the specified |
|
87 | + * class name. |
|
88 | + * |
|
89 | + * @param string $className |
|
90 | + * @return bool |
|
91 | + */ |
|
92 | 92 | public function isSublassOf(string $className) : bool |
93 | 93 | { |
94 | 94 | return is_subclass_of($this->getNameNS(), $className); |
95 | 95 | } |
96 | 96 | |
97 | - /** |
|
98 | - * The class name without namespace. |
|
99 | - * @return string |
|
100 | - */ |
|
97 | + /** |
|
98 | + * The class name without namespace. |
|
99 | + * @return string |
|
100 | + */ |
|
101 | 101 | public function getName() : string |
102 | 102 | { |
103 | 103 | return $this->name; |
104 | 104 | } |
105 | 105 | |
106 | - /** |
|
107 | - * The absolute class name with namespace (if any). |
|
108 | - * @return string |
|
109 | - */ |
|
106 | + /** |
|
107 | + * The absolute class name with namespace (if any). |
|
108 | + * @return string |
|
109 | + */ |
|
110 | 110 | public function getNameNS() : string |
111 | 111 | { |
112 | 112 | $name = $this->getName(); |
@@ -118,48 +118,48 @@ discard block |
||
118 | 118 | return $name; |
119 | 119 | } |
120 | 120 | |
121 | - /** |
|
122 | - * Whether it is an abstract class. |
|
123 | - * @return bool |
|
124 | - */ |
|
121 | + /** |
|
122 | + * Whether it is an abstract class. |
|
123 | + * @return bool |
|
124 | + */ |
|
125 | 125 | public function isAbstract() : bool |
126 | 126 | { |
127 | 127 | return $this->abstract; |
128 | 128 | } |
129 | 129 | |
130 | - /** |
|
131 | - * Whether it is a final class. |
|
132 | - * @return bool |
|
133 | - */ |
|
130 | + /** |
|
131 | + * Whether it is a final class. |
|
132 | + * @return bool |
|
133 | + */ |
|
134 | 134 | public function isFinal() : bool |
135 | 135 | { |
136 | 136 | return $this->final; |
137 | 137 | } |
138 | 138 | |
139 | - /** |
|
140 | - * The name of the class that this class extends (with namespace, if specified). |
|
141 | - * @return string |
|
142 | - */ |
|
139 | + /** |
|
140 | + * The name of the class that this class extends (with namespace, if specified). |
|
141 | + * @return string |
|
142 | + */ |
|
143 | 143 | public function getExtends() : string |
144 | 144 | { |
145 | 145 | return $this->extends; |
146 | 146 | } |
147 | 147 | |
148 | - /** |
|
149 | - * A list of interfaces the class implements, if any. |
|
150 | - * @return string[] |
|
151 | - */ |
|
148 | + /** |
|
149 | + * A list of interfaces the class implements, if any. |
|
150 | + * @return string[] |
|
151 | + */ |
|
152 | 152 | public function getImplements() : array |
153 | 153 | { |
154 | 154 | return $this->implements; |
155 | 155 | } |
156 | 156 | |
157 | - /** |
|
158 | - * The class declaration string, with normalized spaces and sorted interface names. |
|
159 | - * NOTE: does not include the keyword "abstract" or "final". |
|
160 | - * |
|
161 | - * @return string |
|
162 | - */ |
|
157 | + /** |
|
158 | + * The class declaration string, with normalized spaces and sorted interface names. |
|
159 | + * NOTE: does not include the keyword "abstract" or "final". |
|
160 | + * |
|
161 | + * @return string |
|
162 | + */ |
|
163 | 163 | public function getDeclaration() : string |
164 | 164 | { |
165 | 165 | $parts = array(); |
@@ -179,10 +179,10 @@ discard block |
||
179 | 179 | return implode(' ', $parts); |
180 | 180 | } |
181 | 181 | |
182 | - /** |
|
183 | - * The keyword before "class", e.g. "abstract". |
|
184 | - * @return string |
|
185 | - */ |
|
182 | + /** |
|
183 | + * The keyword before "class", e.g. "abstract". |
|
184 | + * @return string |
|
185 | + */ |
|
186 | 186 | public function getKeyword() : string |
187 | 187 | { |
188 | 188 | return $this->keyword; |
@@ -60,23 +60,23 @@ discard block |
||
60 | 60 | } |
61 | 61 | } |
62 | 62 | |
63 | - /** |
|
64 | - * The end of line character used in the INI source string. |
|
65 | - * @return string |
|
66 | - */ |
|
63 | + /** |
|
64 | + * The end of line character used in the INI source string. |
|
65 | + * @return string |
|
66 | + */ |
|
67 | 67 | public function getEOLChar() : string |
68 | 68 | { |
69 | 69 | return $this->eol; |
70 | 70 | } |
71 | 71 | |
72 | - /** |
|
73 | - * Factory method: creates a new helper instance loading the |
|
74 | - * ini content from the specified file. |
|
75 | - * |
|
76 | - * @param string $iniPath |
|
77 | - * @return \AppUtils\IniHelper |
|
78 | - * @throws IniHelper_Exception |
|
79 | - */ |
|
72 | + /** |
|
73 | + * Factory method: creates a new helper instance loading the |
|
74 | + * ini content from the specified file. |
|
75 | + * |
|
76 | + * @param string $iniPath |
|
77 | + * @return \AppUtils\IniHelper |
|
78 | + * @throws IniHelper_Exception |
|
79 | + */ |
|
80 | 80 | public static function createFromFile(string $iniPath) |
81 | 81 | { |
82 | 82 | $iniPath = FileHelper::requireFileExists($iniPath); |
@@ -96,35 +96,35 @@ discard block |
||
96 | 96 | ); |
97 | 97 | } |
98 | 98 | |
99 | - /** |
|
100 | - * Factory method: Creates a new ini helper instance from an ini string. |
|
101 | - * |
|
102 | - * @param string $iniContent |
|
103 | - * @return \AppUtils\IniHelper |
|
104 | - */ |
|
99 | + /** |
|
100 | + * Factory method: Creates a new ini helper instance from an ini string. |
|
101 | + * |
|
102 | + * @param string $iniContent |
|
103 | + * @return \AppUtils\IniHelper |
|
104 | + */ |
|
105 | 105 | public static function createFromString(string $iniContent) |
106 | 106 | { |
107 | 107 | return new IniHelper($iniContent); |
108 | 108 | } |
109 | 109 | |
110 | - /** |
|
111 | - * Factory method: Creates a new empty ini helper. |
|
112 | - * |
|
113 | - * @return \AppUtils\IniHelper |
|
114 | - */ |
|
110 | + /** |
|
111 | + * Factory method: Creates a new empty ini helper. |
|
112 | + * |
|
113 | + * @return \AppUtils\IniHelper |
|
114 | + */ |
|
115 | 115 | public static function createNew() |
116 | 116 | { |
117 | 117 | return self::createFromString(''); |
118 | 118 | } |
119 | 119 | |
120 | - /** |
|
121 | - * Adds a new data section, and returns the section instance. |
|
122 | - * If a section with the name already exists, returns that |
|
123 | - * section instead of creating a new one. |
|
124 | - * |
|
125 | - * @param string $name |
|
126 | - * @return IniHelper_Section |
|
127 | - */ |
|
120 | + /** |
|
121 | + * Adds a new data section, and returns the section instance. |
|
122 | + * If a section with the name already exists, returns that |
|
123 | + * section instead of creating a new one. |
|
124 | + * |
|
125 | + * @param string $name |
|
126 | + * @return IniHelper_Section |
|
127 | + */ |
|
128 | 128 | public function addSection(string $name) : IniHelper_Section |
129 | 129 | { |
130 | 130 | if(!isset($this->sections[$name])) { |
@@ -134,12 +134,12 @@ discard block |
||
134 | 134 | return $this->sections[$name]; |
135 | 135 | } |
136 | 136 | |
137 | - /** |
|
138 | - * Retrieves a section by its name, if it exists. |
|
139 | - * |
|
140 | - * @param string $name |
|
141 | - * @return IniHelper_Section|NULL |
|
142 | - */ |
|
137 | + /** |
|
138 | + * Retrieves a section by its name, if it exists. |
|
139 | + * |
|
140 | + * @param string $name |
|
141 | + * @return IniHelper_Section|NULL |
|
142 | + */ |
|
143 | 143 | public function getSection(string $name) : ?IniHelper_Section |
144 | 144 | { |
145 | 145 | if(isset($this->sections[$name])) { |
@@ -149,11 +149,11 @@ discard block |
||
149 | 149 | return null; |
150 | 150 | } |
151 | 151 | |
152 | - /** |
|
153 | - * Gets the data from the INI file as an associative array. |
|
154 | - * |
|
155 | - * @return array |
|
156 | - */ |
|
152 | + /** |
|
153 | + * Gets the data from the INI file as an associative array. |
|
154 | + * |
|
155 | + * @return array |
|
156 | + */ |
|
157 | 157 | public function toArray() : array |
158 | 158 | { |
159 | 159 | $result = array(); |
@@ -173,17 +173,17 @@ discard block |
||
173 | 173 | return $result; |
174 | 174 | } |
175 | 175 | |
176 | - /** |
|
177 | - * Saves the INI content to the target file. |
|
178 | - * |
|
179 | - * @param string $filePath |
|
180 | - * @return IniHelper |
|
181 | - * @throws FileHelper_Exception |
|
182 | - * |
|
183 | - * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
184 | - * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
185 | - * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
186 | - */ |
|
176 | + /** |
|
177 | + * Saves the INI content to the target file. |
|
178 | + * |
|
179 | + * @param string $filePath |
|
180 | + * @return IniHelper |
|
181 | + * @throws FileHelper_Exception |
|
182 | + * |
|
183 | + * @see FileHelper::ERROR_SAVE_FOLDER_NOT_WRITABLE |
|
184 | + * @see FileHelper::ERROR_SAVE_FILE_NOT_WRITABLE |
|
185 | + * @see FileHelper::ERROR_SAVE_FILE_WRITE_FAILED |
|
186 | + */ |
|
187 | 187 | public function saveToFile(string $filePath) : IniHelper |
188 | 188 | { |
189 | 189 | FileHelper::saveFile($filePath, $this->saveToString()); |
@@ -191,11 +191,11 @@ discard block |
||
191 | 191 | return $this; |
192 | 192 | } |
193 | 193 | |
194 | - /** |
|
195 | - * Returns the INI content as string. |
|
196 | - * |
|
197 | - * @return string |
|
198 | - */ |
|
194 | + /** |
|
195 | + * Returns the INI content as string. |
|
196 | + * |
|
197 | + * @return string |
|
198 | + */ |
|
199 | 199 | public function saveToString() : string |
200 | 200 | { |
201 | 201 | $parts = array(); |
@@ -208,15 +208,15 @@ discard block |
||
208 | 208 | return implode($this->eol, $parts); |
209 | 209 | } |
210 | 210 | |
211 | - /** |
|
212 | - * Sets or adds the value of a setting in the INI content. |
|
213 | - * If the setting does not exist, it is added. Otherwise, |
|
214 | - * the existing value is overwritten. |
|
215 | - * |
|
216 | - * @param string $path A variable path, either <code>varname</code> or <code>section.varname</code>. |
|
217 | - * @param mixed $value |
|
218 | - * @return IniHelper |
|
219 | - */ |
|
211 | + /** |
|
212 | + * Sets or adds the value of a setting in the INI content. |
|
213 | + * If the setting does not exist, it is added. Otherwise, |
|
214 | + * the existing value is overwritten. |
|
215 | + * |
|
216 | + * @param string $path A variable path, either <code>varname</code> or <code>section.varname</code>. |
|
217 | + * @param mixed $value |
|
218 | + * @return IniHelper |
|
219 | + */ |
|
220 | 220 | public function setValue(string $path, $value) : IniHelper |
221 | 221 | { |
222 | 222 | $path = $this->parsePath($path); |
@@ -235,12 +235,12 @@ discard block |
||
235 | 235 | return $this; |
236 | 236 | } |
237 | 237 | |
238 | - /** |
|
239 | - * Checks whether a section with the specified name exists. |
|
240 | - * |
|
241 | - * @param string $name |
|
242 | - * @return bool |
|
243 | - */ |
|
238 | + /** |
|
239 | + * Checks whether a section with the specified name exists. |
|
240 | + * |
|
241 | + * @param string $name |
|
242 | + * @return bool |
|
243 | + */ |
|
244 | 244 | public function sectionExists(string $name) : bool |
245 | 245 | { |
246 | 246 | foreach($this->sections as $section) { |
@@ -252,23 +252,23 @@ discard block |
||
252 | 252 | return false; |
253 | 253 | } |
254 | 254 | |
255 | - /** |
|
256 | - * Retrieves the default section, which is used to add |
|
257 | - * values in the root of the document. |
|
258 | - * |
|
259 | - * @return IniHelper_Section |
|
260 | - */ |
|
255 | + /** |
|
256 | + * Retrieves the default section, which is used to add |
|
257 | + * values in the root of the document. |
|
258 | + * |
|
259 | + * @return IniHelper_Section |
|
260 | + */ |
|
261 | 261 | public function getDefaultSection() : IniHelper_Section |
262 | 262 | { |
263 | 263 | return $this->addSection(self::SECTION_DEFAULT); |
264 | 264 | } |
265 | 265 | |
266 | - /** |
|
267 | - * Retrieves all variable lines for the specified path. |
|
268 | - * |
|
269 | - * @param string $path A variable path. Either <code>varname</code> or <code>section.varname</code>. |
|
270 | - * @return array|\AppUtils\IniHelper_Line[] |
|
271 | - */ |
|
266 | + /** |
|
267 | + * Retrieves all variable lines for the specified path. |
|
268 | + * |
|
269 | + * @param string $path A variable path. Either <code>varname</code> or <code>section.varname</code>. |
|
270 | + * @return array|\AppUtils\IniHelper_Line[] |
|
271 | + */ |
|
272 | 272 | public function getLinesByVariable(string $path) |
273 | 273 | { |
274 | 274 | $path = $this->parsePath($path); |
@@ -20,9 +20,9 @@ discard block |
||
20 | 20 | */ |
21 | 21 | class URLInfo_Highlighter |
22 | 22 | { |
23 | - /** |
|
24 | - * @var URLInfo |
|
25 | - */ |
|
23 | + /** |
|
24 | + * @var URLInfo |
|
25 | + */ |
|
26 | 26 | protected $info; |
27 | 27 | |
28 | 28 | public function __construct(URLInfo $info) |
@@ -158,13 +158,13 @@ discard block |
||
158 | 158 | ); |
159 | 159 | } |
160 | 160 | |
161 | - /** |
|
162 | - * Fetches all parameters in the URL, regardless of |
|
163 | - * whether parameter exclusion is enabled, so they |
|
164 | - * can be highlighted is need be. |
|
165 | - * |
|
166 | - * @return array<string,string> |
|
167 | - */ |
|
161 | + /** |
|
162 | + * Fetches all parameters in the URL, regardless of |
|
163 | + * whether parameter exclusion is enabled, so they |
|
164 | + * can be highlighted is need be. |
|
165 | + * |
|
166 | + * @return array<string,string> |
|
167 | + */ |
|
168 | 168 | protected function resolveParams() : array |
169 | 169 | { |
170 | 170 | $previous = $this->info->isParamExclusionEnabled(); |
@@ -21,18 +21,18 @@ discard block |
||
21 | 21 | public const SVN_ERROR_TYPE_WARNING = 'warning'; |
22 | 22 | |
23 | 23 | /** |
24 | - * @var SVNHelper |
|
25 | - */ |
|
24 | + * @var SVNHelper |
|
25 | + */ |
|
26 | 26 | protected $helper; |
27 | 27 | |
28 | - /** |
|
29 | - * @var SVNHelper_Target |
|
30 | - */ |
|
28 | + /** |
|
29 | + * @var SVNHelper_Target |
|
30 | + */ |
|
31 | 31 | protected $target; |
32 | 32 | |
33 | - /** |
|
34 | - * @var SVNHelper_CommandResult|NULL |
|
35 | - */ |
|
33 | + /** |
|
34 | + * @var SVNHelper_CommandResult|NULL |
|
35 | + */ |
|
36 | 36 | protected ?SVNHelper_CommandResult $result; |
37 | 37 | |
38 | 38 | public function __construct(SVNHelper $helper, SVNHelper_Target $target) |
@@ -41,9 +41,9 @@ discard block |
||
41 | 41 | $this->target = $target; |
42 | 42 | } |
43 | 43 | |
44 | - /** |
|
45 | - * @return SVNHelper |
|
46 | - */ |
|
44 | + /** |
|
45 | + * @return SVNHelper |
|
46 | + */ |
|
47 | 47 | public function getSVN() |
48 | 48 | { |
49 | 49 | return $this->helper; |
@@ -100,15 +100,15 @@ discard block |
||
100 | 100 | return $cmd; |
101 | 101 | } |
102 | 102 | |
103 | - /** |
|
104 | - * Executes the specified command, and returns a result |
|
105 | - * instance to read the results. |
|
106 | - * |
|
107 | - * @param string $mode The command mode, e.g. commit / update... |
|
108 | - * @param string $path The path to apply the command to |
|
109 | - * @param array $params |
|
110 | - * @return SVNHelper_CommandResult |
|
111 | - */ |
|
103 | + /** |
|
104 | + * Executes the specified command, and returns a result |
|
105 | + * instance to read the results. |
|
106 | + * |
|
107 | + * @param string $mode The command mode, e.g. commit / update... |
|
108 | + * @param string $path The path to apply the command to |
|
109 | + * @param array $params |
|
110 | + * @return SVNHelper_CommandResult |
|
111 | + */ |
|
112 | 112 | protected function execCommand($mode, $path=null, $params=array()) |
113 | 113 | { |
114 | 114 | $relative = $this->helper->relativizePath($path); |
@@ -195,10 +195,10 @@ discard block |
||
195 | 195 | return $this->result; |
196 | 196 | } |
197 | 197 | |
198 | - /** |
|
199 | - * Retrieves the type of command, e.g. "Commit" |
|
200 | - * @return string |
|
201 | - */ |
|
198 | + /** |
|
199 | + * Retrieves the type of command, e.g. "Commit" |
|
200 | + * @return string |
|
201 | + */ |
|
202 | 202 | public function getType() |
203 | 203 | { |
204 | 204 | return str_replace('SVNHelper_Command_', '', get_class($this)); |
@@ -37,19 +37,19 @@ discard block |
||
37 | 37 | { |
38 | 38 | public const ERROR_CALLABLE_THREW_ERROR = 99601; |
39 | 39 | |
40 | - /** |
|
41 | - * @var string |
|
42 | - */ |
|
40 | + /** |
|
41 | + * @var string |
|
42 | + */ |
|
43 | 43 | protected $separator = ' '; |
44 | 44 | |
45 | - /** |
|
46 | - * @var string[] |
|
47 | - */ |
|
45 | + /** |
|
46 | + * @var string[] |
|
47 | + */ |
|
48 | 48 | protected $strings = array(); |
49 | 49 | |
50 | - /** |
|
51 | - * @var string |
|
52 | - */ |
|
50 | + /** |
|
51 | + * @var string |
|
52 | + */ |
|
53 | 53 | protected $noSeparator = '§!§'; |
54 | 54 | |
55 | 55 | public function __construct() |
@@ -63,12 +63,12 @@ discard block |
||
63 | 63 | return $this; |
64 | 64 | } |
65 | 65 | |
66 | - /** |
|
67 | - * Adds a subject as a string. Is ignored if empty. |
|
68 | - * |
|
69 | - * @param string|number|Interface_Stringable|NULL $string |
|
70 | - * @return $this |
|
71 | - */ |
|
66 | + /** |
|
67 | + * Adds a subject as a string. Is ignored if empty. |
|
68 | + * |
|
69 | + * @param string|number|Interface_Stringable|NULL $string |
|
70 | + * @return $this |
|
71 | + */ |
|
72 | 72 | public function add($string) : StringBuilder |
73 | 73 | { |
74 | 74 | $string = (string)$string; |
@@ -81,12 +81,12 @@ discard block |
||
81 | 81 | return $this; |
82 | 82 | } |
83 | 83 | |
84 | - /** |
|
85 | - * Adds a string without appending an automatic space. |
|
86 | - * |
|
87 | - * @param string|number|Interface_Stringable|NULL $string |
|
88 | - * @return $this |
|
89 | - */ |
|
84 | + /** |
|
85 | + * Adds a string without appending an automatic space. |
|
86 | + * |
|
87 | + * @param string|number|Interface_Stringable|NULL $string |
|
88 | + * @return $this |
|
89 | + */ |
|
90 | 90 | public function nospace($string) : StringBuilder |
91 | 91 | { |
92 | 92 | $flattened = (string)$string; |
@@ -99,46 +99,46 @@ discard block |
||
99 | 99 | return $this; |
100 | 100 | } |
101 | 101 | |
102 | - /** |
|
103 | - * Adds raw HTML code. Does not add an automatic space. |
|
104 | - * |
|
105 | - * @param string|number|Interface_Stringable $html |
|
106 | - * @return $this |
|
107 | - */ |
|
102 | + /** |
|
103 | + * Adds raw HTML code. Does not add an automatic space. |
|
104 | + * |
|
105 | + * @param string|number|Interface_Stringable $html |
|
106 | + * @return $this |
|
107 | + */ |
|
108 | 108 | public function html($html) : StringBuilder |
109 | 109 | { |
110 | 110 | return $this->nospace($html); |
111 | 111 | } |
112 | 112 | |
113 | - /** |
|
114 | - * Adds an unordered list with the specified items. |
|
115 | - * |
|
116 | - * @param array<int,string|number|Interface_Stringable> $items |
|
117 | - * @return $this |
|
118 | - */ |
|
113 | + /** |
|
114 | + * Adds an unordered list with the specified items. |
|
115 | + * |
|
116 | + * @param array<int,string|number|Interface_Stringable> $items |
|
117 | + * @return $this |
|
118 | + */ |
|
119 | 119 | public function ul(array $items) : StringBuilder |
120 | 120 | { |
121 | 121 | return $this->list('ul', $items); |
122 | 122 | } |
123 | 123 | |
124 | - /** |
|
125 | - * Adds an ordered list with the specified items. |
|
126 | - * |
|
127 | - * @param array<int,string|number|Interface_Stringable> $items |
|
128 | - * @return $this |
|
129 | - */ |
|
124 | + /** |
|
125 | + * Adds an ordered list with the specified items. |
|
126 | + * |
|
127 | + * @param array<int,string|number|Interface_Stringable> $items |
|
128 | + * @return $this |
|
129 | + */ |
|
130 | 130 | public function ol(array $items) : StringBuilder |
131 | 131 | { |
132 | 132 | return $this->list('ol', $items); |
133 | 133 | } |
134 | 134 | |
135 | - /** |
|
136 | - * Creates a list tag with the items list. |
|
137 | - * |
|
138 | - * @param string $type The list type, `ol` or `ul`. |
|
139 | - * @param array<int,string|number|Interface_Stringable> $items |
|
140 | - * @return $this |
|
141 | - */ |
|
135 | + /** |
|
136 | + * Creates a list tag with the items list. |
|
137 | + * |
|
138 | + * @param string $type The list type, `ol` or `ul`. |
|
139 | + * @param array<int,string|number|Interface_Stringable> $items |
|
140 | + * @return $this |
|
141 | + */ |
|
142 | 142 | protected function list(string $type, array $items) : StringBuilder |
143 | 143 | { |
144 | 144 | return $this->html(sprintf( |
@@ -148,13 +148,13 @@ discard block |
||
148 | 148 | )); |
149 | 149 | } |
150 | 150 | |
151 | - /** |
|
152 | - * Add a translated string. |
|
153 | - * |
|
154 | - * @param string $format The native string to translate. |
|
155 | - * @param array<int,mixed> $arguments The variables to inject into the translated string, if any. |
|
156 | - * @return $this |
|
157 | - */ |
|
151 | + /** |
|
152 | + * Add a translated string. |
|
153 | + * |
|
154 | + * @param string $format The native string to translate. |
|
155 | + * @param array<int,mixed> $arguments The variables to inject into the translated string, if any. |
|
156 | + * @return $this |
|
157 | + */ |
|
158 | 158 | public function t(string $format, ...$arguments) : StringBuilder |
159 | 159 | { |
160 | 160 | if(!class_exists('\AppLocalize\Localization')) |
@@ -207,36 +207,36 @@ discard block |
||
207 | 207 | return $this->add(ConvertHelper::duration2string($since)); |
208 | 208 | } |
209 | 209 | |
210 | - /** |
|
211 | - * Adds HTML double quotes around the string. |
|
212 | - * |
|
213 | - * @param string|number|Interface_Stringable $string |
|
214 | - * @return $this |
|
215 | - */ |
|
210 | + /** |
|
211 | + * Adds HTML double quotes around the string. |
|
212 | + * |
|
213 | + * @param string|number|Interface_Stringable $string |
|
214 | + * @return $this |
|
215 | + */ |
|
216 | 216 | public function quote($string) : StringBuilder |
217 | 217 | { |
218 | 218 | return $this->sf('"%s"', (string)$string); |
219 | 219 | } |
220 | 220 | |
221 | - /** |
|
222 | - * Adds a text that is meant as a reference to a UI element, |
|
223 | - * like a menu item, button, etc. |
|
224 | - * |
|
225 | - * @param string|number|Interface_Stringable $string |
|
226 | - * @return $this |
|
227 | - */ |
|
221 | + /** |
|
222 | + * Adds a text that is meant as a reference to a UI element, |
|
223 | + * like a menu item, button, etc. |
|
224 | + * |
|
225 | + * @param string|number|Interface_Stringable $string |
|
226 | + * @return $this |
|
227 | + */ |
|
228 | 228 | public function reference($string) : StringBuilder |
229 | 229 | { |
230 | 230 | return $this->sf('"%s"', $string); |
231 | 231 | } |
232 | 232 | |
233 | - /** |
|
234 | - * Add a string using the `sprintf` method. |
|
235 | - * |
|
236 | - * @param string $format The format string |
|
237 | - * @param string|number|Interface_Stringable ...$arguments The variables to inject |
|
238 | - * @return $this |
|
239 | - */ |
|
233 | + /** |
|
234 | + * Add a string using the `sprintf` method. |
|
235 | + * |
|
236 | + * @param string $format The format string |
|
237 | + * @param string|number|Interface_Stringable ...$arguments The variables to inject |
|
238 | + * @return $this |
|
239 | + */ |
|
240 | 240 | public function sf(string $format, ...$arguments) : StringBuilder |
241 | 241 | { |
242 | 242 | array_unshift($arguments, $format); |
@@ -244,12 +244,12 @@ discard block |
||
244 | 244 | return $this->add(sprintf(...$arguments)); |
245 | 245 | } |
246 | 246 | |
247 | - /** |
|
248 | - * Adds a bold string. |
|
249 | - * |
|
250 | - * @param string|number|Interface_Stringable $string |
|
251 | - * @return $this |
|
252 | - */ |
|
247 | + /** |
|
248 | + * Adds a bold string. |
|
249 | + * |
|
250 | + * @param string|number|Interface_Stringable $string |
|
251 | + * @return $this |
|
252 | + */ |
|
253 | 253 | public function bold($string) : StringBuilder |
254 | 254 | { |
255 | 255 | return $this->sf( |
@@ -258,15 +258,15 @@ discard block |
||
258 | 258 | ); |
259 | 259 | } |
260 | 260 | |
261 | - /** |
|
262 | - * Adds an HTML `<br>` tag. |
|
263 | - * |
|
264 | - * Note: for adding a newline character instead, |
|
265 | - * use {@see StringBuilder::eol()}. |
|
266 | - * |
|
267 | - * @return $this |
|
268 | - * @see StringBuilder::eol() |
|
269 | - */ |
|
261 | + /** |
|
262 | + * Adds an HTML `<br>` tag. |
|
263 | + * |
|
264 | + * Note: for adding a newline character instead, |
|
265 | + * use {@see StringBuilder::eol()}. |
|
266 | + * |
|
267 | + * @return $this |
|
268 | + * @see StringBuilder::eol() |
|
269 | + */ |
|
270 | 270 | public function nl() : StringBuilder |
271 | 271 | { |
272 | 272 | return $this->html('<br>'); |
@@ -283,42 +283,42 @@ discard block |
||
283 | 283 | return $this->nospace(PHP_EOL); |
284 | 284 | } |
285 | 285 | |
286 | - /** |
|
287 | - * Adds the current time, in the format <code>H:i:s</code>. |
|
288 | - * |
|
289 | - * @return $this |
|
290 | - */ |
|
286 | + /** |
|
287 | + * Adds the current time, in the format <code>H:i:s</code>. |
|
288 | + * |
|
289 | + * @return $this |
|
290 | + */ |
|
291 | 291 | public function time() : StringBuilder |
292 | 292 | { |
293 | 293 | return $this->add(date('H:i:s')); |
294 | 294 | } |
295 | 295 | |
296 | - /** |
|
297 | - * Adds the "Note:" text. |
|
298 | - * |
|
299 | - * @return $this |
|
300 | - */ |
|
296 | + /** |
|
297 | + * Adds the "Note:" text. |
|
298 | + * |
|
299 | + * @return $this |
|
300 | + */ |
|
301 | 301 | public function note() : StringBuilder |
302 | 302 | { |
303 | 303 | return $this->t('Note:'); |
304 | 304 | } |
305 | 305 | |
306 | - /** |
|
307 | - * Like {@see StringBuilder::note()}, but as bold text. |
|
308 | - * |
|
309 | - * @return $this |
|
310 | - */ |
|
306 | + /** |
|
307 | + * Like {@see StringBuilder::note()}, but as bold text. |
|
308 | + * |
|
309 | + * @return $this |
|
310 | + */ |
|
311 | 311 | public function noteBold() : StringBuilder |
312 | 312 | { |
313 | 313 | return $this->bold(sb()->note()); |
314 | 314 | } |
315 | 315 | |
316 | - /** |
|
317 | - * Adds the "Hint:" text. |
|
318 | - * |
|
319 | - * @return $this |
|
320 | - * @see StringBuilder::hintBold() |
|
321 | - */ |
|
316 | + /** |
|
317 | + * Adds the "Hint:" text. |
|
318 | + * |
|
319 | + * @return $this |
|
320 | + * @see StringBuilder::hintBold() |
|
321 | + */ |
|
322 | 322 | public function hint() : StringBuilder |
323 | 323 | { |
324 | 324 | return $this->t('Hint:'); |
@@ -334,12 +334,12 @@ discard block |
||
334 | 334 | return $this->bold(sb()->hint()); |
335 | 335 | } |
336 | 336 | |
337 | - /** |
|
338 | - * Adds two linebreaks. |
|
339 | - * |
|
340 | - * @param StringBuilder_Interface|string|NULL $content |
|
341 | - * @return $this |
|
342 | - */ |
|
337 | + /** |
|
338 | + * Adds two linebreaks. |
|
339 | + * |
|
340 | + * @param StringBuilder_Interface|string|NULL $content |
|
341 | + * @return $this |
|
342 | + */ |
|
343 | 343 | public function para($content=null) : StringBuilder |
344 | 344 | { |
345 | 345 | if($content !== null) { |
@@ -391,12 +391,12 @@ discard block |
||
391 | 391 | return $this->html(HTMLTag::create('a')->renderClose()); |
392 | 392 | } |
393 | 393 | |
394 | - /** |
|
395 | - * Wraps the string in a `code` tag. |
|
396 | - * |
|
397 | - * @param string|number|Interface_Stringable $string |
|
398 | - * @return $this |
|
399 | - */ |
|
394 | + /** |
|
395 | + * Wraps the string in a `code` tag. |
|
396 | + * |
|
397 | + * @param string|number|Interface_Stringable $string |
|
398 | + * @return $this |
|
399 | + */ |
|
400 | 400 | public function code($string) : StringBuilder |
401 | 401 | { |
402 | 402 | return $this->sf( |
@@ -405,24 +405,24 @@ discard block |
||
405 | 405 | ); |
406 | 406 | } |
407 | 407 | |
408 | - /** |
|
409 | - * Wraps the string in a `pre` tag. |
|
410 | - * |
|
411 | - * @param string|number|Interface_Stringable $string |
|
412 | - * @return $this |
|
413 | - */ |
|
408 | + /** |
|
409 | + * Wraps the string in a `pre` tag. |
|
410 | + * |
|
411 | + * @param string|number|Interface_Stringable $string |
|
412 | + * @return $this |
|
413 | + */ |
|
414 | 414 | public function pre($string) : StringBuilder |
415 | 415 | { |
416 | 416 | return $this->sf('<pre>%s</pre>', (string)$string); |
417 | 417 | } |
418 | 418 | |
419 | - /** |
|
420 | - * Wraps the text in a `span` tag with the specified classes. |
|
421 | - * |
|
422 | - * @param string|number|Interface_Stringable $string |
|
423 | - * @param string|string[] $classes |
|
424 | - * @return $this |
|
425 | - */ |
|
419 | + /** |
|
420 | + * Wraps the text in a `span` tag with the specified classes. |
|
421 | + * |
|
422 | + * @param string|number|Interface_Stringable $string |
|
423 | + * @param string|string[] $classes |
|
424 | + * @return $this |
|
425 | + */ |
|
426 | 426 | public function spanned($string, $classes) : StringBuilder |
427 | 427 | { |
428 | 428 | if(!is_array($classes)) |
@@ -25,12 +25,12 @@ discard block |
||
25 | 25 | { |
26 | 26 | protected ?string $details = null; |
27 | 27 | |
28 | - /** |
|
29 | - * @param string $message |
|
30 | - * @param string|NULL $details |
|
31 | - * @param int $code |
|
32 | - * @param Exception $previous |
|
33 | - */ |
|
28 | + /** |
|
29 | + * @param string $message |
|
30 | + * @param string|NULL $details |
|
31 | + * @param int $code |
|
32 | + * @param Exception $previous |
|
33 | + */ |
|
34 | 34 | public function __construct(string $message, ?string $details=null, $code=null, $previous=null) |
35 | 35 | { |
36 | 36 | if(defined('APP_UTILS_TESTSUITE') && APP_UTILS_TESTSUITE === 'true') |
@@ -43,18 +43,18 @@ discard block |
||
43 | 43 | $this->details = $details; |
44 | 44 | } |
45 | 45 | |
46 | - /** |
|
47 | - * Retrieves the detailed error description, if any. |
|
48 | - * @return string |
|
49 | - */ |
|
46 | + /** |
|
47 | + * Retrieves the detailed error description, if any. |
|
48 | + * @return string |
|
49 | + */ |
|
50 | 50 | public function getDetails() : string |
51 | 51 | { |
52 | 52 | return $this->details ?? ''; |
53 | 53 | } |
54 | 54 | |
55 | - /** |
|
56 | - * Displays pertinent information on the exception. |
|
57 | - */ |
|
55 | + /** |
|
56 | + * Displays pertinent information on the exception. |
|
57 | + */ |
|
58 | 58 | public function display() : void |
59 | 59 | { |
60 | 60 | if(!headers_sent()) { |
@@ -64,20 +64,20 @@ discard block |
||
64 | 64 | echo $this->getInfo(); |
65 | 65 | } |
66 | 66 | |
67 | - /** |
|
68 | - * Retrieves information on the exception that can be |
|
69 | - * easily accessed. |
|
70 | - * |
|
71 | - * @return ConvertHelper_ThrowableInfo |
|
72 | - */ |
|
67 | + /** |
|
68 | + * Retrieves information on the exception that can be |
|
69 | + * easily accessed. |
|
70 | + * |
|
71 | + * @return ConvertHelper_ThrowableInfo |
|
72 | + */ |
|
73 | 73 | public function getInfo() : ConvertHelper_ThrowableInfo |
74 | 74 | { |
75 | 75 | return ConvertHelper::throwable2info($this); |
76 | 76 | } |
77 | 77 | |
78 | - /** |
|
79 | - * Dumps a current PHP function trace, as a text only string. |
|
80 | - */ |
|
78 | + /** |
|
79 | + * Dumps a current PHP function trace, as a text only string. |
|
80 | + */ |
|
81 | 81 | public static function dumpTraceAsString() : void |
82 | 82 | { |
83 | 83 | try |
@@ -90,9 +90,9 @@ discard block |
||
90 | 90 | } |
91 | 91 | } |
92 | 92 | |
93 | - /** |
|
94 | - * Dumps a current PHP function trace, with HTML styling. |
|
95 | - */ |
|
93 | + /** |
|
94 | + * Dumps a current PHP function trace, with HTML styling. |
|
95 | + */ |
|
96 | 96 | public static function dumpTraceAsHTML() : void |
97 | 97 | { |
98 | 98 | try |
@@ -107,13 +107,13 @@ discard block |
||
107 | 107 | } |
108 | 108 | } |
109 | 109 | |
110 | - /** |
|
111 | - * Creates an exception info instance from a throwable instance. |
|
112 | - * |
|
113 | - * @param Throwable $e |
|
114 | - * @return ConvertHelper_ThrowableInfo |
|
115 | - * @see ConvertHelper::throwable2info() |
|
116 | - */ |
|
110 | + /** |
|
111 | + * Creates an exception info instance from a throwable instance. |
|
112 | + * |
|
113 | + * @param Throwable $e |
|
114 | + * @return ConvertHelper_ThrowableInfo |
|
115 | + * @see ConvertHelper::throwable2info() |
|
116 | + */ |
|
117 | 117 | public static function createInfo(Throwable $e) : ConvertHelper_ThrowableInfo |
118 | 118 | { |
119 | 119 | return ConvertHelper::throwable2info($e); |
@@ -42,23 +42,23 @@ discard block |
||
42 | 42 | public const OPTION_PATHMODE = 'pathmode'; |
43 | 43 | |
44 | 44 | /** |
45 | - * @var string |
|
46 | - */ |
|
45 | + * @var string |
|
46 | + */ |
|
47 | 47 | protected string $path; |
48 | 48 | |
49 | - /** |
|
50 | - * @var string[] |
|
51 | - */ |
|
49 | + /** |
|
50 | + * @var string[] |
|
51 | + */ |
|
52 | 52 | protected array $found = array(); |
53 | 53 | |
54 | - /** |
|
55 | - * The path must exist when the class is instantiated: its |
|
56 | - * real path will be determined to work with. |
|
57 | - * |
|
58 | - * @param string $path The absolute path to the target folder. |
|
59 | - * @throws FileHelper_Exception |
|
60 | - * @see FileFinder::ERROR_PATH_DOES_NOT_EXIST |
|
61 | - */ |
|
54 | + /** |
|
55 | + * The path must exist when the class is instantiated: its |
|
56 | + * real path will be determined to work with. |
|
57 | + * |
|
58 | + * @param string $path The absolute path to the target folder. |
|
59 | + * @throws FileHelper_Exception |
|
60 | + * @see FileFinder::ERROR_PATH_DOES_NOT_EXIST |
|
61 | + */ |
|
62 | 62 | public function __construct(string $path) |
63 | 63 | { |
64 | 64 | $real = realpath($path); |
@@ -90,11 +90,11 @@ discard block |
||
90 | 90 | ); |
91 | 91 | } |
92 | 92 | |
93 | - /** |
|
94 | - * Enables extension stripping, to return file names without extension. |
|
95 | - * |
|
96 | - * @return FileFinder |
|
97 | - */ |
|
93 | + /** |
|
94 | + * Enables extension stripping, to return file names without extension. |
|
95 | + * |
|
96 | + * @return FileFinder |
|
97 | + */ |
|
98 | 98 | public function stripExtensions() : FileFinder |
99 | 99 | { |
100 | 100 | return $this->setOption('strip-extensions', true); |
@@ -111,46 +111,46 @@ discard block |
||
111 | 111 | return $this->setOption('recursive', $enabled); |
112 | 112 | } |
113 | 113 | |
114 | - /** |
|
115 | - * Retrieves all extensions that were added to |
|
116 | - * the list of included extensions. |
|
117 | - * |
|
118 | - * @return string[] |
|
119 | - */ |
|
114 | + /** |
|
115 | + * Retrieves all extensions that were added to |
|
116 | + * the list of included extensions. |
|
117 | + * |
|
118 | + * @return string[] |
|
119 | + */ |
|
120 | 120 | public function getIncludeExtensions() : array |
121 | 121 | { |
122 | 122 | return $this->getArrayOption(self::OPTION_INCLUDE_EXTENSIONS); |
123 | 123 | } |
124 | 124 | |
125 | - /** |
|
126 | - * Includes a single extension in the file search: only |
|
127 | - * files with this extension will be used in the results. |
|
128 | - * |
|
129 | - * NOTE: Included extensions take precedence before excluded |
|
130 | - * extensions. If any excluded extensions are specified, they |
|
131 | - * will be ignored. |
|
132 | - * |
|
133 | - * @param string $extension Extension name, without dot (`php` for example). |
|
134 | - * @return FileFinder |
|
135 | - * @see FileFinder::includeExtensions() |
|
136 | - */ |
|
125 | + /** |
|
126 | + * Includes a single extension in the file search: only |
|
127 | + * files with this extension will be used in the results. |
|
128 | + * |
|
129 | + * NOTE: Included extensions take precedence before excluded |
|
130 | + * extensions. If any excluded extensions are specified, they |
|
131 | + * will be ignored. |
|
132 | + * |
|
133 | + * @param string $extension Extension name, without dot (`php` for example). |
|
134 | + * @return FileFinder |
|
135 | + * @see FileFinder::includeExtensions() |
|
136 | + */ |
|
137 | 137 | public function includeExtension(string $extension) : FileFinder |
138 | 138 | { |
139 | 139 | return $this->includeExtensions(array($extension)); |
140 | 140 | } |
141 | 141 | |
142 | - /** |
|
143 | - * Includes several extensions in the file search: only |
|
144 | - * files with these extensions wil be used in the results. |
|
145 | - * |
|
146 | - * NOTE: Included extensions take precedence before excluded |
|
147 | - * extensions. If any excluded extensions are specified, they |
|
148 | - * will be ignored. |
|
149 | - * |
|
150 | - * @param string[] $extensions Extension names, without dot (`php` for example). |
|
151 | - * @return FileFinder |
|
152 | - * @see FileFinder::includeExtension() |
|
153 | - */ |
|
142 | + /** |
|
143 | + * Includes several extensions in the file search: only |
|
144 | + * files with these extensions wil be used in the results. |
|
145 | + * |
|
146 | + * NOTE: Included extensions take precedence before excluded |
|
147 | + * extensions. If any excluded extensions are specified, they |
|
148 | + * will be ignored. |
|
149 | + * |
|
150 | + * @param string[] $extensions Extension names, without dot (`php` for example). |
|
151 | + * @return FileFinder |
|
152 | + * @see FileFinder::includeExtension() |
|
153 | + */ |
|
154 | 154 | public function includeExtensions(array $extensions) : FileFinder |
155 | 155 | { |
156 | 156 | $items = $this->getIncludeExtensions(); |
@@ -161,37 +161,37 @@ discard block |
||
161 | 161 | return $this; |
162 | 162 | } |
163 | 163 | |
164 | - /** |
|
165 | - * Retrieves a list of all extensions currently set as |
|
166 | - * excluded from the search. |
|
167 | - * |
|
168 | - * @return string[] |
|
169 | - */ |
|
164 | + /** |
|
165 | + * Retrieves a list of all extensions currently set as |
|
166 | + * excluded from the search. |
|
167 | + * |
|
168 | + * @return string[] |
|
169 | + */ |
|
170 | 170 | public function getExcludeExtensions() : array |
171 | 171 | { |
172 | 172 | return $this->getArrayOption(self::OPTION_EXCLUDE_EXTENSIONS); |
173 | 173 | } |
174 | 174 | |
175 | - /** |
|
176 | - * Excludes a single extension from the search. |
|
177 | - * |
|
178 | - * @param string $extension Extension name, without dot (`php` for example). |
|
179 | - * @return FileFinder |
|
180 | - * @see FileFinder::excludeExtensions() |
|
181 | - */ |
|
175 | + /** |
|
176 | + * Excludes a single extension from the search. |
|
177 | + * |
|
178 | + * @param string $extension Extension name, without dot (`php` for example). |
|
179 | + * @return FileFinder |
|
180 | + * @see FileFinder::excludeExtensions() |
|
181 | + */ |
|
182 | 182 | public function excludeExtension(string $extension) : FileFinder |
183 | 183 | { |
184 | 184 | return $this->excludeExtensions(array($extension)); |
185 | 185 | } |
186 | 186 | |
187 | - /** |
|
188 | - * Add several extensions to the list of extensions to |
|
189 | - * exclude from the file search. |
|
190 | - * |
|
191 | - * @param string[] $extensions Extension names, without dot (`php` for example). |
|
192 | - * @return FileFinder |
|
193 | - * @see FileFinder::excludeExtension() |
|
194 | - */ |
|
187 | + /** |
|
188 | + * Add several extensions to the list of extensions to |
|
189 | + * exclude from the file search. |
|
190 | + * |
|
191 | + * @param string[] $extensions Extension names, without dot (`php` for example). |
|
192 | + * @return FileFinder |
|
193 | + * @see FileFinder::excludeExtension() |
|
194 | + */ |
|
195 | 195 | public function excludeExtensions(array $extensions) : FileFinder |
196 | 196 | { |
197 | 197 | $items = $this->getExcludeExtensions(); |
@@ -202,52 +202,52 @@ discard block |
||
202 | 202 | return $this; |
203 | 203 | } |
204 | 204 | |
205 | - /** |
|
206 | - * In this mode, the entire path to the file will be stripped, |
|
207 | - * leaving only the file name in the files list. |
|
208 | - * |
|
209 | - * @return FileFinder |
|
210 | - */ |
|
205 | + /** |
|
206 | + * In this mode, the entire path to the file will be stripped, |
|
207 | + * leaving only the file name in the files list. |
|
208 | + * |
|
209 | + * @return FileFinder |
|
210 | + */ |
|
211 | 211 | public function setPathmodeStrip() : FileFinder |
212 | 212 | { |
213 | 213 | return $this->setPathmode(self::PATH_MODE_STRIP); |
214 | 214 | } |
215 | 215 | |
216 | - /** |
|
217 | - * In this mode, only the path relative to the source folder |
|
218 | - * will be included in the files list. |
|
219 | - * |
|
220 | - * @return FileFinder |
|
221 | - */ |
|
216 | + /** |
|
217 | + * In this mode, only the path relative to the source folder |
|
218 | + * will be included in the files list. |
|
219 | + * |
|
220 | + * @return FileFinder |
|
221 | + */ |
|
222 | 222 | public function setPathmodeRelative() : FileFinder |
223 | 223 | { |
224 | 224 | return $this->setPathmode(self::PATH_MODE_RELATIVE); |
225 | 225 | } |
226 | 226 | |
227 | - /** |
|
228 | - * In this mode, the full, absolute paths to the files will |
|
229 | - * be included in the files list. |
|
230 | - * |
|
231 | - * @return FileFinder |
|
232 | - */ |
|
227 | + /** |
|
228 | + * In this mode, the full, absolute paths to the files will |
|
229 | + * be included in the files list. |
|
230 | + * |
|
231 | + * @return FileFinder |
|
232 | + */ |
|
233 | 233 | public function setPathmodeAbsolute() : FileFinder |
234 | 234 | { |
235 | 235 | return $this->setPathmode(self::PATH_MODE_ABSOLUTE); |
236 | 236 | } |
237 | 237 | |
238 | - /** |
|
239 | - * This sets a character or string to replace the slashes |
|
240 | - * in the paths with. |
|
241 | - * |
|
242 | - * This is used for example in the `getPHPClassNames()` |
|
243 | - * method, to return files from subfolders as class names |
|
244 | - * using the "_" character: |
|
245 | - * |
|
246 | - * Subfolder/To/File.php => Subfolder_To_File.php |
|
247 | - * |
|
248 | - * @param string $character |
|
249 | - * @return FileFinder |
|
250 | - */ |
|
238 | + /** |
|
239 | + * This sets a character or string to replace the slashes |
|
240 | + * in the paths with. |
|
241 | + * |
|
242 | + * This is used for example in the `getPHPClassNames()` |
|
243 | + * method, to return files from subfolders as class names |
|
244 | + * using the "_" character: |
|
245 | + * |
|
246 | + * Subfolder/To/File.php => Subfolder_To_File.php |
|
247 | + * |
|
248 | + * @param string $character |
|
249 | + * @return FileFinder |
|
250 | + */ |
|
251 | 251 | public function setSlashReplacement(string $character) : FileFinder |
252 | 252 | { |
253 | 253 | return $this->setOption('slash-replacement', $character); |
@@ -270,12 +270,12 @@ discard block |
||
270 | 270 | return $this->setOption(self::OPTION_PATHMODE, $mode); |
271 | 271 | } |
272 | 272 | |
273 | - /** |
|
274 | - * Retrieves a list of all matching file names/paths, |
|
275 | - * depending on the selected options. |
|
276 | - * |
|
277 | - * @return string[] |
|
278 | - */ |
|
273 | + /** |
|
274 | + * Retrieves a list of all matching file names/paths, |
|
275 | + * depending on the selected options. |
|
276 | + * |
|
277 | + * @return string[] |
|
278 | + */ |
|
279 | 279 | public function getAll() : array |
280 | 280 | { |
281 | 281 | $this->find($this->path, true); |
@@ -283,24 +283,24 @@ discard block |
||
283 | 283 | return $this->found; |
284 | 284 | } |
285 | 285 | |
286 | - /** |
|
287 | - * Retrieves only PHP files. Can be combined with other |
|
288 | - * options like enabling recursion into subfolders. |
|
289 | - * |
|
290 | - * @return string[] |
|
291 | - */ |
|
286 | + /** |
|
287 | + * Retrieves only PHP files. Can be combined with other |
|
288 | + * options like enabling recursion into subfolders. |
|
289 | + * |
|
290 | + * @return string[] |
|
291 | + */ |
|
292 | 292 | public function getPHPFiles() : array |
293 | 293 | { |
294 | 294 | $this->includeExtensions(array('php')); |
295 | 295 | return $this->getAll(); |
296 | 296 | } |
297 | 297 | |
298 | - /** |
|
299 | - * Generates PHP class names from file paths: it replaces |
|
300 | - * slashes with underscores, and removes file extensions. |
|
301 | - * |
|
302 | - * @return string[] An array of PHP file names without extension. |
|
303 | - */ |
|
298 | + /** |
|
299 | + * Generates PHP class names from file paths: it replaces |
|
300 | + * slashes with underscores, and removes file extensions. |
|
301 | + * |
|
302 | + * @return string[] An array of PHP file names without extension. |
|
303 | + */ |
|
304 | 304 | public function getPHPClassNames() : array |
305 | 305 | { |
306 | 306 | $this->includeExtensions(array('php')); |
@@ -371,13 +371,13 @@ discard block |
||
371 | 371 | return $path; |
372 | 372 | } |
373 | 373 | |
374 | - /** |
|
375 | - * Checks whether the specified extension is allowed |
|
376 | - * with the current settings. |
|
377 | - * |
|
378 | - * @param string $extension |
|
379 | - * @return bool |
|
380 | - */ |
|
374 | + /** |
|
375 | + * Checks whether the specified extension is allowed |
|
376 | + * with the current settings. |
|
377 | + * |
|
378 | + * @param string $extension |
|
379 | + * @return bool |
|
380 | + */ |
|
381 | 381 | protected function filterExclusion(string $extension) : bool |
382 | 382 | { |
383 | 383 | $include = $this->getOption(self::OPTION_INCLUDE_EXTENSIONS); |
@@ -399,12 +399,12 @@ discard block |
||
399 | 399 | return true; |
400 | 400 | } |
401 | 401 | |
402 | - /** |
|
403 | - * Adjusts the path according to the selected path mode. |
|
404 | - * |
|
405 | - * @param string $path |
|
406 | - * @return string |
|
407 | - */ |
|
402 | + /** |
|
403 | + * Adjusts the path according to the selected path mode. |
|
404 | + * |
|
405 | + * @param string $path |
|
406 | + * @return string |
|
407 | + */ |
|
408 | 408 | protected function filterPath(string $path) : string |
409 | 409 | { |
410 | 410 | switch($this->getStringOption(self::OPTION_PATHMODE)) |