Skip to content

Commit 5da3697

Browse files
dgdg
committed
phpDoc: added $var name to @param 
1 parent edfc435 commit 5da3697

22 files changed

+61
-61
lines changed

‎src/Forms/Container.php‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ public function isValid(): bool
128128

129129
/**
130130
* Performs the server side validation.
131-
* @param IControl[]
131+
* @param IControl[] $controls
132132
*/
133133
public function validate(array $controls = null): void
134134
{
@@ -224,7 +224,7 @@ public function getForm(bool $throw = true): ?Form
224224

225225
/**
226226
* Adds single-line text input control to the form.
227-
* @param string|object $label
227+
* @param string|object $label
228228
*/
229229
public function addText(string $name, $label = null, int $cols = null, int $maxLength = null): Controls\TextInput
230230
{
@@ -235,7 +235,7 @@ public function addText(string $name, $label = null, int $cols = null, int $maxL
235235

236236
/**
237237
* Adds single-line text input control used for sensitive input such as passwords.
238-
* @param string|object $label
238+
* @param string|object $label
239239
*/
240240
public function addPassword(string $name, $label = null, int $cols = null, int $maxLength = null): Controls\TextInput
241241
{
@@ -247,7 +247,7 @@ public function addPassword(string $name, $label = null, int $cols = null, int $
247247

248248
/**
249249
* Adds multi-line text input control to the form.
250-
* @param string|object $label
250+
* @param string|object $label
251251
*/
252252
public function addTextArea(string $name, $label = null, int $cols = null, int $rows = null): Controls\TextArea
253253
{
@@ -258,7 +258,7 @@ public function addTextArea(string $name, $label = null, int $cols = null, int $
258258

259259
/**
260260
* Adds input for email.
261-
* @param string|object $label
261+
* @param string|object $label
262262
*/
263263
public function addEmail(string $name, $label = null): Controls\TextInput
264264
{
@@ -270,7 +270,7 @@ public function addEmail(string $name, $label = null): Controls\TextInput
270270

271271
/**
272272
* Adds input for integer.
273-
* @param string|object $label
273+
* @param string|object $label
274274
*/
275275
public function addInteger(string $name, $label = null): Controls\TextInput
276276
{
@@ -283,7 +283,7 @@ public function addInteger(string $name, $label = null): Controls\TextInput
283283

284284
/**
285285
* Adds control that allows the user to upload files.
286-
* @param string|object $label
286+
* @param string|object $label
287287
*/
288288
public function addUpload(string $name, $label = null): Controls\UploadControl
289289
{
@@ -297,7 +297,7 @@ public function addUpload(string $name, $label = null): Controls\UploadControl
297297

298298
/**
299299
* Adds control that allows the user to upload multiple files.
300-
* @param string|object $label
300+
* @param string|object $label
301301
*/
302302
public function addMultiUpload(string $name, $label = null): Controls\UploadControl
303303
{
@@ -317,7 +317,7 @@ public function addHidden(string $name, string $default = null): Controls\Hidden
317317

318318
/**
319319
* Adds check box control to the form.
320-
* @param string|object $caption
320+
* @param string|object $caption
321321
*/
322322
public function addCheckbox(string $name, $caption = null): Controls\Checkbox
323323
{
@@ -327,7 +327,7 @@ public function addCheckbox(string $name, $caption = null): Controls\Checkbox
327327

328328
/**
329329
* Adds set of radio button controls to the form.
330-
* @param string|object $label
330+
* @param string|object $label
331331
*/
332332
public function addRadioList(string $name, $label = null, array $items = null): Controls\RadioList
333333
{
@@ -337,7 +337,7 @@ public function addRadioList(string $name, $label = null, array $items = null):
337337

338338
/**
339339
* Adds set of checkbox controls to the form.
340-
* @param string|object $label
340+
* @param string|object $label
341341
*/
342342
public function addCheckboxList(string $name, $label = null, array $items = null): Controls\CheckboxList
343343
{
@@ -347,7 +347,7 @@ public function addCheckboxList(string $name, $label = null, array $items = null
347347

348348
/**
349349
* Adds select box control that allows single item selection.
350-
* @param string|object $label
350+
* @param string|object $label
351351
*/
352352
public function addSelect(string $name, $label = null, array $items = null, int $size = null): Controls\SelectBox
353353
{
@@ -358,7 +358,7 @@ public function addSelect(string $name, $label = null, array $items = null, int
358358

359359
/**
360360
* Adds select box control that allows multiple item selection.
361-
* @param string|object $label
361+
* @param string|object $label
362362
*/
363363
public function addMultiSelect(string $name, $label = null, array $items = null, int $size = null): Controls\MultiSelectBox
364364
{
@@ -369,7 +369,7 @@ public function addMultiSelect(string $name, $label = null, array $items = null,
369369

370370
/**
371371
* Adds button used to submit form.
372-
* @param string|object $caption
372+
* @param string|object $caption
373373
*/
374374
public function addSubmit(string $name, $caption = null): Controls\SubmitButton
375375
{
@@ -379,7 +379,7 @@ public function addSubmit(string $name, $caption = null): Controls\SubmitButton
379379

380380
/**
381381
* Adds push buttons with no default behavior.
382-
* @param string|object $caption
382+
* @param string|object $caption
383383
*/
384384
public function addButton(string $name, $caption = null): Controls\Button
385385
{
@@ -389,8 +389,8 @@ public function addButton(string $name, $caption = null): Controls\Button
389389

390390
/**
391391
* Adds graphical button used to submit form.
392-
* @param string $src URI of the image
393-
* @param string $alt alternate text for the image
392+
* @param string $src URI of the image
393+
* @param string $alt alternate text for the image
394394
*/
395395
public function addImage(string $name, string $src = null, string $alt = null): Controls\ImageButton
396396
{
@@ -400,7 +400,7 @@ public function addImage(string $name, string $src = null, string $alt = null):
400400

401401
/**
402402
* Adds naming container to the form.
403-
* @param string|int
403+
* @param string|int $name
404404
*/
405405
public function addContainer($name): self
406406
{

‎src/Forms/Controls/BaseControl.php‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ abstract class BaseControl extends Nette\ComponentModel\Component implements ICo
7979

8080

8181
/**
82-
* @param string|object
82+
* @param string|object $caption
8383
*/
8484
public function __construct($caption = null)
8585
{
@@ -102,7 +102,7 @@ public function __construct($caption = null)
102102

103103
/**
104104
* Sets textual caption or label.
105-
* @param object|string
105+
* @param object|string $caption
106106
* @return static
107107
*/
108108
public function setCaption($caption)
@@ -274,7 +274,7 @@ public function getControl()
274274

275275
/**
276276
* Generates label's HTML element.
277-
* @param string|object
277+
* @param string|object $caption
278278
* @return Html|string
279279
*/
280280
public function getLabel($caption = null)
@@ -320,7 +320,7 @@ public function getLabelPrototype(): Html
320320

321321
/**
322322
* Changes control's HTML id.
323-
* @param mixed new ID, or false or null
323+
* @param string|bool|null $id
324324
* @return static
325325
*/
326326
public function setHtmlId($id)
@@ -413,8 +413,8 @@ public function translate($value, int $count = null)
413413

414414
/**
415415
* Adds a validation rule.
416-
* @param mixed
417-
* @param string|object
416+
* @param callable|string $validator
417+
* @param string|object $errorMessage
418418
* @return static
419419
*/
420420
public function addRule($validator, $errorMessage = null, $arg = null)
@@ -452,7 +452,7 @@ public function getRules(): Rules
452452

453453
/**
454454
* Makes control mandatory.
455-
* @param mixed state or error message
455+
* @param boo|string|object $value
456456
* @return static
457457
*/
458458
public function setRequired($value = true)
@@ -486,7 +486,7 @@ public function validate(): void
486486

487487
/**
488488
* Adds error message to the list.
489-
* @param string|object
489+
* @param string|object $message
490490
*/
491491
public function addError($message, bool $translate = true): void
492492
{

‎src/Forms/Controls/Button.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ class Button extends BaseControl
1919
{
2020

2121
/**
22-
* @param string|object
22+
* @param string|object $caption
2323
*/
2424
public function __construct($caption = null)
2525
{
@@ -49,7 +49,7 @@ public function getLabel($caption = null): void
4949

5050
/**
5151
* Generates control's HTML element.
52-
* @param string|object
52+
* @param string|object $caption
5353
*/
5454
public function getControl($caption = null): Nette\Utils\Html
5555
{

‎src/Forms/Controls/Checkbox.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ class Checkbox extends BaseControl
2323

2424

2525
/**
26-
* @param string|object
26+
* @param string|object $label
2727
*/
2828
public function __construct($label = null)
2929
{

‎src/Forms/Controls/CheckboxList.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ class CheckboxList extends MultiChoiceControl
3333

3434

3535
/**
36-
* @param string|object
36+
* @param string|object $label
3737
*/
3838
public function __construct($label = null, array $items = null)
3939
{
@@ -74,7 +74,7 @@ public function getControl(): Html
7474

7575
/**
7676
* Generates label's HTML element.
77-
* @param string|object
77+
* @param string|object $caption
7878
*/
7979
public function getLabel($caption = null): Html
8080
{

‎src/Forms/Controls/ChoiceControl.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ public function loadHttpData(): void
5757

5858
/**
5959
* Sets selected item (by key).
60-
* @param string|int
60+
* @param string|int $value
6161
* @return static
6262
* @internal
6363
*/
@@ -134,7 +134,7 @@ public function getSelectedItem()
134134

135135
/**
136136
* Disables or enables control or items.
137-
* @param bool|array
137+
* @param bool|array $value
138138
* @return static
139139
*/
140140
public function setDisabled($value = true)

‎src/Forms/Controls/CsrfProtection.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ class CsrfProtection extends HiddenField
2525

2626

2727
/**
28-
* @param string|object
28+
* @param string|object $errorMessage
2929
*/
3030
public function __construct($errorMessage)
3131
{

‎src/Forms/Controls/HiddenField.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ public function getControl(): Nette\Utils\Html
6868

6969
/**
7070
* Bypasses label generation.
71-
* @param string|object
71+
* @param string|object $caption
7272
*/
7373
public function getLabel($caption = null): void
7474
{
@@ -77,7 +77,7 @@ public function getLabel($caption = null): void
7777

7878
/**
7979
* Adds error message to the list.
80-
* @param string|object
80+
* @param string|object $message
8181
*/
8282
public function addError($message, bool $translate = true): void
8383
{

‎src/Forms/Controls/ImageButton.php‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ class ImageButton extends SubmitButton
1717
{
1818

1919
/**
20-
* @param string URI of the image
21-
* @param string alternate text for the image
20+
* @param string $src URI of the image
21+
* @param string $alt alternate text for the image
2222
*/
2323
public function __construct(string $src = null, string $alt = null)
2424
{

‎src/Forms/Controls/MultiChoiceControl.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ public function getSelectedItems(): array
139139

140140
/**
141141
* Disables or enables control or items.
142-
* @param bool|array
142+
* @param bool|bool[] $value
143143
* @return static
144144
*/
145145
public function setDisabled($value = true)

0 commit comments

Comments
 (0)