[TypeInfo] Add ArrayShapeType examples to type_info.rst #20998
Conversation
|
Friendly ping @mtarld |
| * Nested array shapes | ||
| * Union types for values |
There was a problem hiding this comment.
I don't think it worth mentioning these, as array shape basically supports any type as values.
| * Required and optional keys | ||
| * Nested array shapes | ||
| * Union types for values | ||
| * Exact key ordering validation |
There was a problem hiding this comment.
This type does not perform any key ordering validation.
|
|
||
| The ``ArrayShapeType`` method was introduced in Symfony 7.3. | ||
|
|
||
| Array shape types support: |
There was a problem hiding this comment.
You can also add a word about the "sealed" concept.
Indeed, array{0: int} is sealed whereas array{0: int, ...} is not. This means that the second type accepts extra values and the first does not. It is also worth mentioning that you can define the type of extra keys/values: array{0: int, ...<string, bool>}.
This data is held by extraKeyType and extraValueType in the ArrayShapeType and is validated in the accept method.
| // With optional keys (denoted by "?" suffix) | ||
| $type = Type::arrayShape([ | ||
| 'required_id' => Type::int(), | ||
| 'optional_name?' => Type::string() | ||
| ]); |
There was a problem hiding this comment.
This does not work like that. If you want to create optional keys, you must do:
$type = Type::arrayShape([
'required_id' => Type::int(),
'optional_name' => ['type' => Type::string(), 'optional' => true],
]);| // With optional keys (denoted by "?" suffix) | ||
| $type = Type::arrayShape([ | ||
| 'required_id' => Type::int(), | ||
| 'optional_name?' => Type::string() | ||
| ]); |
There was a problem hiding this comment.
You can also add examples for $sealed, $extraKeyType, and $extraValueType of:
public static function arrayShape(array $shape, bool $sealed = true, ?Type $extraKeyType = null, ?Type $extraValueType = null): ArrayShapeType| * Union types for values | ||
| * Exact key ordering validation | ||
|
|
||
| The ArrayShapeType support Associative Array definition:: |
There was a problem hiding this comment.
| The ArrayShapeType support Associative Array definition:: | |
| The ArrayShapeType supports associative array definition: |
| $type->is(typeof(['name' => 'Alice', 'age' => 30, ])); // true | ||
| $type->is(typeof(['name' => 'Alice', 'age' => '30', ])); // false (wrong age type) |
There was a problem hiding this comment.
This code does not work as well. The valid one is:
$type->accepts(['name' => 'Alice', 'age' => 30]); // true
$type->accepts(['name' => 'Alice', 'age' => '30']); // false (invalid age type)Plus, I don't think it should be under the StringTypeResolver section.
|
thanks @mtarld for the feedback, I will adjust the PR with following your comment 🙌🏼 |
Fixes #20763
Update the Symfony TypeInfo component documentation to reflect the new ArrayShapeType and StringTypeResolver capabilities .