Skip to content

Commit 1f6ca84

Browse files
committed
[WIP] Update type hints and PHPDocs in Rules classes
1 parent 69ed3f0 commit 1f6ca84

File tree

6 files changed

+27
-27
lines changed

6 files changed

+27
-27
lines changed

src/Rules/After.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ class After extends Rule
1919
* Check the value is valid
2020
*
2121
* @param mixed $value
22-
* @return mixed
22+
* @return bool
2323
* @throws Exception
2424
*/
25-
public function check($value)
25+
public function check($value): bool
2626
{
2727
$this->requireParameters($this->fillableParams);
2828
$time = $this->parameter('time');

src/Rules/Callback.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class Callback extends Rule
2121
* @param Closure $callback
2222
* @return self
2323
*/
24-
public function setCallback(Closure $callback): self
24+
public function setCallback(Closure $callback): Rule
2525
{
2626
return $this->setParameter('callback', $callback);
2727
}
@@ -30,10 +30,10 @@ public function setCallback(Closure $callback): self
3030
* Check the $value is valid
3131
*
3232
* @param mixed $value
33-
* @return mixed
33+
* @return bool
3434
* @throws Exception
3535
*/
36-
public function check($value)
36+
public function check($value): bool
3737
{
3838
$this->requireParameters($this->fillableParams);
3939

src/Rules/FileTrait.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ trait FileTrait
1111
* Check whether value is from $_FILES
1212
*
1313
* @param mixed $value
14-
* @return mixed
14+
* @return bool
1515
*/
16-
public function isValueFromUploadedFiles($value)
16+
public function isValueFromUploadedFiles($value): bool
1717
{
1818
if (!is_array($value)) {
1919
return false;
@@ -43,10 +43,10 @@ public function isUploadedFile($value): bool
4343
/**
4444
* Given $size and get the bytes
4545
*
46-
* @param mixed $size
47-
* @return mixed
46+
* @param string|int $size
47+
* @return int
4848
*/
49-
protected function getBytes($size)
49+
protected function getBytes($size): int
5050
{
5151
if (is_int($size)) {
5252
return $size;

src/Rules/In.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ public function strict(bool $strict = true)
4545
* @param mixed $value
4646
* @return bool
4747
*/
48-
public function check($value)
48+
public function check($value): bool
4949
{
5050
$this->requireParameters(['allowed_values']);
5151

src/Rules/UploadedFile.php

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@ class UploadedFile extends Rule
1212
/** @var string */
1313
protected $message = "The :attribute is not valid";
1414

15-
/** @var mixed */
15+
/** @var string|int */
1616
protected $maxSize = null;
1717

18-
/** @var mixed */
18+
/** @var string|int */
1919
protected $minSize = null;
2020

2121
/** @var array */
@@ -25,7 +25,7 @@ class UploadedFile extends Rule
2525
* Given $params and assign $this->params
2626
*
2727
* @param array $params
28-
* @return Rule
28+
* @return self
2929
*/
3030
public function fillParameters(array $params): Rule
3131
{
@@ -39,10 +39,10 @@ public function fillParameters(array $params): Rule
3939
/**
4040
* Given $size and set the max size
4141
*
42-
* @param mixed $size
43-
* @return Rule
42+
* @param string|int $size
43+
* @return self
4444
*/
45-
public function maxSize($size)
45+
public function maxSize($size): Rule
4646
{
4747
$this->params['max_size'] = $size;
4848
return $this;
@@ -51,10 +51,10 @@ public function maxSize($size)
5151
/**
5252
* Given $size and set the min size
5353
*
54-
* @param mixed $size
55-
* @return Rule
54+
* @param string|int $size
55+
* @return self
5656
*/
57-
public function minSize($size)
57+
public function minSize($size): Rule
5858
{
5959
$this->params['min_size'] = $size;
6060
return $this;
@@ -63,11 +63,11 @@ public function minSize($size)
6363
/**
6464
* Given $min and $max then set the range size
6565
*
66-
* @param mixed $min
67-
* @param mixed $max
68-
* @return Rule
66+
* @param string|int $min
67+
* @param string|int $max
68+
* @return self
6969
*/
70-
public function sizeBetween($min, $max)
70+
public function sizeBetween($min, $max): Rule
7171
{
7272
$this->minSize($min);
7373
$this->maxSize($max);
@@ -79,9 +79,9 @@ public function sizeBetween($min, $max)
7979
* Given $types and assign $this->params
8080
*
8181
* @param mixed $types
82-
* @return Rule
82+
* @return self
8383
*/
84-
public function fileTypes($types)
84+
public function fileTypes($types): Rule
8585
{
8686
if (is_string($types)) {
8787
$types = explode('|', $types);

src/Rules/Url.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ public function fillParameters(array $params): Rule
3030
* @param array $schemes
3131
* @return self
3232
*/
33-
public function forScheme($schemes): self
33+
public function forScheme($schemes): Rule
3434
{
3535
$this->params['schemes'] = (array) $schemes;
3636
return $this;

0 commit comments

Comments
 (0)