Skip to content

Commit 196dbc0

Browse files
Cleanup more @return annotations
1 parent df10124 commit 196dbc0

File tree

6 files changed

+25
-25
lines changed

6 files changed

+25
-25
lines changed

AbstractUriElement.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ public function getNode()
6666
/**
6767
* Gets the method associated with this link.
6868
*
69-
* @return string The method
69+
* @return string
7070
*/
7171
public function getMethod()
7272
{
@@ -76,7 +76,7 @@ public function getMethod()
7676
/**
7777
* Gets the URI associated with this link.
7878
*
79-
* @return string The URI
79+
* @return string
8080
*/
8181
public function getUri()
8282
{

Crawler.php

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -572,7 +572,7 @@ public function children(string $selector = null)
572572
/**
573573
* Returns the attribute value of the first node of the list.
574574
*
575-
* @return string|null The attribute value or null if the attribute does not exist
575+
* @return string|null
576576
*
577577
* @throws \InvalidArgumentException When current node is empty
578578
*/
@@ -590,7 +590,7 @@ public function attr(string $attribute)
590590
/**
591591
* Returns the node name of the first node of the list.
592592
*
593-
* @return string The node name
593+
* @return string
594594
*
595595
* @throws \InvalidArgumentException When current node is empty
596596
*/
@@ -611,7 +611,7 @@ public function nodeName()
611611
* @param string|null $default When not null: the value to return when the current node is empty
612612
* @param bool $normalizeWhitespace Whether whitespaces should be trimmed and normalized to single spaces
613613
*
614-
* @return string The node value
614+
* @return string
615615
*
616616
* @throws \InvalidArgumentException When current node is empty
617617
*/
@@ -639,7 +639,7 @@ public function text(string $default = null, bool $normalizeWhitespace = true)
639639
*
640640
* @param string|null $default When not null: the value to return when the current node is empty
641641
*
642-
* @return string The node html
642+
* @return string
643643
*
644644
* @throws \InvalidArgumentException When current node is empty
645645
*/
@@ -721,7 +721,7 @@ public function evaluate(string $xpath)
721721
*
722722
* $crawler->filter('h1 a')->extract(['_text', 'href']);
723723
*
724-
* @return array An array of extracted values
724+
* @return array
725725
*/
726726
public function extract(array $attributes)
727727
{
@@ -962,7 +962,7 @@ public function registerNamespace(string $prefix, string $namespace)
962962
* echo Crawler::xpathLiteral('a\'b"c');
963963
* //prints concat('a', "'", 'b"c')
964964
*
965-
* @return string Converted string
965+
* @return string
966966
*/
967967
public static function xpathLiteral(string $s)
968968
{

Field/ChoiceFormField.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ public function addChoice(\DOMElement $node)
176176
/**
177177
* Returns the type of the choice field (radio, select, or checkbox).
178178
*
179-
* @return string The type
179+
* @return string
180180
*/
181181
public function getType()
182182
{
@@ -186,7 +186,7 @@ public function getType()
186186
/**
187187
* Returns true if the field accepts multiple values.
188188
*
189-
* @return bool true if the field accepts multiple values, false otherwise
189+
* @return bool
190190
*/
191191
public function isMultiple()
192192
{

Field/FormField.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ public function getLabel()
7979
/**
8080
* Returns the name of the field.
8181
*
82-
* @return string The name of the field
82+
* @return string
8383
*/
8484
public function getName()
8585
{
@@ -107,7 +107,7 @@ public function setValue(?string $value)
107107
/**
108108
* Returns true if the field should be included in the submitted values.
109109
*
110-
* @return bool true if the field should be included in the submitted values, false otherwise
110+
* @return bool
111111
*/
112112
public function hasValue()
113113
{

Form.php

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ public function setValues(array $values)
8383
*
8484
* The returned array does not include file fields (@see getFiles).
8585
*
86-
* @return array An array of field values
86+
* @return array
8787
*/
8888
public function getValues()
8989
{
@@ -104,7 +104,7 @@ public function getValues()
104104
/**
105105
* Gets the file field values.
106106
*
107-
* @return array An array of file field values
107+
* @return array
108108
*/
109109
public function getFiles()
110110
{
@@ -133,7 +133,7 @@ public function getFiles()
133133
* This method converts fields with the array notation
134134
* (like foo[bar] to arrays) like PHP does.
135135
*
136-
* @return array An array of field values
136+
* @return array
137137
*/
138138
public function getPhpValues()
139139
{
@@ -160,7 +160,7 @@ public function getPhpValues()
160160
* For a compound file field foo[bar] it will create foo[bar][name],
161161
* instead of foo[name][bar] which would be found in $_FILES.
162162
*
163-
* @return array An array of file field values
163+
* @return array
164164
*/
165165
public function getPhpFiles()
166166
{
@@ -196,7 +196,7 @@ function (&$value, $key) {
196196
* This method merges the value if the method is GET to mimics
197197
* browser behavior.
198198
*
199-
* @return string The URI
199+
* @return string
200200
*/
201201
public function getUri()
202202
{
@@ -234,7 +234,7 @@ protected function getRawUri()
234234
*
235235
* If no method is defined in the form, GET is returned.
236236
*
237-
* @return string The method
237+
* @return string
238238
*/
239239
public function getMethod()
240240
{
@@ -263,7 +263,7 @@ public function getName(): string
263263
/**
264264
* Returns true if the named field exists.
265265
*
266-
* @return bool true if the field exists, false otherwise
266+
* @return bool
267267
*/
268268
public function has(string $name)
269269
{
@@ -281,7 +281,7 @@ public function remove(string $name)
281281
/**
282282
* Gets a named field.
283283
*
284-
* @return FormField|FormField[]|FormField[][] The value of the field
284+
* @return FormField|FormField[]|FormField[][]
285285
*
286286
* @throws \InvalidArgumentException When field is not present in this form
287287
*/
@@ -313,7 +313,7 @@ public function all()
313313
*
314314
* @param string $name The field name
315315
*
316-
* @return bool true if the field exists, false otherwise
316+
* @return bool
317317
*/
318318
#[\ReturnTypeWillChange]
319319
public function offsetExists($name)
@@ -326,7 +326,7 @@ public function offsetExists($name)
326326
*
327327
* @param string $name The field name
328328
*
329-
* @return FormField|FormField[]|FormField[][] The value of the field
329+
* @return FormField|FormField[]|FormField[][]
330330
*
331331
* @throws \InvalidArgumentException if the field does not exist
332332
*/

FormFieldRegistry.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ public function remove(string $name)
6666
/**
6767
* Returns the value of the field based on the fully qualifed name and its children.
6868
*
69-
* @return FormField|FormField[]|FormField[][] The value of the field
69+
* @return FormField|FormField[]|FormField[][]
7070
*
7171
* @throws \InvalidArgumentException if the field does not exist
7272
*/
@@ -88,7 +88,7 @@ public function &get(string $name)
8888
/**
8989
* Tests whether the form has the given field based on the fully qualified name.
9090
*
91-
* @return bool Whether the form has the given field
91+
* @return bool
9292
*/
9393
public function has(string $name): bool
9494
{
@@ -157,7 +157,7 @@ private function walk(array $array, ?string $base = '', array &$output = []): ar
157157
*
158158
* getSegments('base[foo][3][]') = ['base', 'foo, '3', ''];
159159
*
160-
* @return string[] The list of segments
160+
* @return string[]
161161
*/
162162
private function getSegments(string $name): array
163163
{

0 commit comments

Comments
 (0)