8000 [VarDumper] Mark casters as internal · symfony/symfony@9d65675 · GitHub
[go: up one dir, main page]
Skip to content

Commit 9d65675

Browse files
alexandre-dauboisalexandre-daubois
committed
[VarDumper] Mark casters as internal
1 parent 3fda673 commit 9d65675

38 files changed

+501
-133
lines changed

‎UPGRADE-7.3.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
UPGRADE FROM 7.2 to 7.3
2+
=======================
3+
4+
Symfony 7.3 is a minor release. According to the Symfony release process, there should be no significant
5+
backward compatibility breaks. Minor backward compatibility breaks are prefixed in this document with
6+
`[BC BREAK]`, make sure your code is compatible with these entries before upgrading.
7+
Read more about this in the [Symfony documentation](https://symfony.com/doc/7.3/setup/upgrade_minor.html).
8+
9+
If you're upgrading from a version below 7.2, follow the [7.2 upgrade guide](UPGRADE-7.2.md) first.
10+
11+
Table of Contents
12+
-----------------
13+
14+
Components
15+
16+
* [VarDumper](#VarDumper)
17+
18+
VarDumper
19+
---------
20+
21+
* Deprecate `ResourceCaster::castCurl()`, `ResourceCaster::castGd()` and `ResourceCaster::castOpensslX509` without replacement
22+
* Mark all casters as `@internal`

‎src/Symfony/Component/VarDumper/CHANGELOG.md

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ CHANGELOG
55
---
66

77
* Add casters for `Dba\Connection`, `SQLite3Result`, `OpenSSLAsymmetricKey` and `OpenSSLCertificateSigningRequest`
8+
* Deprecate `ResourceCaster::castCurl()`, `ResourceCaster::castGd()` and `ResourceCaster::castOpensslX509` without replacement
9+
* Mark all casters as `@internal`
810

911
7.2
1012
---

‎src/Symfony/Component/VarDumper/Caster/AddressInfoCaster.php

+2
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@
1515

1616
/**
1717
* @author Nicolas Grekas <p@tchwork.com>
18+
*
19+
* @internal since Symfony 7.3
1820
*/
1921
final class AddressInfoCaster
2022
{

‎src/Symfony/Component/VarDumper/Caster/AmqpCaster.php

+2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
* @author Grégoire Pineau <lyrixx@lyrixx.info>
2020
*
2121
* @final
22+
*
23+
* @internal since Symfony 7.3
2224
*/
2325
class AmqpCaster
2426
{

‎src/Symfony/Component/VarDumper/Caster/Caster.php

+2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
* @author Nicolas Grekas <p@tchwork.com>
2020
*
2121
* @final
22+
*
23+
* @internal since Symfony 7.3
2224
*/
2325
class Caster
2426
{

‎src/Symfony/Component/VarDumper/Caster/CurlCaster.php

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\VarDumper\Caster;
13+
14+
use Symfony\Component\VarDumper\Cloner\Stub;
15+
16+
/**
17+
* @author Nicolas Grekas <p@tchwork.com>
18+
*
19+
* @internal
20+
*/
21+
final class CurlCaster
22+
{
23+
public static function castCurl(\CurlHandle $h, array $a, Stub $stub, bool $isNested): array
24+
{
25+
foreach (curl_getinfo($h) as $key => $val) {
26+
$a[Caster::PREFIX_VIRTUAL.$key] = $val;
27+
}
28+
29+
return $a;
30+
}
31+
}

‎src/Symfony/Component/VarDumper/Caster/DOMCaster.php

+2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
* @author Nicolas Grekas <p@tchwork.com>
2020
*
2121
* @final
22+
*
23+
* @internal since Symfony 7.3
2224
*/
2325
class DOMCaster
2426
{

‎src/Symfony/Component/VarDumper/Caster/DateCaster.php

+2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
* @author Dany Maillard <danymaillard93b@gmail.com>
2020
*
2121
* @final
22+
*
23+
* @internal since Symfony 7.3
2224
*/
2325
class DateCaster
2426
{

‎src/Symfony/Component/VarDumper/Caster/DoctrineCaster.php

+2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* @author Nicolas Grekas <p@tchwork.com>
2323
*
2424
* @final
25+
*
26+
* @internal since Symfony 7.3
2527
*/
2628
class DoctrineCaster
2729
{

‎src/Symfony/Component/VarDumper/Caster/ExceptionCaster.php

+2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
* @author Nicolas Grekas <p@tchwork.com>
2323
*
2424
* @final
25+
*
26+
* @internal since Symfony 7.3
2527
*/
2628
class ExceptionCaster
2729
{

‎src/Symfony/Component/VarDumper/Caster/GdCaster.php

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\VarDumper\Caster;
13+
14+
use Symfony\Component\VarDumper\Cloner\Stub;
15+
16+
/**
17+
* @author Nicolas Grekas <p@tchwork.com>
18+
*
19+
* @internal
20+
*/
21+
final class GdCaster
22+
{
23+
public static function castGd(\GdImage $gd, array $a, Stub $stub, bool $isNested): array
24+
{
25+
$a['size'] = imagesx($gd).'x'.imagesy($gd);
26+
$a['trueColor'] = imageistruecolor($gd);
27+
28+
return $a;
29+
}
30+
}

‎src/Symfony/Component/VarDumper/Caster/GmpCaster.php

+2
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
* @author Nicolas Grekas <p@tchwork.com>
2121
*
2222
* @final
23+
*
24+
* @internal since Symfony 7.3
2325
*/
2426
class GmpCaster
2527
{

‎src/Symfony/Component/VarDumper/Caster/ImagineCaster.php

+2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@
1616

1717
/**
1818
* @author Grégoire Pineau <lyrixx@lyrixx.info>
19+
*
20+
* @internal since Symfony 7.3
1921
*/
2022
final class ImagineCaster
2123
{

‎src/Symfony/Component/VarDumper/Caster/IntlCaster.php

+2
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
* @author Jan Schädlich <jan.schaedlich@sensiolabs.de>
1919
*
2020
* @final
21+
*
22+
* @internal since Symfony 7.3
2123
*/
2224
class IntlCaster
2325
{

‎src/Symfony/Component/VarDumper/Caster/MemcachedCaster.php

+2
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@
1717
* @author Jan Schädlich <jan.schaedlich@sensiolabs.de>
1818
*
1919
* @final
20+
*
21+
* @internal since Symfony 7.3
2022
*/
2123
class MemcachedCaster
2224
{

‎src/Symfony/Component/VarDumper/Caster/OpenSSLCaster.php

+69
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
<?php
2+
3+
/*
4+
* This file is part of the Symfony package.
5+
*
6+
* (c) Fabien Potencier <fabien@symfony.com>
7+
*
8+
* For the full copyright and license information, please view the LICENSE
9+
* file that was distributed with this source code.
10+
*/
11+
12+
namespace Symfony\Component\VarDumper\Caster;
13+
14+
use Symfony\Component\VarDumper\Cloner\Stub;
15+
16+
/**
17+
* @author Nicolas Grekas <p@tchwork.com>
18+
* @author Alexandre Daubois <alex.daubois@gmail.com>
19+
*
20+
* @internal
21+
*/
22+
final class OpenSSLCaster
23+
{
24+
public static function castOpensslX509(\OpenSSLCertificate $h, array $a, Stub $stub, bool $isNested): array
25+
{
26+
$stub->cut = -1;
27+
$info = openssl_x509_parse($h, false);
28+
29+
$pin = openssl_pkey_get_public($h);
30+
$pin = openssl_pkey_get_details($pin)['key'];
31+
$pin = \array_slice(explode("\n", $pin), 1, -2);
32+
$pin = base64_decode(implode('', $pin));
33+
$pin = base64_encode(hash('sha256', $pin, true));
34+
35+
$a += [
36+
'subject' => new EnumStub(array_intersect_key($info['subject'], ['organizationName' => true, 'commonName' => true])),
37+
'issuer' => new EnumStub(array_intersect_key($info['issuer'], ['organizationName' => true, 'commonName' => true])),
38+
'expiry' => new ConstStub(date(\DateTimeInterface::ISO8601, $info['validTo_time_t']), $info['validTo_time_t']),
39+
'fingerprint' => new EnumStub([
40+
'md5' => new ConstStub(wordwrap(strtoupper(openssl_x509_fingerprint($h, 'md5')), 2, ':', true)),
41+
'sha1' => new ConstStub(wordwrap(strtoupper(openssl_x509_fingerprint($h, 'sha1')), 2, ':', true)),
42+
'sha256' => new ConstStub(wordwrap(strtoupper(openssl_x509_fingerprint($h, 'sha256')), 2, ':', true)),
43+
'pin-sha256' => new ConstStub($pin),
44+
]),
45+
];
46+
47+
return $a;
48+
}
49+
50+
public static function castOpensslAsymmetricKey(\OpenSSLAsymmetricKey $key, array $a, Stub $stub, bool $isNested): array
51+
{
52+
foreach (openssl_pkey_get_details($key) as $k => $v) {
53+
$a[Caster::PREFIX_VIRTUAL.$k] = $v;
54+
}
55+
56+
unset($a[Caster::PREFIX_VIRTUAL.'rsa']); // binary data
57+
58+
return $a;
59+
}
60+
61+
public static function castOpensslCsr(\OpenSSLCertificateSigningRequest $csr, array $a, Stub $stub, bool $isNested): array
62+
{
63+
foreach (openssl_csr_get_subject($csr, false) as $k => $v) {
64+
$a[Caster::PREFIX_VIRTUAL.$k] = $v;
65+
}
66+
67+
return $a;
68+
}
69+
}

‎src/Symfony/Component/VarDumper/Caster/PdoCaster.php

+2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
* @author Nicolas Grekas <p@tchwork.com>
2020
*
2121
* @final
22+
*
23+
* @internal since Symfony 7.3
2224
*/
2325
class PdoCaster
2426
{

‎src/Symfony/Component/VarDumper/Caster/PgSqlCaster.php

+2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
* @author Nicolas Grekas <p@tchwork.com>
2020
*
2121
* @final
22+
*
23+
* @internal since Symfony 7.3
2224
*/
2325
class PgSqlCaster
2426
{

‎src/Symfony/Component/VarDumper/Caster/ProxyManagerCaster.php

+2
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
* @author Nicolas Grekas <p@tchwork.com>
1919
*
2020
* @final
21+
*
22+
* @internal since Symfony 7.3
2123
*/
2224
class ProxyManagerCaster
2325
{

‎src/Symfony/Component/VarDumper/Caster/RdKafkaCaster.php

+2
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@
2828
* Casts RdKafka related classes to array representation.
2929
*
3030
* @author Romain Neutron <imprec@gmail.com>
31+
*
32+
* @internal since Symfony 7.3
3133
*/
3234
class RdKafkaCaster
3335
{

‎src/Symfony/Component/VarDumper/Caster/RedisCaster.php

+2
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
* @author Nicolas Grekas <p@tchwork.com>
2121
*
2222
* @final
23+
*
24+
* @internal since Symfony 7.3
2325
*/
2426
class RedisCaster
2527
{

‎src/Symfony/Component/VarDumper/Caster/ReflectionCaster.php

+2
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@
1919
* @author Nicolas Grekas <p@tchwork.com>
2020
*
2121
* @final
22+
*
23+
* @internal since Symfony 7.3
2224
*/
2325
class ReflectionCaster
2426
{

0 commit comments

Comments
 (0)
0