Skip to content

Commit e3ca9f4

Browse files
wulffconst-cloudinary
authored andcommitted
Fix phpdoc @param tags with the NULL type
Parameters documented by "@param null" make it difficult for IDEs and static analysis tools to reason about the code.
1 parent 4c35d38 commit e3ca9f4

40 files changed

+156
-133
lines changed

src/Transformation/Adjustment/Improve.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ class Improve extends BlendEffectQualifier
3131
/**
3232
* Improve constructor.
3333
*
34-
* @param $blend
35-
* @param null $mode
34+
* @param $blend
35+
* @param mixed $mode
3636
*/
3737
public function __construct($blend = null, $mode = null)
3838
{

src/Transformation/Background/AutoGradientBackground.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class AutoGradientBackground extends AutoBackground
4444
*
4545
* @param string $mode The auto background mode.
4646
* @param int|string $gradientColors The number of gradient colors to select. Possible values: 2 or 4. Default: 2
47-
* @param null $gradientDirection The direction. Use the constants defined in the GradientDirection class.
47+
* @param string $gradientDirection The direction. Use the constants defined in the GradientDirection class.
4848
*/
4949
public function __construct($mode, $gradientColors = null, $gradientDirection = null)
5050
{

src/Transformation/Border/BorderValue.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ class BorderValue extends QualifierMultiValue
2828
/**
2929
* BorderValue constructor.
3030
*
31-
* @param null $color
32-
* @param null $width
33-
* @param null $style
31+
* @param string $color
32+
* @param int|string $width
33+
* @param string $style
3434
*/
3535
public function __construct($color = null, $width = null, $style = null)
3636
{

src/Transformation/CommonTransformation.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class CommonTransformation extends BaseComponent implements CommonTransformation
2828
/**
2929
* CommonTransformation constructor.
3030
*
31-
* @param null $transformation
31+
* @param mixed $transformation
3232
*/
3333
public function __construct($transformation = null)
3434
{

src/Transformation/CustomFunction/CustomFunctionValue.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,9 @@ class CustomFunctionValue extends QualifierMultiValue
2323
/**
2424
* CustomFunctionValue constructor.
2525
*
26-
* @param null $source
27-
* @param null $type
28-
* @param null $preprocess
26+
* @param mixed $source
27+
* @param mixed $type
28+
* @param mixed $preprocess
2929
*/
3030
public function __construct($source = null, $type = null, $preprocess = null)
3131
{

src/Transformation/Delivery/Quality/QualityQualifier.php

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010

1111
namespace Cloudinary\Transformation;
1212

13+
use Cloudinary\Transformation\BaseComponent;
1314
use Cloudinary\Transformation\Qualifier\BaseExpressionQualifier;
1415

1516
/**
@@ -60,9 +61,9 @@ class QualityQualifier extends BaseExpressionQualifier
6061
/**
6162
* Quality constructor.
6263
*
63-
* @param $strength
64-
* @param null $preset
65-
* @param array $values
64+
* @param mixed $strength
65+
* @param mixed|BaseComponent $preset
66+
* @param mixed $values
6667
*/
6768
public function __construct($strength, $preset = null, ...$values)
6869
{

src/Transformation/Effect/Color/AssistColorBlind.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ class AssistColorBlind extends LimitedEffectQualifier
2222
/**
2323
* AssistColorBlind constructor.
2424
*
25-
* @param null $strength
25+
* @param string $strength
2626
*/
2727
public function __construct($strength = null)
2828
{

src/Transformation/Effect/Color/SimulateColorBlind.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ class SimulateColorBlind extends ValueEffectQualifier
5353
/**
5454
* SimulateColorBlind constructor.
5555
*
56-
* @param null $condition
56+
* @param string $condition
5757
*/
5858
public function __construct($condition = null)
5959
{

src/Transformation/Effect/EffectActionTrait.php

Lines changed: 29 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@ public static function named($name, ...$args)
3131
}
3232

3333
/**
34-
* @param $effectName
35-
* @param null $value
36-
* @param mixed ...$args
34+
* @param string $effectName
35+
* @param mixed $value
36+
* @param mixed ...$args
3737
*
3838
* @return EffectAction
3939
*/
@@ -43,10 +43,10 @@ public static function valued($effectName, $value = null, ...$args)
4343
}
4444

4545
/**
46-
* @param $effectName
47-
* @param $range
48-
* @param null $value
49-
* @param mixed ...$args
46+
* @param string $effectName
47+
* @param array $range
48+
* @param mixed $value
49+
* @param mixed ...$args
5050
*
5151
* @return EffectAction
5252
*/
@@ -56,10 +56,10 @@ public static function limited($effectName, $range, $value = null, ...$args)
5656
}
5757

5858
/**
59-
* @param $effectName
60-
* @param $range
61-
* @param null $value
62-
* @param mixed ...$args
59+
* @param string $effectName
60+
* @param array $range
61+
* @param mixed $value
62+
* @param mixed ...$args
6363
*
6464
* @return LevelEffectAction
6565
*/
@@ -69,10 +69,10 @@ public static function withLevel($effectName, $range, $value = null, ...$args)
6969
}
7070

7171
/**
72-
* @param $effectName
73-
* @param $range
74-
* @param null $value
75-
* @param mixed ...$args
72+
* @param string $effectName
73+
* @param array $range
74+
* @param mixed $value
75+
* @param mixed ...$args
7676
*
7777
* @return StrengthEffectAction
7878
*/
@@ -82,10 +82,10 @@ public static function withStrength($effectName, $range, $value = null, ...$args
8282
}
8383

8484
/**
85-
* @param $effectName
86-
* @param $range
87-
* @param null $value
88-
* @param mixed ...$args
85+
* @param string $effectName
86+
* @param array $range
87+
* @param mixed $value
88+
* @param mixed ...$args
8989
*
9090
* @return BlendEffectAction
9191
*/
@@ -95,10 +95,10 @@ public static function withBlend($effectName, $range, $value = null, ...$args)
9595
}
9696

9797
/**
98-
* @param $effectName
99-
* @param $range
100-
* @param null $value
101-
* @param mixed ...$args
98+
* @param string $effectName
99+
* @param array $range
100+
* @param mixed $value
101+
* @param mixed ...$args
102102
*
103103
* @return ThresholdEffectAction
104104
*/
@@ -108,9 +108,9 @@ public static function withThreshold($effectName, $range, $value = null, ...$arg
108108
}
109109

110110
/**
111-
* @param $effectName
112-
* @param null $value
113-
* @param mixed ...$args
111+
* @param string $effectName
112+
* @param mixed $value
113+
* @param mixed ...$args
114114
*
115115
* @return DurationEffectAction
116116
*/
@@ -120,9 +120,9 @@ public static function withDuration($effectName, $value = null, ...$args)
120120
}
121121

122122
/**
123-
* @param $effectName
124-
* @param null $value
125-
* @param mixed ...$args
123+
* @param string $effectName
124+
* @param array $value
125+
* @param mixed ...$args
126126
*
127127
* @return ToleranceEffectAction
128128
*/

src/Transformation/Effect/LimitedEffectQualifier.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ class LimitedEffectQualifier extends ValueEffectQualifier
2929
/**
3030
* LimitedEffectQualifier constructor.
3131
*
32-
* @param $effectName
33-
* @param $range
34-
* @param $level
35-
* @param array $args
32+
* @param string $effectName
33+
* @param array $range
34+
* @param mixed $level
35+
* @param array $args
3636
*/
3737
public function __construct($effectName, $range, $level = null, ...$args)
3838
{

0 commit comments

Comments
 (0)