From 79aae839f088ebb67a1d2699a6680291c6255c82 Mon Sep 17 00:00:00 2001 From: Daniel Oliveira Date: Mon, 16 Nov 2026 16:11:29 +0100 Subject: [PATCH] Brace a variable name before a dimension in the formatter PHP 5 reads $$a['b'] as ${$a['b']} and $a->$b['c'] as $a->{$b['c']}, where PHP 7 reads ${$a}['b'] and $a->{$b}['c']. The formatter dropped the braces of both, so its output read another variable on PHP 5. --- pkg/visitor/formatter/formatter.go | 24 +++++++++ pkg/visitor/formatter/formatter_test.go | 65 +++++++++++++++++++++++++ 2 files changed, 89 insertions(+) diff --git a/pkg/visitor/formatter/formatter.go b/pkg/visitor/formatter/formatter.go index c82a741..826168d 100644 --- a/pkg/visitor/formatter/formatter.go +++ b/pkg/visitor/formatter/formatter.go @@ -1145,11 +1145,35 @@ func (formatter *formatter) ExprArray(node *ast.ExprArray) { func (formatter *formatter) ExprArrayDimFetch(node *ast.ExprArrayDimFetch) { node.Var.Accept(formatter) + formatter.braceDimensionBase(node.Var) node.OpenBracketTkn = formatter.newToken('[', []byte("[")) node.Dim.Accept(formatter) node.CloseBracketTkn = formatter.newToken(']', []byte("]")) } +// braceDimensionBase braces a variable name a dimension follows: PHP 5 +// reads $$a['b'] as ${$a['b']} and $a->$b['c'] as $a->{$b['c']}, where +// PHP 7 reads ${$a}['b'] and $a->{$b}['c']. +func (formatter *formatter) braceDimensionBase(base ast.Vertex) { + switch n := base.(type) { + case *ast.ExprVariable: + if _, ok := n.Name.(*ast.ExprVariable); ok { + n.OpenCurlyBracketTkn = formatter.newToken('{', []byte("{")) + n.CloseCurlyBracketTkn = formatter.newToken('}', []byte("}")) + } + case *ast.ExprPropertyFetch: + if _, ok := n.Prop.(*ast.ExprVariable); ok { + n.OpenCurlyBracketTkn = formatter.newToken('{', []byte("{")) + n.CloseCurlyBracketTkn = formatter.newToken('}', []byte("}")) + } + case *ast.ExprNullsafePropertyFetch: + if _, ok := n.Prop.(*ast.ExprVariable); ok { + n.OpenCurlyBracketTkn = formatter.newToken('{', []byte("{")) + n.CloseCurlyBracketTkn = formatter.newToken('}', []byte("}")) + } + } +} + func (formatter *formatter) ExprArrayItem(node *ast.ExprArrayItem) { if node.EllipsisTkn != nil { node.EllipsisTkn = formatter.newToken(token.T_ELLIPSIS, []byte("...")) diff --git a/pkg/visitor/formatter/formatter_test.go b/pkg/visitor/formatter/formatter_test.go index 6e501bb..043b082 100644 --- a/pkg/visitor/formatter/formatter_test.go +++ b/pkg/visitor/formatter/formatter_test.go @@ -4820,6 +4820,71 @@ func TestFormatter_ExprVariable_Variable(test *testing.T) { } } +func TestFormatter_ExprArrayDimFetch_VariableVariable(test *testing.T) { + buffer := bytes.NewBufferString("") + + node := &ast.ExprArrayDimFetch{ + Var: &ast.ExprVariable{ + Name: &ast.ExprVariable{ + Name: &ast.Identifier{ + Value: []byte("$foo"), + }, + }, + }, + Dim: &ast.ScalarString{ + Value: []byte("'bar'"), + }, + } + + formatterValue := formatter.NewFormatter().WithState(formatter.FormatterStatePHP).WithIndent(1) + node.Accept(formatterValue) + + printerValue := printer.NewPrinter(buffer).WithState(printer.PrinterStatePHP) + node.Accept(printerValue) + + expected := `${$foo}['bar']` + actual := buffer.String() + + if expected != actual { + test.Errorf("\nexpected: %s\ngot: %s\n", expected, actual) + } +} + +func TestFormatter_ExprArrayDimFetch_VariableProperty(test *testing.T) { + buffer := bytes.NewBufferString("") + + node := &ast.ExprArrayDimFetch{ + Var: &ast.ExprPropertyFetch{ + Var: &ast.ExprVariable{ + Name: &ast.Identifier{ + Value: []byte("$foo"), + }, + }, + Prop: &ast.ExprVariable{ + Name: &ast.Identifier{ + Value: []byte("$bar"), + }, + }, + }, + Dim: &ast.ScalarString{ + Value: []byte("'baz'"), + }, + } + + formatterValue := formatter.NewFormatter().WithState(formatter.FormatterStatePHP).WithIndent(1) + node.Accept(formatterValue) + + printerValue := printer.NewPrinter(buffer).WithState(printer.PrinterStatePHP) + node.Accept(printerValue) + + expected := `$foo->{$bar}['baz']` + actual := buffer.String() + + if expected != actual { + test.Errorf("\nexpected: %s\ngot: %s\n", expected, actual) + } +} + func TestFormatter_ExprVariable_Expression(test *testing.T) { buffer := bytes.NewBufferString("")