Skip to content

Commit 0ae6a67

Browse files
GirgiasGirgias
authored
Add true as a type (#8326)
RFC: https://wiki.php.net/rfc/true-type
1 parent ddc0b49 commit 0ae6a67

19 files changed

+273
-14
lines changed

‎Zend/tests/type_declarations/intersection_types/invalid_types/invalid_true_type.phpt

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
--TEST--
2+
true type cannot take part in an intersection type
3+
--FILE--
4+
<?php
5+
6+
function foo(): true&Iterator {}
7+
8+
?>
9+
--EXPECTF--
10+
Fatal error: Type true cannot be part of an intersection type in %s on line %d

‎Zend/tests/type_declarations/literal_types/false_no_coercion.phpt

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
--TEST--
2+
No coercion should be applied to type false
3+
--FILE--
4+
<?php
5+
6+
function test(false $v) { var_dump($v); }
7+
8+
try {
9+
test(0);
10+
} catch (\TypeError $e) {
11+
echo $e->getMessage(), \PHP_EOL;
12+
}
13+
try {
14+
test('');
15+
} catch (\TypeError $e) {
16+
echo $e->getMessage(), \PHP_EOL;
17+
}
18+
try {
19+
test([]);
20+
} catch (\TypeError $e) {
21+
echo $e->getMessage(), \PHP_EOL;
22+
}
23+
24+
?>
25+
--EXPECTF--
26+
test(): Argument #1 ($v) must be of type false, int given, called in %s on line %d
27+
test(): Argument #1 ($v) must be of type false, string given, called in %s on line %d
28+
test(): Argument #1 ($v) must be of type false, array given, called in %s on line %d

‎Zend/tests/type_declarations/literal_types/false_no_coercion_on_overload.phpt

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
--TEST--
2+
No coercion should be applied to type false even if it's an overide
3+
--FILE--
4+
<?php
5+
6+
class P {
7+
public function foo($v): array|bool {
8+
return $v;
9+
}
10+
}
11+
12+
class C {
13+
public function foo($v): array|false {
14+
return $v;
15+
}
16+
}
17+
18+
$p = new P();
19+
$c = new C();
20+
21+
var_dump($p->foo(0));
22+
try {
23+
var_dump($c->foo(0));
24+
} catch (\TypeError $e) {
25+
echo $e->getMessage(), \PHP_EOL;
26+
}
27+
28+
?>
29+
--EXPECT--
30+
bool(false)
31+
C::foo(): Return value must be of type array|false, int returned

‎Zend/tests/type_declarations/literal_types/false_standalone.phpt

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
--TEST--
2+
False can be used as a standalone type
3+
--FILE--
4+
<?php
5+
6+
function test(false $v): false {
7+
return $v;
8+
}
9+
10+
var_dump(test(false));
11+
12+
?>
13+
--EXPECT--
14+
bool(false)

‎Zend/tests/type_declarations/union_types/standalone_false_implicit_nullability.phpt renamed to ‎Zend/tests/type_declarations/literal_types/false_standalone_implicit_nullability.phpt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,11 @@ False can be used as a standalone type even with implicit nullability
33
--FILE--
44
<?php
55

6-
function test(false $v = null) {}
6+
function test(false $v = null) { return $v; }
77

8+
var_dump(test(false));
9+
var_dump(test(null));
810
?>
9-
===DONE===
1011
--EXPECT--
11-
===DONE===
12+
bool(false)
13+
NULL

‎Zend/tests/type_declarations/literal_types/true_no_coercion.phpt

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
--TEST--
2+
No coercion should be applied to type true
3+
--FILE--
4+
<?php
5+
6+
function test(true $v) { var_dump($v); }
7+
8+
try {
9+
test(1);
10+
} catch (\TypeError $e) {
11+
echo $e->getMessage(), \PHP_EOL;
12+
}
13+
try {
14+
test('1');
15+
} catch (\TypeError $e) {
16+
echo $e->getMessage(), \PHP_EOL;
17+
}
18+
try {
19+
test([1]);
20+
} catch (\TypeError $e) {
21+
echo $e->getMessage(), \PHP_EOL;
22+
}
23+
try {
24+
test(new stdClass());
25+
} catch (\TypeError $e) {
26+
echo $e->getMessage(), \PHP_EOL;
27+
}
28+
29+
?>
30+
--EXPECTF--
31+
test(): Argument #1 ($v) must be of type true, int given, called in %s on line %d
32+
test(): Argument #1 ($v) must be of type true, string given, called in %s on line %d
33+
test(): Argument #1 ($v) must be of type true, array given, called in %s on line %d
34+
test(): Argument #1 ($v) must be of type true, stdClass given, called in %s on line %d

‎Zend/tests/type_declarations/literal_types/true_no_coercion_on_overload.phpt

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
--TEST--
2+
No coercion should be applied to type true even if it's an overide
3+
--FILE--
4+
<?php
5+
6+
class P {
7+
public function foo($v): array|bool {
8+
return $v;
9+
}
10+
}
11+
12+
class C {
13+
public function foo($v): array|true {
14+
return $v;
15+
}
16+
}
17+
18+
$p = new P();
19+
$c = new C();
20+
21+
var_dump($p->foo(1));
22+
try {
23+
var_dump($c->foo(1));
24+
} catch (\TypeError $e) {
25+
echo $e->getMessage(), \PHP_EOL;
26+
}
27+
28+
?>
29+
--EXPECT--
30+
bool(true)
31+
C::foo(): Return value must be of type array|true, int returned

‎Zend/tests/type_declarations/literal_types/true_standalone.phpt

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
--TEST--
2+
true can be used as a standalone type
3+
--FILE--
4+
<?php
5+
6+
function test(true $v): true {
7+
return $v;
8+
}
9+
10+
var_dump(test(true));
11+
12+
?>
13+
--EXPECT--
14+
bool(true)

‎Zend/tests/type_declarations/literal_types/true_standalone_implicit_nullability.phpt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
--TEST--
2+
true can be used as a standalone type even with implicit nullability
3+
--FILE--
4+
<?php
5+
6+
function test(true $v = null) { return $v; }
7+
8+
var_dump(test(true));
9+
var_dump(test(null));
10+
?>
11+
--EXPECT--
12+
bool(true)
13+
NULL

‎Zend/tests/type_declarations/typed_properties_112.phpt

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
--TEST--
2+
Test typed properties allow true
3+
--FILE--
4+
<?php
5+
class Foo {
6+
public true $value;
7+
}
8+
9+
$foo = new Foo();
10+
11+
try {
12+
$foo->value = false;
13+
} catch (\TypeError $e) {
14+
echo $e->getMessage();
15+
}
16+
17+
?>
18+
--EXPECT--
19+
Cannot assign bool to property Foo::$value of type true

‎Zend/tests/type_declarations/union_types/redundant_types/bool_and_true.phpt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
--TEST--
2+
Using both bool and true in a union
3+
--FILE--
4+
<?php
5+
6+
function test(): bool|true {
7+
}
8+
9+
?>
10+
--EXPECTF--
11+
Fatal error: Duplicate type true is redundant in %s on line %d

‎Zend/tests/type_declarations/union_types/redundant_types/bool_instead_false_and_true.phpt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
--TEST--
2+
Using both false and true in a union instead of bool
3+
--FILE--
4+
<?php
5+
6+
function test(): false|true {
7+
}
8+
9+
?>
10+
--EXPECTF--
11+
Fatal error: Type contains both true and false, bool should be used instead in %s on line %d

‎Zend/tests/type_declarations/union_types/redundant_types/bool_instead_true_and_false.phpt

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
--TEST--
2+
Using both true and false in a union instead of bool
3+
--FILE--
4+
<?php
5+
6+
function test(): true|false {
7+
}
8+
9+
?>
10+
--EXPECTF--
11+
Fatal error: Type contains both true and false, bool should be used instead in %s on line %d

‎Zend/tests/type_declarations/union_types/standalone_false.phpt

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎Zend/zend_compile.c

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -216,6 +216,7 @@ typedef struct _builtin_type_info {
216216

217217
static const builtin_type_info builtin_types[] = {
218218
{ZEND_STRL("null"), IS_NULL},
219+
{ZEND_STRL("true"), IS_TRUE},
219220
{ZEND_STRL("false"), IS_FALSE},
220221
{ZEND_STRL("int"), IS_LONG},
221222
{ZEND_STRL("float"), IS_DOUBLE},
@@ -1246,6 +1247,8 @@ zend_string *zend_type_to_string_resolved(zend_type type, zend_class_entry *scop
12461247
str = add_type_string(str, ZSTR_KNOWN(ZEND_STR_BOOL), /* is_intersection */ false);
12471248
} else if (type_mask & MAY_BE_FALSE) {
12481249
str = add_type_string(str, ZSTR_KNOWN(ZEND_STR_FALSE), /* is_intersection */ false);
1250+
} else if (type_mask & MAY_BE_TRUE) {
1251+
str = add_type_string(str, ZSTR_KNOWN(ZEND_STR_TRUE), /* is_intersection */ false);
12491252
}
12501253
if (type_mask & MAY_BE_VOID) {
12511254
str = add_type_string(str, ZSTR_KNOWN(ZEND_STR_VOID), /* is_intersection */ false);
@@ -6229,6 +6232,11 @@ static zend_type zend_compile_typename(
62296232
zend_error_noreturn(E_COMPILE_ERROR,
62306233
"Duplicate type %s is redundant", ZSTR_VAL(overlap_type_str));
62316234
}
6235+
if ( ((ZEND_TYPE_PURE_MASK(type) & MAY_BE_TRUE) && (single_type_mask == MAY_BE_FALSE))
6236+
|| ((ZEND_TYPE_PURE_MASK(type) & MAY_BE_FALSE) && (single_type_mask == MAY_BE_TRUE)) ) {
6237+
zend_error_noreturn(E_COMPILE_ERROR,
6238+
"Type contains both true and false, bool should be used instead");
6239+
}
62326240
ZEND_TYPE_FULL_MASK(type) |= ZEND_TYPE_PURE_MASK(single_type);
62336241
ZEND_TYPE_FULL_MASK(single_type) &= ~_ZEND_TYPE_MAY_BE_MASK;
62346242

‎Zend/zend_string.h

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -578,6 +578,7 @@ EMPTY_SWITCH_DEFAULT_CASE()
578578
_(ZEND_STR_VOID, "void") \
579579
_(ZEND_STR_NEVER, "never") \
580580
_(ZEND_STR_FALSE, "false") \
581+
_(ZEND_STR_TRUE, "true") \
581582
_(ZEND_STR_NULL_LOWERCASE, "null") \
582583
_(ZEND_STR_MIXED, "mixed") \
583584
_(ZEND_STR_TRAVERSABLE, "Traversable") \

‎ext/reflection/php_reflection.c

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3151,6 +3151,8 @@ ZEND_METHOD(ReflectionUnionType, getTypes)
31513151
}
31523152
if ((type_mask & MAY_BE_BOOL) == MAY_BE_BOOL) {
31533153
append_type_mask(return_value, MAY_BE_BOOL);
3154+
} else if (type_mask & MAY_BE_TRUE) {
3155+
append_type_mask(return_value, MAY_BE_TRUE);
31543156
} else if (type_mask & MAY_BE_FALSE) {
31553157
append_type_mask(return_value, MAY_BE_FALSE);
31563158
}

‎ext/reflection/tests/ReflectionType_possible_types.phpt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ $functions = [
1313
function(): callable {},
1414
function(): null {},
1515
function(): false {},
16+
function(): true {},
1617
function(): StdClass {}
1718
];
1819

@@ -32,4 +33,5 @@ string(5) "array"
3233
string(8) "callable"
3334
string(4) "null"
3435
string(5) "false"
36+
string(4) "true"
3537
string(8) "StdClass"

‎ext/reflection/tests/union_types.phpt

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,9 @@ function test1(): X|Y|int|float|false|null { }
2424
function test2(): X|iterable|bool { }
2525
function test3(): null|false { }
2626
function test4(): ?false { }
27+
function test5(): X|iterable|true { }
28+
function test6(): null|true { }
29+
function test7(): ?true { }
2730

2831
class Test {
2932
public X|Y|int $prop;
@@ -33,6 +36,9 @@ dumpType((new ReflectionFunction('test1'))->getReturnType());
3336
dumpType((new ReflectionFunction('test2'))->getReturnType());
3437
dumpBCType((new ReflectionFunction('test3'))->getReturnType());
3538
dumpBCType((new ReflectionFunction('test4'))->getReturnType());
39+
dumpType((new ReflectionFunction('test5'))->getReturnType());
40+
dumpBCType((new ReflectionFunction('test6'))->getReturnType());
41+
dumpBCType((new ReflectionFunction('test7'))->getReturnType());
3642

3743
$rc = new ReflectionClass(Test::class);
3844
$rp = $rc->getProperty('prop');
@@ -97,6 +103,28 @@ Type ?false:
97103
Name: false
98104
String: ?false
99105
Allows Null: true
106+
Type X|Traversable|array|true:
107+
Allows null: false
108+
Name: X
109+
String: X
110+
Allows Null: false
111+
Name: Traversable
112+
String: Traversable
113+
Allows Null: false
114+
Name: array
115+
String: array
116+
Allows Null: false
117+
Name: true
118+
String: true
119+
Allows Null: false
120+
Type ?true:
121+
Name: true
122+
String: ?true
123+
Allows Null: true
124+
Type ?true:
125+
Name: true
126+
String: ?true
127+
Allows Null: true
100128
Type X|Y|int:
101129
Allows null: false
102130
Name: X

0 commit comments

Comments
 (0)