This PR adds support for the optional chaining operator (?.) to Twig. #4623
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| <?php | ||
|
|
||
| namespace Twig\ExpressionParser\Infix; | ||
|
|
||
| use Twig\Error\SyntaxError; | ||
| use Twig\ExpressionParser\AbstractExpressionParser; | ||
| use Twig\ExpressionParser\ExpressionParserDescriptionInterface; | ||
| use Twig\ExpressionParser\InfixAssociativity; | ||
| use Twig\ExpressionParser\InfixExpressionParserInterface; | ||
| use Twig\Lexer; | ||
| use Twig\Node\Expression\AbstractExpression; | ||
| use Twig\Node\Expression\ArrayExpression; | ||
| use Twig\Node\Expression\ConstantExpression; | ||
| use Twig\Node\Expression\GetAttrExpression; | ||
| use Twig\Node\Expression\MacroReferenceExpression; | ||
| use Twig\Node\Expression\NameExpression; | ||
| use Twig\Node\Expression\Variable\TemplateVariable; | ||
| use Twig\Parser; | ||
| use Twig\Template; | ||
| use Twig\Token; | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
| final class OptionalChainExpressionParser extends AbstractExpressionParser implements InfixExpressionParserInterface, ExpressionParserDescriptionInterface | ||
| { | ||
| use ArgumentsTrait; | ||
|
|
||
|
|
||
| public function parse(Parser $parser, AbstractExpression $expr, Token $token): AbstractExpression | ||
| { | ||
| $stream = $parser->getStream(); | ||
| $token = $stream->getCurrent(); | ||
| $lineno = $token->getLine(); | ||
| $arguments = new ArrayExpression([], $lineno); | ||
| $type = Template::ANY_CALL; | ||
| $isOptionalChain = true; | ||
| $isVariable = $expr instanceof NameExpression; | ||
| if ($stream->test(Token::OPERATOR_TYPE, '[')) { | ||
| $token = $stream->next(); | ||
| $attribute = $parser->parseExpression(); | ||
| $stream->expect(Token::PUNCTUATION_TYPE, ']'); | ||
| $type = Template::ARRAY_CALL; | ||
| } elseif ($stream->nextIf(Token::OPERATOR_TYPE, '(')) { | ||
| $attribute = $parser->parseExpression(); | ||
| $stream->expect(Token::PUNCTUATION_TYPE, ')'); | ||
| } else { | ||
| $token = $stream->next(); | ||
| if ( | ||
| $token->test(Token::NAME_TYPE) | ||
| || $token->test(Token::NUMBER_TYPE) | ||
| || ($token->test(Token::OPERATOR_TYPE) && preg_match(Lexer::REGEX_NAME, $token->getValue())) | ||
| ) { | ||
| $attribute = new ConstantExpression($token->getValue(), $token->getLine()); | ||
| } else { | ||
| throw new SyntaxError(\sprintf('Expected name or number, got value "%s" of type %s.', $token->getValue(), $token->toEnglish()), $token->getLine(), $stream->getSourceContext()); | ||
| } | ||
| } | ||
|
|
||
| if ($stream->test(Token::OPERATOR_TYPE, '(')) { | ||
| $type = Template::METHOD_CALL; | ||
| $arguments = $this->parseCallableArguments($parser, $token->getLine()); | ||
| } | ||
|
|
||
| if ( | ||
| $expr instanceof NameExpression | ||
| && ( | ||
| null !== $parser->getImportedSymbol('template', $expr->getAttribute('name')) | ||
| || '_self' === $expr->getAttribute('name') && $attribute instanceof ConstantExpression | ||
| ) | ||
| ) { | ||
|
|
||
| return new MacroReferenceExpression(new TemplateVariable($expr->getAttribute('name'), $expr->getTemplateLine()), 'macro_'.$attribute->getAttribute('value'), $arguments, $expr->getTemplateLine()); | ||
| } | ||
|
|
||
|
|
||
| if ($isVariable && $expr instanceof NameExpression) { | ||
| $expr->setAttribute('optional_chain', true); | ||
| } | ||
|
|
||
| return new GetAttrExpression($expr, $attribute, $arguments, $type, $lineno, $isOptionalChain); | ||
| } | ||
|
|
||
| public function getName(): string | ||
| { | ||
| return '?.'; | ||
| } | ||
|
|
||
| public function getDescription(): string | ||
| { | ||
| return 'Optional chaining to safely access an attribute on a potentially null variable'; | ||
| } | ||
|
|
||
| public function getPrecedence(): int | ||
| { | ||
| return 512; | ||
| } | ||
|
|
||
| public function getAssociativity(): InfixAssociativity | ||
| { | ||
| return InfixAssociativity::Left; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| <?php | ||
| // tests/Extension/OptionalChainingTest.php | ||
|
|
||
| namespace Twig\Tests\Extension; | ||
|
|
||
| use Twig\Test\IntegrationTestCase; | ||
|
|
||
| class OptionalChainingTest extends IntegrationTestCase | ||
|
Member
There was a problem hiding this comment. There is no |
||
| { | ||
| public function getFixturesDir(): string | ||
| { | ||
| return __DIR__.'/../Fixtures/extensions/optional_chaining'; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --TEST-- | ||
| Optional chaining with array access | ||
| --TEMPLATE-- | ||
| {{ foo?.bar }} | ||
| {{ foo?.[0] }} | ||
| --DATA-- | ||
| return [ | ||
| 'foo' => ['bar' => 'value', 0 => 'zero'] | ||
| ] | ||
| --EXPECT-- | ||
| value | ||
| zero |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --TEST-- | ||
| Basic optional chaining | ||
| --TEMPLATE-- | ||
| {{ foo?.bar }} | ||
| {{ foo?.bar?.baz }} | ||
| --DATA-- | ||
| return ['foo' => null] | ||
| --EXPECT-- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| --TEST-- | ||
| Optional chaining with method calls | ||
| --TEMPLATE-- | ||
| {{ foo?.getBar() }} | ||
| {{ foo_with_nested?.bar?.getBaz() }} | ||
| --DATA-- | ||
| class TestObject { | ||
| public function getBar() { return 'bar_value'; } | ||
| } | ||
| class NestedObject { | ||
| public function getBaz() { return 'baz_value'; } | ||
| } | ||
| return [ | ||
| 'foo' => new TestObject(), | ||
| 'null_foo' => null, | ||
| 'foo_with_nested' => ['bar' => new NestedObject()] | ||
| ] | ||
| --EXPECT-- | ||
| bar_value | ||
| baz_value |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| --TEST-- | ||
| Mixed optional and normal chaining | ||
| --TEMPLATE-- | ||
| {{ foo?.bar.baz }} | ||
| {{ foo.bar?.baz }} | ||
| --DATA-- | ||
| return [ | ||
| 'foo' => ['bar' => ['baz' => 'value']], | ||
| ] | ||
| --EXPECT-- | ||
| value | ||
| value |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --TEST-- | ||
| Optional chaining with undefined variables | ||
| --TEMPLATE-- | ||
| {{ undefinedVar?.bar }} | ||
| --DATA-- | ||
| return [] | ||
| --EXPECT-- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| --TEST-- | ||
| Optional chaining with values | ||
| --TEMPLATE-- | ||
| {{ foo?.bar }} | ||
| {{ foo?.bar?.baz }} | ||
| --DATA-- | ||
| return ['foo' => ['bar' => 'value', 'baz' => ['qux' => 'nested']]] | ||
| --EXPECT-- | ||
| value |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this seems to ignore the fact that this is an optional chain. Is it expected ?