Skip to content

Commit 52f8a93

Browse files
gsteelgsteel
authored
Merge pull request #342 from gsteel/v2/mime-type-deprecations
`MimeType` deprecations
2 parents 4b0cabc + 2d9d4b1 commit 52f8a93

File tree

3 files changed

+172
-7
lines changed

3 files changed

+172
-7
lines changed

‎psalm-baseline.xml‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1054,6 +1054,12 @@
10541054
</PossiblyFalseOperand>
10551055
</file>
10561056
<file src="src/File/ExcludeMimeType.php">
1057+
<DeprecatedMethod>
1058+
<code><![CDATA[getHeaderCheck]]></code>
1059+
<code><![CDATA[getMagicFile]]></code>
1060+
<code><![CDATA[getMimeType]]></code>
1061+
<code><![CDATA[isMagicFileDisabled]]></code>
1062+
</DeprecatedMethod>
10571063
<DeprecatedTrait>
10581064
<code><![CDATA[FileInformationTrait]]></code>
10591065
</DeprecatedTrait>
@@ -1410,6 +1416,10 @@
14101416
</RedundantConditionGivenDocblockType>
14111417
</file>
14121418
<file src="src/File/IsCompressed.php">
1419+
<DeprecatedMethod>
1420+
<code><![CDATA[getMimeType]]></code>
1421+
<code><![CDATA[setMimeType]]></code>
1422+
</DeprecatedMethod>
14131423
<DocblockTypeContradiction>
14141424
<code><![CDATA[$options === null]]></code>
14151425
</DocblockTypeContradiction>
@@ -1423,6 +1433,10 @@
14231433
</PropertyNotSetInConstructor>
14241434
</file>
14251435
<file src="src/File/IsImage.php">
1436+
<DeprecatedMethod>
1437+
<code><![CDATA[getMimeType]]></code>
1438+
<code><![CDATA[setMimeType]]></code>
1439+
</DeprecatedMethod>
14261440
<DocblockTypeContradiction>
14271441
<code><![CDATA[$options === null]]></code>
14281442
</DocblockTypeContradiction>
@@ -1465,6 +1479,27 @@
14651479
</MoreSpecificImplementedParamType>
14661480
</file>
14671481
<file src="src/File/MimeType.php">
1482+
<DeprecatedClass>
1483+
<code><![CDATA[new Exception\InvalidMagicMimeFileException(sprintf(
1484+
'The given magicfile ("%s") could not be used by ext/finfo',
1485+
$file
1486+
), 0, $error)]]></code>
1487+
</DeprecatedClass>
1488+
<DeprecatedMethod>
1489+
<code><![CDATA[addMimeType]]></code>
1490+
<code><![CDATA[addMimeType]]></code>
1491+
<code><![CDATA[enableHeaderCheck]]></code>
1492+
<code><![CDATA[getHeaderCheck]]></code>
1493+
<code><![CDATA[getMagicFile]]></code>
1494+
<code><![CDATA[getMimeType]]></code>
1495+
<code><![CDATA[getMimeType]]></code>
1496+
<code><![CDATA[isMagicFileDisabled]]></code>
1497+
<code><![CDATA[setMagicFile]]></code>
1498+
<code><![CDATA[setMagicFile]]></code>
1499+
<code><![CDATA[setMagicFile]]></code>
1500+
<code><![CDATA[setMimeType]]></code>
1501+
<code><![CDATA[setMimeType]]></code>
1502+
</DeprecatedMethod>
14681503
<DeprecatedTrait>
14691504
<code><![CDATA[FileInformationTrait]]></code>
14701505
</DeprecatedTrait>
@@ -2993,6 +3028,26 @@
29933028
</PossiblyUnusedMethod>
29943029
</file>
29953030
<file src="test/File/ExcludeMimeTypeTest.php">
3031+
<DeprecatedMethod>
3032+
<code><![CDATA[addMimeType]]></code>
3033+
<code><![CDATA[addMimeType]]></code>
3034+
<code><![CDATA[addMimeType]]></code>
3035+
<code><![CDATA[addMimeType]]></code>
3036+
<code><![CDATA[enableHeaderCheck]]></code>
3037+
<code><![CDATA[enableHeaderCheck]]></code>
3038+
<code><![CDATA[getMimeType]]></code>
3039+
<code><![CDATA[getMimeType]]></code>
3040+
<code><![CDATA[getMimeType]]></code>
3041+
<code><![CDATA[getMimeType]]></code>
3042+
<code><![CDATA[getMimeType]]></code>
3043+
<code><![CDATA[getMimeType]]></code>
3044+
<code><![CDATA[getMimeType]]></code>
3045+
<code><![CDATA[getMimeType]]></code>
3046+
<code><![CDATA[getMimeType]]></code>
3047+
<code><![CDATA[getMimeType]]></code>
3048+
<code><![CDATA[getMimeType]]></code>
3049+
<code><![CDATA[setMimeType]]></code>
3050+
</DeprecatedMethod>
29963051
<MixedArgument>
29973052
<code><![CDATA[$isValidParam['tmp_name']]]></code>
29983053
</MixedArgument>
@@ -3174,6 +3229,31 @@
31743229
</PossiblyUnusedMethod>
31753230
</file>
31763231
<file src="test/File/IsCompressedTest.php">
3232+
<DeprecatedMethod>
3233+
<code><![CDATA[addMimeType]]></code>
3234+
<code><![CDATA[addMimeType]]></code>
3235+
<code><![CDATA[addMimeType]]></code>
3236+
<code><![CDATA[addMimeType]]></code>
3237+
<code><![CDATA[enableHeaderCheck]]></code>
3238+
<code><![CDATA[enableHeaderCheck]]></code>
3239+
<code><![CDATA[enableHeaderCheck]]></code>
3240+
<code><![CDATA[getHeaderCheck]]></code>
3241+
<code><![CDATA[getMagicFile]]></code>
3242+
<code><![CDATA[getMimeType]]></code>
3243+
<code><![CDATA[getMimeType]]></code>
3244+
<code><![CDATA[getMimeType]]></code>
3245+
<code><![CDATA[getMimeType]]></code>
3246+
<code><![CDATA[getMimeType]]></code>
3247+
<code><![CDATA[getMimeType]]></code>
3248+
<code><![CDATA[getMimeType]]></code>
3249+
<code><![CDATA[getMimeType]]></code>
3250+
<code><![CDATA[getMimeType]]></code>
3251+
<code><![CDATA[getMimeType]]></code>
3252+
<code><![CDATA[getMimeType]]></code>
3253+
<code><![CDATA[getMimeType]]></code>
3254+
<code><![CDATA[getMimeType]]></code>
3255+
<code><![CDATA[setMimeType]]></code>
3256+
</DeprecatedMethod>
31773257
<PossiblyInvalidArgument>
31783258
<code><![CDATA[$isValidParam['tmp_name']]]></code>
31793259
</PossiblyInvalidArgument>
@@ -3188,6 +3268,31 @@
31883268
</PossiblyUnusedMethod>
31893269
</file>
31903270
<file src="test/File/IsImageTest.php">
3271+
<DeprecatedMethod>
3272+
<code><![CDATA[addMimeType]]></code>
3273+
<code><![CDATA[addMimeType]]></code>
3274+
<code><![CDATA[addMimeType]]></code>
3275+
<code><![CDATA[addMimeType]]></code>
3276+
<code><![CDATA[enableHeaderCheck]]></code>
3277+
<code><![CDATA[enableHeaderCheck]]></code>
3278+
<code><![CDATA[enableHeaderCheck]]></code>
3279+
<code><![CDATA[getHeaderCheck]]></code>
3280+
<code><![CDATA[getMagicFile]]></code>
3281+
<code><![CDATA[getMimeType]]></code>
3282+
<code><![CDATA[getMimeType]]></code>
3283+
<code><![CDATA[getMimeType]]></code>
3284+
<code><![CDATA[getMimeType]]></code>
3285+
<code><![CDATA[getMimeType]]></code>
3286+
<code><![CDATA[getMimeType]]></code>
3287+
<code><![CDATA[getMimeType]]></code>
3288+
<code><![CDATA[getMimeType]]></code>
3289+
<code><![CDATA[getMimeType]]></code>
3290+
<code><![CDATA[getMimeType]]></code>
3291+
<code><![CDATA[getMimeType]]></code>
3292+
<code><![CDATA[getMimeType]]></code>
3293+
<code><![CDATA[getMimeType]]></code>
3294+
<code><![CDATA[setMimeType]]></code>
3295+
</DeprecatedMethod>
31913296
<PossiblyInvalidArgument>
31923297
<code><![CDATA[$isValidParam['tmp_name']]]></code>
31933298
</PossiblyInvalidArgument>
@@ -3235,6 +3340,44 @@
32353340
</PossiblyUnusedMethod>
32363341
</file>
32373342
<file src="test/File/MimeTypeTest.php">
3343+
<DeprecatedClass>
3344+
<code><![CDATA[InvalidMagicMimeFileException::class]]></code>
3345+
</DeprecatedClass>
3346+
<DeprecatedMethod>
3347+
<code><![CDATA[addMimeType]]></code>
3348+
<code><![CDATA[addMimeType]]></code>
3349+
<code><![CDATA[addMimeType]]></code>
3350+
<code><![CDATA[addMimeType]]></code>
3351+
<code><![CDATA[addMimeType]]></code>
3352+
<code><![CDATA[addMimeType]]></code>
3353+
<code><![CDATA[disableMagicFile]]></code>
3354+
<code><![CDATA[enableHeaderCheck]]></code>
3355+
<code><![CDATA[enableHeaderCheck]]></code>
3356+
<code><![CDATA[getHeaderCheck]]></code>
3357+
<code><![CDATA[getMagicFile]]></code>
3358+
<code><![CDATA[getMagicFile]]></code>
3359+
<code><![CDATA[getMagicFile]]></code>
3360+
<code><![CDATA[getMagicFile]]></code>
3361+
<code><![CDATA[getMimeType]]></code>
3362+
<code><![CDATA[getMimeType]]></code>
3363+
<code><![CDATA[getMimeType]]></code>
3364+
<code><![CDATA[getMimeType]]></code>
3365+
<code><![CDATA[getMimeType]]></code>
3366+
<code><![CDATA[getMimeType]]></code>
3367+
<code><![CDATA[getMimeType]]></code>
3368+
<code><![CDATA[getMimeType]]></code>
3369+
<code><![CDATA[getMimeType]]></code>
3370+
<code><![CDATA[getMimeType]]></code>
3371+
<code><![CDATA[getMimeType]]></code>
3372+
<code><![CDATA[getMimeType]]></code>
3373+
<code><![CDATA[getMimeType]]></code>
3374+
<code><![CDATA[getMimeType]]></code>
3375+
<code><![CDATA[getMimeType]]></code>
3376+
<code><![CDATA[isMagicFileDisabled]]></code>
3377+
<code><![CDATA[setMagicFile]]></code>
3378+
<code><![CDATA[setMagicFile]]></code>
3379+
<code><![CDATA[setMimeType]]></code>
3380+
</DeprecatedMethod>
32383381
<InvalidArgument>
32393382
<code><![CDATA[[]]]></code>
32403383
</InvalidArgument>

‎src/Exception/InvalidMagicMimeFileException.php‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,11 @@
22

33
namespace Laminas\Validator\Exception;
44

5-
/** @final */
5+
/**
6+
* @deprecated Since 2.61.0 - This exception will be removed in 3.0
7+
*
8+
* @final
9+
*/
610
class InvalidMagicMimeFileException extends InvalidArgumentException
711
{
812
}

‎src/File/MimeType.php‎

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -151,6 +151,8 @@ public function __construct($options = null)
151151
/**
152152
* Returns the actual set magicfile
153153
*
154+
* @deprecated Since 2.61.0 - All option getters and setters will be removed in 3.0
155+
*
154156
* @return string|false
155157
*/
156158
public function getMagicFile()
@@ -192,11 +194,13 @@ public function getMagicFile()
192194
* if the MAGIC file is erroneous, no file will be set
193195
* if false, the default MAGIC file from PHP will be used
194196
*
195-
* @param string $file
196-
* @throws Exception\RuntimeException When finfo can not read the magicfile.
197+
* @deprecated Since 2.61.0 - All option getters and setters will be removed in 3.0
198+
*
199+
* @param string $file
200+
* @return self Provides fluid interface
197201
* @throws Exception\InvalidArgumentException
198202
* @throws Exception\InvalidMagicMimeFileException
199-
* @return self Provides fluid interface
203+
* @throws Exception\RuntimeException When finfo can not read the magicfile.
200204
*/
201205
public function setMagicFile($file)
202206
{
@@ -232,6 +236,8 @@ public function setMagicFile($file)
232236
/**
233237
* Disables usage of MagicFile
234238
*
239+
* @deprecated Since 2.61.0 - All option getters and setters will be removed in 3.0
240+
*
235241
* @param bool $disable False disables usage of magic file; true enables it.
236242
* @return self Provides fluid interface
237243
*/
@@ -244,6 +250,8 @@ public function disableMagicFile($disable)
244250
/**
245251
* Is usage of MagicFile disabled?
246252
*
253+
* @deprecated Since 2.61.0 - All option getters and setters will be removed in 3.0
254+
*
247255
* @return bool
248256
*/
249257
public function isMagicFileDisabled()
@@ -254,6 +262,8 @@ public function isMagicFileDisabled()
254262
/**
255263
* Returns the Header Check option
256264
*
265+
* @deprecated Since 2.61.0 - All option getters and setters will be removed in 3.0
266+
*
257267
* @return bool
258268
*/
259269
public function getHeaderCheck()
@@ -265,7 +275,9 @@ public function getHeaderCheck()
265275
* Defines if the http header should be used
266276
* Note that this is unsafe and therefor the default value is false
267277
*
268-
* @param bool $headerCheck
278+
* @deprecated Since 2.61.0 - All option getters and setters will be removed in 3.0
279+
*
280+
* @param bool $headerCheck
269281
* @return self Provides fluid interface
270282
*/
271283
public function enableHeaderCheck($headerCheck = true)
@@ -277,7 +289,9 @@ public function enableHeaderCheck($headerCheck = true)
277289
/**
278290
* Returns the set mimetypes
279291
*
280-
* @param bool $asArray Returns the values as array, when false a concatenated string is returned
292+
* @deprecated Since 2.61.0 - All option getters and setters will be removed in 3.0
293+
*
294+
* @param bool $asArray Returns the values as array, when false a concatenated string is returned
281295
* @return string|list<string>
282296
* @psalm-return ($asArray is true ? list<string> : string)
283297
*/
@@ -295,7 +309,9 @@ public function getMimeType($asArray = false)
295309
/**
296310
* Sets the mimetypes
297311
*
298-
* @param string|list<string> $mimetype The mimetypes to validate
312+
* @deprecated Since 2.61.0 - All option getters and setters will be removed in 3.0
313+
*
314+
* @param string|list<string> $mimetype The mimetypes to validate
299315
* @return self Provides a fluent interface
300316
*/
301317
public function setMimeType($mimetype)
@@ -308,6 +324,8 @@ public function setMimeType($mimetype)
308324
/**
309325
* Adds the mimetypes
310326
*
327+
* @deprecated Since 2.61.0 - All option getters and setters will be removed in 3.0
328+
*
311329
* @param string|list<string> $mimetype The mimetypes to add for validation
312330
* @throws Exception\InvalidArgumentException
313331
* @return self Provides a fluent interface

0 commit comments

Comments
 (0)