Skip to content

Commit 4a2cffe

Browse files
IanDelMarIanDelMar
authored
Add return type extension for wp_slash() (#296)
* Add return type extension for wp_slash() * Fix import
1 parent 703f4bc commit 4a2cffe

File tree

6 files changed

+159
-1
lines changed

6 files changed

+159
-1
lines changed

‎extension.neon‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ services:
2121
class: SzepeViktor\PHPStan\WordPress\WpParseUrlFunctionDynamicReturnTypeExtension
2222
tags:
2323
- phpstan.broker.dynamicFunctionReturnTypeExtension
24+
-
25+
class: SzepeViktor\PHPStan\WordPress\WpSlashDynamicFunctionReturnTypeExtension
26+
tags:
27+
- phpstan.broker.dynamicFunctionReturnTypeExtension
2428
-
2529
class: SzepeViktor\PHPStan\WordPress\HookDocsVisitor
2630
tags:

‎phpcs.xml.dist‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@
2626
<!-- TypeTraverser uses callable $traverse -->
2727
<rule ref="NeutronStandard.Functions.VariableFunctions.VariableFunction">
2828
<exclude-pattern>src/StripslashesFromStringsOnlyDynamicFunctionReturnTypeExtension.php</exclude-pattern>
29+
<exclude-pattern>src/WpSlashDynamicFunctionReturnTypeExtension.php</exclude-pattern>
2930
</rule>
3031

3132
<!-- Allow string concatenation in tests -->

‎src/StripslashesFromStringsOnlyDynamicFunctionReturnTypeExtension.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
namespace SzepeViktor\PHPStan\WordPress;
66

77
use PhpParser\Node\Expr\FuncCall;
8-
use PhpParser\Node\UnionType;
98
use PHPStan\Analyser\Scope;
109
use PHPStan\Reflection\FunctionReflection;
1110
use PHPStan\Type\Constant\ConstantStringType;
1211
use PHPStan\Type\Type;
1312
use PHPStan\Type\TypeTraverser;
13+
use PHPStan\Type\UnionType;
1414

1515
class StripslashesFromStringsOnlyDynamicFunctionReturnTypeExtension implements \PHPStan\Type\DynamicFunctionReturnTypeExtension
1616
{

‎src/WpSlashDynamicFunctionReturnTypeExtension.php‎

Lines changed: 99 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,99 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace SzepeViktor\PHPStan\WordPress;
6+
7+
use PhpParser\Node\Expr\FuncCall;
8+
use PHPStan\Analyser\Scope;
9+
use PHPStan\Reflection\FunctionReflection;
10+
use PHPStan\Type\ArrayType;
11+
use PHPStan\Type\Constant\ConstantArrayType;
12+
use PHPStan\Type\Constant\ConstantArrayTypeBuilder;
13+
use PHPStan\Type\Constant\ConstantStringType;
14+
use PHPStan\Type\IntersectionType;
15+
use PHPStan\Type\MixedType;
16+
use PHPStan\Type\StringType;
17+
use PHPStan\Type\Type;
18+
use PHPStan\Type\TypeTraverser;
19+
use PHPStan\Type\UnionType;
20+
21+
class WpSlashDynamicFunctionReturnTypeExtension implements \PHPStan\Type\DynamicFunctionReturnTypeExtension
22+
{
23+
public function isFunctionSupported(FunctionReflection $functionReflection): bool
24+
{
25+
return in_array(
26+
$functionReflection->getName(),
27+
[
28+
'addslashes_gpc',
29+
'wp_slash',
30+
],
31+
true
32+
);
33+
}
34+
35+
/**
36+
* @see https://developer.wordpress.org/reference/functions/addslashes_gpc/
37+
* @see https://developer.wordpress.org/reference/functions/wp_slash/
38+
*/
39+
public function getTypeFromFunctionCall(FunctionReflection $functionReflection, FuncCall $functionCall, Scope $scope): ?Type
40+
{
41+
if (count($functionCall->getArgs()) === 0) {
42+
return null;
43+
}
44+
45+
$argType = $scope->getType($functionCall->getArgs()[0]->value);
46+
47+
$accepted = new UnionType(
48+
[
49+
new StringType(),
50+
new ArrayType(new MixedType(), new MixedType()),
51+
]
52+
);
53+
54+
if (! $accepted->isSuperTypeOf($argType)->yes()) {
55+
return null;
56+
}
57+
58+
return $this->addSlashes($argType);
59+
}
60+
61+
private function addSlashes(Type $type): Type
62+
{
63+
return TypeTraverser::map(
64+
$type,
65+
function (Type $type, callable $traverse): Type {
66+
if ($type instanceof UnionType || $type instanceof IntersectionType) {
67+
return $traverse($type);
68+
}
69+
70+
if ($type instanceof ConstantStringType) {
71+
return new ConstantStringType(addslashes($type->getValue()));
72+
}
73+
74+
if (! $type->isArray()->yes()) {
75+
return $type;
76+
}
77+
78+
if (! ($type instanceof ConstantArrayType)) {
79+
return new ArrayType(
80+
$type->getIterableKeyType(),
81+
$this->addSlashes($type->getIterableValueType())
82+
);
83+
}
84+
85+
$builder = ConstantArrayTypeBuilder::createEmpty();
86+
87+
foreach ($type->getKeyTypes() as $index => $keyType) {
88+
$builder->setOffsetValueType(
89+
$keyType,
90+
$this->addSlashes($type->getValueTypes()[$index]),
91+
$type->isOptionalKey($index)
92+
);
93+
}
94+
95+
return $builder->getArray();
96+
}
97+
);
98+
}
99+
}

‎tests/DynamicReturnTypeExtensionTest.php‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ public function dataFileAsserts(): iterable
1818
yield from self::gatherAssertTypes(__DIR__ . '/data/shortcode_atts.php');
1919
yield from self::gatherAssertTypes(__DIR__ . '/data/stripslashes-from-strings-only.php');
2020
yield from self::gatherAssertTypes(__DIR__ . '/data/wp_parse_url.php');
21+
yield from self::gatherAssertTypes(__DIR__ . '/data/wp-slash.php');
2122
}
2223

2324
/**

‎tests/data/wp-slash.php‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace SzepeViktor\PHPStan\WordPress\Tests;
6+
7+
use function wp_slash;
8+
use function PHPStan\Testing\assertType;
9+
10+
assertType("''", wp_slash(''));
11+
assertType("'foo'", wp_slash('foo'));
12+
assertType("'foo\\\\\'s bar'", wp_slash("foo's bar"));
13+
14+
/** @var string $value */
15+
assertType('string', wp_slash($value));
16+
17+
/** @var lowercase-string $value */
18+
assertType('lowercase-string', wp_slash($value));
19+
20+
assertType("'baz'|'foo\\\\\'s bar'", wp_slash(rand(0, 1) === 1 ? 'baz' : "foo's bar"));
21+
22+
assertType("array{who: 'baz', where: 'foo\\\\\'s bar'}", wp_slash(['who' => 'baz', 'where' => "foo's bar"]));
23+
24+
/** @var array{who: 'baz', when: non-falsy-string, where: "foo's bar"} $value */
25+
assertType("array{who: 'baz', when: non-falsy-string, where: 'foo\\\\\'s bar'}", wp_slash($value));
26+
27+
assertType("array{outer: array{inner: 'foo\\\\\'s bar'}}", wp_slash(['outer' => ['inner' => "foo's bar"]]));
28+
29+
$value = rand(0, 1) === 1
30+
? ['outer' => ['inner' => "foo's bar"]]
31+
: ['outer' => ['inner' => 'baz']];
32+
assertType("array{outer: array{inner: 'baz'}}|array{outer: array{inner: 'foo\\\\\'s bar'}}", wp_slash($value));
33+
34+
/** @var array<array{inner: "foo's bar"}> $value */
35+
assertType("array<array{inner: 'foo\\\\\'s bar'}>", wp_slash($value));
36+
37+
// Nested array with multiple items at each depth
38+
assertType(
39+
"array{level1_a: array{level2_a: 'foo\\\\\'s bar', level2_b: 'level2_b'}, level1_b: array{level2_c: array{level3_a: 'deeper foo\\\\\'s bar', level3_b: 'level3_b'}, level2_d: 'level2_d'}}",
40+
wp_slash([
41+
'level1_a' => [
42+
'level2_a' => "foo's bar",
43+
'level2_b' => 'level2_b'
44+
],
45+
'level1_b' => [
46+
'level2_c' => [
47+
'level3_a' => "deeper foo's bar",
48+
'level3_b' => 'level3_b'
49+
],
50+
'level2_d' => 'level2_d'
51+
]
52+
])
53+
);

0 commit comments

Comments
 (0)