class Standard
Same name in this branch
- 11.1.x core/modules/views/src/Plugin/views/sort/Standard.php \Drupal\views\Plugin\views\sort\Standard
- 11.1.x core/modules/views/src/Plugin/views/argument/Standard.php \Drupal\views\Plugin\views\argument\Standard
- 11.1.x core/modules/views/src/Plugin/views/filter/Standard.php \Drupal\views\Plugin\views\filter\Standard
- 11.1.x core/modules/views/src/Plugin/views/relationship/Standard.php \Drupal\views\Plugin\views\relationship\Standard
- 11.1.x core/modules/views/src/Plugin/views/field/Standard.php \Drupal\views\Plugin\views\field\Standard
- 11.1.x core/modules/views/src/Plugin/views/join/Standard.php \Drupal\views\Plugin\views\join\Standard
- 11.1.x core/modules/views/src/Plugin/views/wizard/Standard.php \Drupal\views\Plugin\views\wizard\Standard
- 11.1.x core/modules/editor/src/EditorXssFilter/Standard.php \Drupal\editor\EditorXssFilter\Standard
Hierarchy
- class \PhpParser\PrettyPrinterAbstract implements \PhpParser\PrettyPrinter
- class \PhpParser\PrettyPrinter\Standard extends \PhpParser\PrettyPrinterAbstract
Expanded class hierarchy of Standard
67 string references to 'Standard'
- Comment::defaultDisplayOptions in core/
modules/ comment/ src/ Plugin/ views/ wizard/ Comment.php - Assembles the default display options for the view.
- CommentViewsData::getViewsData in core/
modules/ comment/ src/ CommentViewsData.php - Returns views data for the entity type.
- CommentViewsHooks::viewsDataAlter in core/
modules/ comment/ src/ Hook/ CommentViewsHooks.php - Implements hook_views_data_alter().
- DblogViewsHooks::viewsData in core/
modules/ dblog/ src/ Hook/ DblogViewsHooks.php - Implements hook_views_data().
- DefaultWizardDeriver::getDerivativeDefinitions in core/
modules/ views/ src/ Plugin/ Derivative/ DefaultWizardDeriver.php - Gets the definition of all derivatives of a base plugin.
File
-
vendor/
nikic/ php-parser/ lib/ PhpParser/ PrettyPrinter/ Standard.php, line 16
Namespace
PhpParser\PrettyPrinterView source
class Standard extends PrettyPrinterAbstract {
// Special nodes
protected function pParam(Node\Param $node) : string {
return $this->pAttrGroups($node->attrGroups, true) . $this->pModifiers($node->flags) . ($node->type ? $this->p($node->type) . ' ' : '') . ($node->byRef ? '&' : '') . ($node->variadic ? '...' : '') . $this->p($node->var) . ($node->default ? ' = ' . $this->p($node->default) : '') . ($node->hooks ? ' {' . $this->pStmts($node->hooks) . $this->nl . '}' : '');
}
protected function pArg(Node\Arg $node) : string {
return ($node->name ? $node->name
->toString() . ': ' : '') . ($node->byRef ? '&' : '') . ($node->unpack ? '...' : '') . $this->p($node->value);
}
protected function pVariadicPlaceholder(Node\VariadicPlaceholder $node) : string {
return '...';
}
protected function pConst(Node\Const_ $node) : string {
return $node->name . ' = ' . $this->p($node->value);
}
protected function pNullableType(Node\NullableType $node) : string {
return '?' . $this->p($node->type);
}
protected function pUnionType(Node\UnionType $node) : string {
$types = [];
foreach ($node->types as $typeNode) {
if ($typeNode instanceof Node\IntersectionType) {
$types[] = '(' . $this->p($typeNode) . ')';
continue;
}
$types[] = $this->p($typeNode);
}
return implode('|', $types);
}
protected function pIntersectionType(Node\IntersectionType $node) : string {
return $this->pImplode($node->types, '&');
}
protected function pIdentifier(Node\Identifier $node) : string {
return $node->name;
}
protected function pVarLikeIdentifier(Node\VarLikeIdentifier $node) : string {
return '$' . $node->name;
}
protected function pAttribute(Node\Attribute $node) : string {
return $this->p($node->name) . ($node->args ? '(' . $this->pCommaSeparated($node->args) . ')' : '');
}
protected function pAttributeGroup(Node\AttributeGroup $node) : string {
return '#[' . $this->pCommaSeparated($node->attrs) . ']';
}
// Names
protected function pName(Name $node) : string {
return $node->name;
}
protected function pName_FullyQualified(Name\FullyQualified $node) : string {
return '\\' . $node->name;
}
protected function pName_Relative(Name\Relative $node) : string {
return 'namespace\\' . $node->name;
}
// Magic Constants
protected function pScalar_MagicConst_Class(MagicConst\Class_ $node) : string {
return '__CLASS__';
}
protected function pScalar_MagicConst_Dir(MagicConst\Dir $node) : string {
return '__DIR__';
}
protected function pScalar_MagicConst_File(MagicConst\File $node) : string {
return '__FILE__';
}
protected function pScalar_MagicConst_Function(MagicConst\Function_ $node) : string {
return '__FUNCTION__';
}
protected function pScalar_MagicConst_Line(MagicConst\Line $node) : string {
return '__LINE__';
}
protected function pScalar_MagicConst_Method(MagicConst\Method $node) : string {
return '__METHOD__';
}
protected function pScalar_MagicConst_Namespace(MagicConst\Namespace_ $node) : string {
return '__NAMESPACE__';
}
protected function pScalar_MagicConst_Trait(MagicConst\Trait_ $node) : string {
return '__TRAIT__';
}
protected function pScalar_MagicConst_Property(MagicConst\Property $node) : string {
return '__PROPERTY__';
}
// Scalars
private function indentString(string $str) : string {
return str_replace("\n", $this->nl, $str);
}
protected function pScalar_String(Scalar\String_ $node) : string {
$kind = $node->getAttribute('kind', Scalar\String_::KIND_SINGLE_QUOTED);
switch ($kind) {
case Scalar\String_::KIND_NOWDOC:
$label = $node->getAttribute('docLabel');
if ($label && !$this->containsEndLabel($node->value, $label)) {
$shouldIdent = $this->phpVersion
->supportsFlexibleHeredoc();
$nl = $shouldIdent ? $this->nl : $this->newline;
if ($node->value === '') {
return "<<<'{$label}'{$nl}{$label}{$this->docStringEndToken}";
}
// Make sure trailing \r is not combined with following \n into CRLF.
if ($node->value[strlen($node->value) - 1] !== "\r") {
$value = $shouldIdent ? $this->indentString($node->value) : $node->value;
return "<<<'{$label}'{$nl}{$value}{$nl}{$label}{$this->docStringEndToken}";
}
}
/* break missing intentionally */
// no break
case Scalar\String_::KIND_SINGLE_QUOTED:
return $this->pSingleQuotedString($node->value);
case Scalar\String_::KIND_HEREDOC:
$label = $node->getAttribute('docLabel');
$escaped = $this->escapeString($node->value, null);
if ($label && !$this->containsEndLabel($escaped, $label)) {
$nl = $this->phpVersion
->supportsFlexibleHeredoc() ? $this->nl : $this->newline;
if ($escaped === '') {
return "<<<{$label}{$nl}{$label}{$this->docStringEndToken}";
}
return "<<<{$label}{$nl}{$escaped}{$nl}{$label}{$this->docStringEndToken}";
}
/* break missing intentionally */
// no break
case Scalar\String_::KIND_DOUBLE_QUOTED:
return '"' . $this->escapeString($node->value, '"') . '"';
}
throw new \Exception('Invalid string kind');
}
protected function pScalar_InterpolatedString(Scalar\InterpolatedString $node) : string {
if ($node->getAttribute('kind') === Scalar\String_::KIND_HEREDOC) {
$label = $node->getAttribute('docLabel');
if ($label && !$this->encapsedContainsEndLabel($node->parts, $label)) {
$nl = $this->phpVersion
->supportsFlexibleHeredoc() ? $this->nl : $this->newline;
if (count($node->parts) === 1 && $node->parts[0] instanceof Node\InterpolatedStringPart && $node->parts[0]->value === '') {
return "<<<{$label}{$nl}{$label}{$this->docStringEndToken}";
}
return "<<<{$label}{$nl}" . $this->pEncapsList($node->parts, null) . "{$nl}{$label}{$this->docStringEndToken}";
}
}
return '"' . $this->pEncapsList($node->parts, '"') . '"';
}
protected function pScalar_Int(Scalar\Int_ $node) : string {
if ($node->value === -\PHP_INT_MAX - 1) {
// PHP_INT_MIN cannot be represented as a literal,
// because the sign is not part of the literal
return '(-' . \PHP_INT_MAX . '-1)';
}
$kind = $node->getAttribute('kind', Scalar\Int_::KIND_DEC);
if (Scalar\Int_::KIND_DEC === $kind) {
return (string) $node->value;
}
if ($node->value < 0) {
$sign = '-';
$str = (string) -$node->value;
}
else {
$sign = '';
$str = (string) $node->value;
}
switch ($kind) {
case Scalar\Int_::KIND_BIN:
return $sign . '0b' . base_convert($str, 10, 2);
case Scalar\Int_::KIND_OCT:
return $sign . '0' . base_convert($str, 10, 8);
case Scalar\Int_::KIND_HEX:
return $sign . '0x' . base_convert($str, 10, 16);
}
throw new \Exception('Invalid number kind');
}
protected function pScalar_Float(Scalar\Float_ $node) : string {
if (!is_finite($node->value)) {
if ($node->value === \INF) {
return '1.0E+1000';
}
if ($node->value === -\INF) {
return '-1.0E+1000';
}
else {
return '\\NAN';
}
}
// Try to find a short full-precision representation
$stringValue = sprintf('%.16G', $node->value);
if ($node->value !== (double) $stringValue) {
$stringValue = sprintf('%.17G', $node->value);
}
// %G is locale dependent and there exists no locale-independent alternative. We don't want
// mess with switching locales here, so let's assume that a comma is the only non-standard
// decimal separator we may encounter...
$stringValue = str_replace(',', '.', $stringValue);
// ensure that number is really printed as float
return preg_match('/^-?[0-9]+$/', $stringValue) ? $stringValue . '.0' : $stringValue;
}
// Assignments
protected function pExpr_Assign(Expr\Assign $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(Expr\Assign::class, $this->p($node->var) . ' = ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_AssignRef(Expr\AssignRef $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(Expr\AssignRef::class, $this->p($node->var) . ' =& ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_AssignOp_Plus(AssignOp\Plus $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(AssignOp\Plus::class, $this->p($node->var) . ' += ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_AssignOp_Minus(AssignOp\Minus $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(AssignOp\Minus::class, $this->p($node->var) . ' -= ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_AssignOp_Mul(AssignOp\Mul $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(AssignOp\Mul::class, $this->p($node->var) . ' *= ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_AssignOp_Div(AssignOp\Div $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(AssignOp\Div::class, $this->p($node->var) . ' /= ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_AssignOp_Concat(AssignOp\Concat $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(AssignOp\Concat::class, $this->p($node->var) . ' .= ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_AssignOp_Mod(AssignOp\Mod $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(AssignOp\Mod::class, $this->p($node->var) . ' %= ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_AssignOp_BitwiseAnd(AssignOp\BitwiseAnd $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(AssignOp\BitwiseAnd::class, $this->p($node->var) . ' &= ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_AssignOp_BitwiseOr(AssignOp\BitwiseOr $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(AssignOp\BitwiseOr::class, $this->p($node->var) . ' |= ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_AssignOp_BitwiseXor(AssignOp\BitwiseXor $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(AssignOp\BitwiseXor::class, $this->p($node->var) . ' ^= ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_AssignOp_ShiftLeft(AssignOp\ShiftLeft $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(AssignOp\ShiftLeft::class, $this->p($node->var) . ' <<= ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_AssignOp_ShiftRight(AssignOp\ShiftRight $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(AssignOp\ShiftRight::class, $this->p($node->var) . ' >>= ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_AssignOp_Pow(AssignOp\Pow $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(AssignOp\Pow::class, $this->p($node->var) . ' **= ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_AssignOp_Coalesce(AssignOp\Coalesce $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(AssignOp\Coalesce::class, $this->p($node->var) . ' ??= ', $node->expr, $precedence, $lhsPrecedence);
}
// Binary expressions
protected function pExpr_BinaryOp_Plus(BinaryOp\Plus $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\Plus::class, $node->left, ' + ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_Minus(BinaryOp\Minus $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\Minus::class, $node->left, ' - ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_Mul(BinaryOp\Mul $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\Mul::class, $node->left, ' * ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_Div(BinaryOp\Div $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\Div::class, $node->left, ' / ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_Concat(BinaryOp\Concat $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\Concat::class, $node->left, ' . ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_Mod(BinaryOp\Mod $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\Mod::class, $node->left, ' % ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_BooleanAnd(BinaryOp\BooleanAnd $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\BooleanAnd::class, $node->left, ' && ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_BooleanOr(BinaryOp\BooleanOr $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\BooleanOr::class, $node->left, ' || ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_BitwiseAnd(BinaryOp\BitwiseAnd $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\BitwiseAnd::class, $node->left, ' & ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_BitwiseOr(BinaryOp\BitwiseOr $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\BitwiseOr::class, $node->left, ' | ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_BitwiseXor(BinaryOp\BitwiseXor $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\BitwiseXor::class, $node->left, ' ^ ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_ShiftLeft(BinaryOp\ShiftLeft $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\ShiftLeft::class, $node->left, ' << ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_ShiftRight(BinaryOp\ShiftRight $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\ShiftRight::class, $node->left, ' >> ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_Pow(BinaryOp\Pow $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\Pow::class, $node->left, ' ** ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_LogicalAnd(BinaryOp\LogicalAnd $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\LogicalAnd::class, $node->left, ' and ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_LogicalOr(BinaryOp\LogicalOr $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\LogicalOr::class, $node->left, ' or ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_LogicalXor(BinaryOp\LogicalXor $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\LogicalXor::class, $node->left, ' xor ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_Equal(BinaryOp\Equal $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\Equal::class, $node->left, ' == ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_NotEqual(BinaryOp\NotEqual $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\NotEqual::class, $node->left, ' != ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_Identical(BinaryOp\Identical $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\Identical::class, $node->left, ' === ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_NotIdentical(BinaryOp\NotIdentical $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\NotIdentical::class, $node->left, ' !== ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_Spaceship(BinaryOp\Spaceship $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\Spaceship::class, $node->left, ' <=> ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_Greater(BinaryOp\Greater $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\Greater::class, $node->left, ' > ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_GreaterOrEqual(BinaryOp\GreaterOrEqual $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\GreaterOrEqual::class, $node->left, ' >= ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_Smaller(BinaryOp\Smaller $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\Smaller::class, $node->left, ' < ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_SmallerOrEqual(BinaryOp\SmallerOrEqual $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\SmallerOrEqual::class, $node->left, ' <= ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_BinaryOp_Coalesce(BinaryOp\Coalesce $node, int $precedence, int $lhsPrecedence) : string {
return $this->pInfixOp(BinaryOp\Coalesce::class, $node->left, ' ?? ', $node->right, $precedence, $lhsPrecedence);
}
protected function pExpr_Instanceof(Expr\Instanceof_ $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPostfixOp(Expr\Instanceof_::class, $node->expr, ' instanceof ' . $this->pNewOperand($node->class), $precedence, $lhsPrecedence);
}
// Unary expressions
protected function pExpr_BooleanNot(Expr\BooleanNot $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(Expr\BooleanNot::class, '!', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_BitwiseNot(Expr\BitwiseNot $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(Expr\BitwiseNot::class, '~', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_UnaryMinus(Expr\UnaryMinus $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(Expr\UnaryMinus::class, '-', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_UnaryPlus(Expr\UnaryPlus $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(Expr\UnaryPlus::class, '+', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_PreInc(Expr\PreInc $node) : string {
return '++' . $this->p($node->var);
}
protected function pExpr_PreDec(Expr\PreDec $node) : string {
return '--' . $this->p($node->var);
}
protected function pExpr_PostInc(Expr\PostInc $node) : string {
return $this->p($node->var) . '++';
}
protected function pExpr_PostDec(Expr\PostDec $node) : string {
return $this->p($node->var) . '--';
}
protected function pExpr_ErrorSuppress(Expr\ErrorSuppress $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(Expr\ErrorSuppress::class, '@', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_YieldFrom(Expr\YieldFrom $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(Expr\YieldFrom::class, 'yield from ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_Print(Expr\Print_ $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(Expr\Print_::class, 'print ', $node->expr, $precedence, $lhsPrecedence);
}
// Casts
protected function pExpr_Cast_Int(Cast\Int_ $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(Cast\Int_::class, '(int) ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_Cast_Double(Cast\Double $node, int $precedence, int $lhsPrecedence) : string {
$kind = $node->getAttribute('kind', Cast\Double::KIND_DOUBLE);
if ($kind === Cast\Double::KIND_DOUBLE) {
$cast = '(double)';
}
elseif ($kind === Cast\Double::KIND_FLOAT) {
$cast = '(float)';
}
else {
assert($kind === Cast\Double::KIND_REAL);
$cast = '(real)';
}
return $this->pPrefixOp(Cast\Double::class, $cast . ' ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_Cast_String(Cast\String_ $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(Cast\String_::class, '(string) ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_Cast_Array(Cast\Array_ $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(Cast\Array_::class, '(array) ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_Cast_Object(Cast\Object_ $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(Cast\Object_::class, '(object) ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_Cast_Bool(Cast\Bool_ $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(Cast\Bool_::class, '(bool) ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_Cast_Unset(Cast\Unset_ $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(Cast\Unset_::class, '(unset) ', $node->expr, $precedence, $lhsPrecedence);
}
// Function calls and similar constructs
protected function pExpr_FuncCall(Expr\FuncCall $node) : string {
return $this->pCallLhs($node->name) . '(' . $this->pMaybeMultiline($node->args) . ')';
}
protected function pExpr_MethodCall(Expr\MethodCall $node) : string {
return $this->pDereferenceLhs($node->var) . '->' . $this->pObjectProperty($node->name) . '(' . $this->pMaybeMultiline($node->args) . ')';
}
protected function pExpr_NullsafeMethodCall(Expr\NullsafeMethodCall $node) : string {
return $this->pDereferenceLhs($node->var) . '?->' . $this->pObjectProperty($node->name) . '(' . $this->pMaybeMultiline($node->args) . ')';
}
protected function pExpr_StaticCall(Expr\StaticCall $node) : string {
return $this->pStaticDereferenceLhs($node->class) . '::' . ($node->name instanceof Expr ? $node->name instanceof Expr\Variable ? $this->p($node->name) : '{' . $this->p($node->name) . '}' : $node->name) . '(' . $this->pMaybeMultiline($node->args) . ')';
}
protected function pExpr_Empty(Expr\Empty_ $node) : string {
return 'empty(' . $this->p($node->expr) . ')';
}
protected function pExpr_Isset(Expr\Isset_ $node) : string {
return 'isset(' . $this->pCommaSeparated($node->vars) . ')';
}
protected function pExpr_Eval(Expr\Eval_ $node) : string {
return 'eval(' . $this->p($node->expr) . ')';
}
protected function pExpr_Include(Expr\Include_ $node, int $precedence, int $lhsPrecedence) : string {
static $map = [
Expr\Include_::TYPE_INCLUDE => 'include',
Expr\Include_::TYPE_INCLUDE_ONCE => 'include_once',
Expr\Include_::TYPE_REQUIRE => 'require',
Expr\Include_::TYPE_REQUIRE_ONCE => 'require_once',
];
return $this->pPrefixOp(Expr\Include_::class, $map[$node->type] . ' ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_List(Expr\List_ $node) : string {
$syntax = $node->getAttribute('kind', $this->phpVersion
->supportsShortArrayDestructuring() ? Expr\List_::KIND_ARRAY : Expr\List_::KIND_LIST);
if ($syntax === Expr\List_::KIND_ARRAY) {
return '[' . $this->pMaybeMultiline($node->items, true) . ']';
}
else {
return 'list(' . $this->pMaybeMultiline($node->items, true) . ')';
}
}
// Other
protected function pExpr_Error(Expr\Error $node) : string {
throw new \LogicException('Cannot pretty-print AST with Error nodes');
}
protected function pExpr_Variable(Expr\Variable $node) : string {
if ($node->name instanceof Expr) {
return '${' . $this->p($node->name) . '}';
}
else {
return '$' . $node->name;
}
}
protected function pExpr_Array(Expr\Array_ $node) : string {
$syntax = $node->getAttribute('kind', $this->shortArraySyntax ? Expr\Array_::KIND_SHORT : Expr\Array_::KIND_LONG);
if ($syntax === Expr\Array_::KIND_SHORT) {
return '[' . $this->pMaybeMultiline($node->items, true) . ']';
}
else {
return 'array(' . $this->pMaybeMultiline($node->items, true) . ')';
}
}
protected function pKey(?Node $node) : string {
if ($node === null) {
return '';
}
// => is not really an operator and does not typically participate in precedence resolution.
// However, there is an exception if yield expressions with keys are involved:
// [yield $a => $b] is interpreted as [(yield $a => $b)], so we need to ensure that
// [(yield $a) => $b] is printed with parentheses. We approximate this by lowering the LHS
// precedence to that of yield (which will also print unnecessary parentheses for rare low
// precedence unary operators like include).
$yieldPrecedence = $this->precedenceMap[Expr\Yield_::class][0];
return $this->p($node, self::MAX_PRECEDENCE, $yieldPrecedence) . ' => ';
}
protected function pArrayItem(Node\ArrayItem $node) : string {
return $this->pKey($node->key) . ($node->byRef ? '&' : '') . ($node->unpack ? '...' : '') . $this->p($node->value);
}
protected function pExpr_ArrayDimFetch(Expr\ArrayDimFetch $node) : string {
return $this->pDereferenceLhs($node->var) . '[' . (null !== $node->dim ? $this->p($node->dim) : '') . ']';
}
protected function pExpr_ConstFetch(Expr\ConstFetch $node) : string {
return $this->p($node->name);
}
protected function pExpr_ClassConstFetch(Expr\ClassConstFetch $node) : string {
return $this->pStaticDereferenceLhs($node->class) . '::' . $this->pObjectProperty($node->name);
}
protected function pExpr_PropertyFetch(Expr\PropertyFetch $node) : string {
return $this->pDereferenceLhs($node->var) . '->' . $this->pObjectProperty($node->name);
}
protected function pExpr_NullsafePropertyFetch(Expr\NullsafePropertyFetch $node) : string {
return $this->pDereferenceLhs($node->var) . '?->' . $this->pObjectProperty($node->name);
}
protected function pExpr_StaticPropertyFetch(Expr\StaticPropertyFetch $node) : string {
return $this->pStaticDereferenceLhs($node->class) . '::$' . $this->pObjectProperty($node->name);
}
protected function pExpr_ShellExec(Expr\ShellExec $node) : string {
return '`' . $this->pEncapsList($node->parts, '`') . '`';
}
protected function pExpr_Closure(Expr\Closure $node) : string {
return $this->pAttrGroups($node->attrGroups, true) . $this->pStatic($node->static) . 'function ' . ($node->byRef ? '&' : '') . '(' . $this->pMaybeMultiline($node->params, $this->phpVersion
->supportsTrailingCommaInParamList()) . ')' . (!empty($node->uses) ? ' use (' . $this->pCommaSeparated($node->uses) . ')' : '') . (null !== $node->returnType ? ': ' . $this->p($node->returnType) : '') . ' {' . $this->pStmts($node->stmts) . $this->nl . '}';
}
protected function pExpr_Match(Expr\Match_ $node) : string {
return 'match (' . $this->p($node->cond) . ') {' . $this->pCommaSeparatedMultiline($node->arms, true) . $this->nl . '}';
}
protected function pMatchArm(Node\MatchArm $node) : string {
$result = '';
if ($node->conds) {
for ($i = 0, $c = \count($node->conds); $i + 1 < $c; $i++) {
$result .= $this->p($node->conds[$i]) . ', ';
}
$result .= $this->pKey($node->conds[$i]);
}
else {
$result = 'default => ';
}
return $result . $this->p($node->body);
}
protected function pExpr_ArrowFunction(Expr\ArrowFunction $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(Expr\ArrowFunction::class, $this->pAttrGroups($node->attrGroups, true) . $this->pStatic($node->static) . 'fn' . ($node->byRef ? '&' : '') . '(' . $this->pMaybeMultiline($node->params, $this->phpVersion
->supportsTrailingCommaInParamList()) . ')' . (null !== $node->returnType ? ': ' . $this->p($node->returnType) : '') . ' => ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pClosureUse(Node\ClosureUse $node) : string {
return ($node->byRef ? '&' : '') . $this->p($node->var);
}
protected function pExpr_New(Expr\New_ $node) : string {
if ($node->class instanceof Stmt\Class_) {
$args = $node->args ? '(' . $this->pMaybeMultiline($node->args) . ')' : '';
return 'new ' . $this->pClassCommon($node->class, $args);
}
return 'new ' . $this->pNewOperand($node->class) . '(' . $this->pMaybeMultiline($node->args) . ')';
}
protected function pExpr_Clone(Expr\Clone_ $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(Expr\Clone_::class, 'clone ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_Ternary(Expr\Ternary $node, int $precedence, int $lhsPrecedence) : string {
// a bit of cheating: we treat the ternary as a binary op where the ?...: part is the operator.
// this is okay because the part between ? and : never needs parentheses.
return $this->pInfixOp(Expr\Ternary::class, $node->cond, ' ?' . (null !== $node->if ? ' ' . $this->p($node->if) . ' ' : '') . ': ', $node->else, $precedence, $lhsPrecedence);
}
protected function pExpr_Exit(Expr\Exit_ $node) : string {
$kind = $node->getAttribute('kind', Expr\Exit_::KIND_DIE);
return ($kind === Expr\Exit_::KIND_EXIT ? 'exit' : 'die') . (null !== $node->expr ? '(' . $this->p($node->expr) . ')' : '');
}
protected function pExpr_Throw(Expr\Throw_ $node, int $precedence, int $lhsPrecedence) : string {
return $this->pPrefixOp(Expr\Throw_::class, 'throw ', $node->expr, $precedence, $lhsPrecedence);
}
protected function pExpr_Yield(Expr\Yield_ $node, int $precedence, int $lhsPrecedence) : string {
if ($node->value === null) {
$opPrecedence = $this->precedenceMap[Expr\Yield_::class][0];
return $opPrecedence >= $lhsPrecedence ? '(yield)' : 'yield';
}
else {
if (!$this->phpVersion
->supportsYieldWithoutParentheses()) {
return '(yield ' . $this->pKey($node->key) . $this->p($node->value) . ')';
}
return $this->pPrefixOp(Expr\Yield_::class, 'yield ' . $this->pKey($node->key), $node->value, $precedence, $lhsPrecedence);
}
}
// Declarations
protected function pStmt_Namespace(Stmt\Namespace_ $node) : string {
if ($this->canUseSemicolonNamespaces) {
return 'namespace ' . $this->p($node->name) . ';' . $this->nl . $this->pStmts($node->stmts, false);
}
else {
return 'namespace' . (null !== $node->name ? ' ' . $this->p($node->name) : '') . ' {' . $this->pStmts($node->stmts) . $this->nl . '}';
}
}
protected function pStmt_Use(Stmt\Use_ $node) : string {
return 'use ' . $this->pUseType($node->type) . $this->pCommaSeparated($node->uses) . ';';
}
protected function pStmt_GroupUse(Stmt\GroupUse $node) : string {
return 'use ' . $this->pUseType($node->type) . $this->pName($node->prefix) . '\\{' . $this->pCommaSeparated($node->uses) . '};';
}
protected function pUseItem(Node\UseItem $node) : string {
return $this->pUseType($node->type) . $this->p($node->name) . (null !== $node->alias ? ' as ' . $node->alias : '');
}
protected function pUseType(int $type) : string {
return $type === Stmt\Use_::TYPE_FUNCTION ? 'function ' : ($type === Stmt\Use_::TYPE_CONSTANT ? 'const ' : '');
}
protected function pStmt_Interface(Stmt\Interface_ $node) : string {
return $this->pAttrGroups($node->attrGroups) . 'interface ' . $node->name . (!empty($node->extends) ? ' extends ' . $this->pCommaSeparated($node->extends) : '') . $this->nl . '{' . $this->pStmts($node->stmts) . $this->nl . '}';
}
protected function pStmt_Enum(Stmt\Enum_ $node) : string {
return $this->pAttrGroups($node->attrGroups) . 'enum ' . $node->name . ($node->scalarType ? ' : ' . $this->p($node->scalarType) : '') . (!empty($node->implements) ? ' implements ' . $this->pCommaSeparated($node->implements) : '') . $this->nl . '{' . $this->pStmts($node->stmts) . $this->nl . '}';
}
protected function pStmt_Class(Stmt\Class_ $node) : string {
return $this->pClassCommon($node, ' ' . $node->name);
}
protected function pStmt_Trait(Stmt\Trait_ $node) : string {
return $this->pAttrGroups($node->attrGroups) . 'trait ' . $node->name . $this->nl . '{' . $this->pStmts($node->stmts) . $this->nl . '}';
}
protected function pStmt_EnumCase(Stmt\EnumCase $node) : string {
return $this->pAttrGroups($node->attrGroups) . 'case ' . $node->name . ($node->expr ? ' = ' . $this->p($node->expr) : '') . ';';
}
protected function pStmt_TraitUse(Stmt\TraitUse $node) : string {
return 'use ' . $this->pCommaSeparated($node->traits) . (empty($node->adaptations) ? ';' : ' {' . $this->pStmts($node->adaptations) . $this->nl . '}');
}
protected function pStmt_TraitUseAdaptation_Precedence(Stmt\TraitUseAdaptation\Precedence $node) : string {
return $this->p($node->trait) . '::' . $node->method . ' insteadof ' . $this->pCommaSeparated($node->insteadof) . ';';
}
protected function pStmt_TraitUseAdaptation_Alias(Stmt\TraitUseAdaptation\Alias $node) : string {
return (null !== $node->trait ? $this->p($node->trait) . '::' : '') . $node->method . ' as' . (null !== $node->newModifier ? ' ' . rtrim($this->pModifiers($node->newModifier), ' ') : '') . (null !== $node->newName ? ' ' . $node->newName : '') . ';';
}
protected function pStmt_Property(Stmt\Property $node) : string {
return $this->pAttrGroups($node->attrGroups) . (0 === $node->flags ? 'var ' : $this->pModifiers($node->flags)) . ($node->type ? $this->p($node->type) . ' ' : '') . $this->pCommaSeparated($node->props) . ($node->hooks ? ' {' . $this->pStmts($node->hooks) . $this->nl . '}' : ';');
}
protected function pPropertyItem(Node\PropertyItem $node) : string {
return '$' . $node->name . (null !== $node->default ? ' = ' . $this->p($node->default) : '');
}
protected function pPropertyHook(Node\PropertyHook $node) : string {
return $this->pAttrGroups($node->attrGroups) . $this->pModifiers($node->flags) . ($node->byRef ? '&' : '') . $node->name . ($node->params ? '(' . $this->pMaybeMultiline($node->params, $this->phpVersion
->supportsTrailingCommaInParamList()) . ')' : '') . (\is_array($node->body) ? ' {' . $this->pStmts($node->body) . $this->nl . '}' : ($node->body !== null ? ' => ' . $this->p($node->body) : '') . ';');
}
protected function pStmt_ClassMethod(Stmt\ClassMethod $node) : string {
return $this->pAttrGroups($node->attrGroups) . $this->pModifiers($node->flags) . 'function ' . ($node->byRef ? '&' : '') . $node->name . '(' . $this->pMaybeMultiline($node->params, $this->phpVersion
->supportsTrailingCommaInParamList()) . ')' . (null !== $node->returnType ? ': ' . $this->p($node->returnType) : '') . (null !== $node->stmts ? $this->nl . '{' . $this->pStmts($node->stmts) . $this->nl . '}' : ';');
}
protected function pStmt_ClassConst(Stmt\ClassConst $node) : string {
return $this->pAttrGroups($node->attrGroups) . $this->pModifiers($node->flags) . 'const ' . (null !== $node->type ? $this->p($node->type) . ' ' : '') . $this->pCommaSeparated($node->consts) . ';';
}
protected function pStmt_Function(Stmt\Function_ $node) : string {
return $this->pAttrGroups($node->attrGroups) . 'function ' . ($node->byRef ? '&' : '') . $node->name . '(' . $this->pMaybeMultiline($node->params, $this->phpVersion
->supportsTrailingCommaInParamList()) . ')' . (null !== $node->returnType ? ': ' . $this->p($node->returnType) : '') . $this->nl . '{' . $this->pStmts($node->stmts) . $this->nl . '}';
}
protected function pStmt_Const(Stmt\Const_ $node) : string {
return 'const ' . $this->pCommaSeparated($node->consts) . ';';
}
protected function pStmt_Declare(Stmt\Declare_ $node) : string {
return 'declare (' . $this->pCommaSeparated($node->declares) . ')' . (null !== $node->stmts ? ' {' . $this->pStmts($node->stmts) . $this->nl . '}' : ';');
}
protected function pDeclareItem(Node\DeclareItem $node) : string {
return $node->key . '=' . $this->p($node->value);
}
// Control flow
protected function pStmt_If(Stmt\If_ $node) : string {
return 'if (' . $this->p($node->cond) . ') {' . $this->pStmts($node->stmts) . $this->nl . '}' . ($node->elseifs ? ' ' . $this->pImplode($node->elseifs, ' ') : '') . (null !== $node->else ? ' ' . $this->p($node->else) : '');
}
protected function pStmt_ElseIf(Stmt\ElseIf_ $node) : string {
return 'elseif (' . $this->p($node->cond) . ') {' . $this->pStmts($node->stmts) . $this->nl . '}';
}
protected function pStmt_Else(Stmt\Else_ $node) : string {
if (\count($node->stmts) === 1 && $node->stmts[0] instanceof Stmt\If_) {
// Print as "else if" rather than "else { if }"
return 'else ' . $this->p($node->stmts[0]);
}
return 'else {' . $this->pStmts($node->stmts) . $this->nl . '}';
}
protected function pStmt_For(Stmt\For_ $node) : string {
return 'for (' . $this->pCommaSeparated($node->init) . ';' . (!empty($node->cond) ? ' ' : '') . $this->pCommaSeparated($node->cond) . ';' . (!empty($node->loop) ? ' ' : '') . $this->pCommaSeparated($node->loop) . ') {' . $this->pStmts($node->stmts) . $this->nl . '}';
}
protected function pStmt_Foreach(Stmt\Foreach_ $node) : string {
return 'foreach (' . $this->p($node->expr) . ' as ' . (null !== $node->keyVar ? $this->p($node->keyVar) . ' => ' : '') . ($node->byRef ? '&' : '') . $this->p($node->valueVar) . ') {' . $this->pStmts($node->stmts) . $this->nl . '}';
}
protected function pStmt_While(Stmt\While_ $node) : string {
return 'while (' . $this->p($node->cond) . ') {' . $this->pStmts($node->stmts) . $this->nl . '}';
}
protected function pStmt_Do(Stmt\Do_ $node) : string {
return 'do {' . $this->pStmts($node->stmts) . $this->nl . '} while (' . $this->p($node->cond) . ');';
}
protected function pStmt_Switch(Stmt\Switch_ $node) : string {
return 'switch (' . $this->p($node->cond) . ') {' . $this->pStmts($node->cases) . $this->nl . '}';
}
protected function pStmt_Case(Stmt\Case_ $node) : string {
return (null !== $node->cond ? 'case ' . $this->p($node->cond) : 'default') . ':' . $this->pStmts($node->stmts);
}
protected function pStmt_TryCatch(Stmt\TryCatch $node) : string {
return 'try {' . $this->pStmts($node->stmts) . $this->nl . '}' . ($node->catches ? ' ' . $this->pImplode($node->catches, ' ') : '') . ($node->finally !== null ? ' ' . $this->p($node->finally) : '');
}
protected function pStmt_Catch(Stmt\Catch_ $node) : string {
return 'catch (' . $this->pImplode($node->types, '|') . ($node->var !== null ? ' ' . $this->p($node->var) : '') . ') {' . $this->pStmts($node->stmts) . $this->nl . '}';
}
protected function pStmt_Finally(Stmt\Finally_ $node) : string {
return 'finally {' . $this->pStmts($node->stmts) . $this->nl . '}';
}
protected function pStmt_Break(Stmt\Break_ $node) : string {
return 'break' . ($node->num !== null ? ' ' . $this->p($node->num) : '') . ';';
}
protected function pStmt_Continue(Stmt\Continue_ $node) : string {
return 'continue' . ($node->num !== null ? ' ' . $this->p($node->num) : '') . ';';
}
protected function pStmt_Return(Stmt\Return_ $node) : string {
return 'return' . (null !== $node->expr ? ' ' . $this->p($node->expr) : '') . ';';
}
protected function pStmt_Label(Stmt\Label $node) : string {
return $node->name . ':';
}
protected function pStmt_Goto(Stmt\Goto_ $node) : string {
return 'goto ' . $node->name . ';';
}
// Other
protected function pStmt_Expression(Stmt\Expression $node) : string {
return $this->p($node->expr) . ';';
}
protected function pStmt_Echo(Stmt\Echo_ $node) : string {
return 'echo ' . $this->pCommaSeparated($node->exprs) . ';';
}
protected function pStmt_Static(Stmt\Static_ $node) : string {
return 'static ' . $this->pCommaSeparated($node->vars) . ';';
}
protected function pStmt_Global(Stmt\Global_ $node) : string {
return 'global ' . $this->pCommaSeparated($node->vars) . ';';
}
protected function pStaticVar(Node\StaticVar $node) : string {
return $this->p($node->var) . (null !== $node->default ? ' = ' . $this->p($node->default) : '');
}
protected function pStmt_Unset(Stmt\Unset_ $node) : string {
return 'unset(' . $this->pCommaSeparated($node->vars) . ');';
}
protected function pStmt_InlineHTML(Stmt\InlineHTML $node) : string {
$newline = $node->getAttribute('hasLeadingNewline', true) ? $this->newline : '';
return '?>' . $newline . $node->value . '<?php ';
}
protected function pStmt_HaltCompiler(Stmt\HaltCompiler $node) : string {
return '__halt_compiler();' . $node->remaining;
}
protected function pStmt_Nop(Stmt\Nop $node) : string {
return '';
}
protected function pStmt_Block(Stmt\Block $node) : string {
return '{' . $this->pStmts($node->stmts) . $this->nl . '}';
}
// Helpers
protected function pClassCommon(Stmt\Class_ $node, string $afterClassToken) : string {
return $this->pAttrGroups($node->attrGroups, $node->name === null) . $this->pModifiers($node->flags) . 'class' . $afterClassToken . (null !== $node->extends ? ' extends ' . $this->p($node->extends) : '') . (!empty($node->implements) ? ' implements ' . $this->pCommaSeparated($node->implements) : '') . $this->nl . '{' . $this->pStmts($node->stmts) . $this->nl . '}';
}
protected function pObjectProperty(Node $node) : string {
if ($node instanceof Expr) {
return '{' . $this->p($node) . '}';
}
else {
assert($node instanceof Node\Identifier);
return $node->name;
}
}
/** @param (Expr|Node\InterpolatedStringPart)[] $encapsList */
protected function pEncapsList(array $encapsList, ?string $quote) : string {
$return = '';
foreach ($encapsList as $element) {
if ($element instanceof Node\InterpolatedStringPart) {
$return .= $this->escapeString($element->value, $quote);
}
else {
$return .= '{' . $this->p($element) . '}';
}
}
return $return;
}
protected function pSingleQuotedString(string $string) : string {
// It is idiomatic to only escape backslashes when necessary, i.e. when followed by ', \ or
// the end of the string ('Foo\Bar' instead of 'Foo\\Bar'). However, we also don't want to
// produce an odd number of backslashes, so '\\\\a' should not get rendered as '\\\a', even
// though that would be legal.
$regex = '/\'|\\\\(?=[\'\\\\]|$)|(?<=\\\\)\\\\/';
return '\'' . preg_replace($regex, '\\\\$0', $string) . '\'';
}
protected function escapeString(string $string, ?string $quote) : string {
if (null === $quote) {
// For doc strings, don't escape newlines
$escaped = addcslashes($string, "\t\f\v\$\\");
// But do escape isolated \r. Combined with the terminating newline, it might get
// interpreted as \r\n and dropped from the string contents.
$escaped = preg_replace('/\\r(?!\\n)/', '\\r', $escaped);
if ($this->phpVersion
->supportsFlexibleHeredoc()) {
$escaped = $this->indentString($escaped);
}
}
else {
$escaped = addcslashes($string, "\n\r\t\f\v\$" . $quote . "\\");
}
// Escape control characters and non-UTF-8 characters.
// Regex based on https://stackoverflow.com/a/11709412/385378.
$regex = '/(
[\\x00-\\x08\\x0E-\\x1F] # Control characters
| [\\xC0-\\xC1] # Invalid UTF-8 Bytes
| [\\xF5-\\xFF] # Invalid UTF-8 Bytes
| \\xE0(?=[\\x80-\\x9F]) # Overlong encoding of prior code point
| \\xF0(?=[\\x80-\\x8F]) # Overlong encoding of prior code point
| [\\xC2-\\xDF](?![\\x80-\\xBF]) # Invalid UTF-8 Sequence Start
| [\\xE0-\\xEF](?![\\x80-\\xBF]{2}) # Invalid UTF-8 Sequence Start
| [\\xF0-\\xF4](?![\\x80-\\xBF]{3}) # Invalid UTF-8 Sequence Start
| (?<=[\\x00-\\x7F\\xF5-\\xFF])[\\x80-\\xBF] # Invalid UTF-8 Sequence Middle
| (?<![\\xC2-\\xDF]|[\\xE0-\\xEF]|[\\xE0-\\xEF][\\x80-\\xBF]|[\\xF0-\\xF4]|[\\xF0-\\xF4][\\x80-\\xBF]|[\\xF0-\\xF4][\\x80-\\xBF]{2})[\\x80-\\xBF] # Overlong Sequence
| (?<=[\\xE0-\\xEF])[\\x80-\\xBF](?![\\x80-\\xBF]) # Short 3 byte sequence
| (?<=[\\xF0-\\xF4])[\\x80-\\xBF](?![\\x80-\\xBF]{2}) # Short 4 byte sequence
| (?<=[\\xF0-\\xF4][\\x80-\\xBF])[\\x80-\\xBF](?![\\x80-\\xBF]) # Short 4 byte sequence (2)
)/x';
return preg_replace_callback($regex, function ($matches) : string {
assert(strlen($matches[0]) === 1);
$hex = dechex(ord($matches[0]));
return '\\x' . str_pad($hex, 2, '0', \STR_PAD_LEFT);
}, $escaped);
}
protected function containsEndLabel(string $string, string $label, bool $atStart = true) : bool {
$start = $atStart ? '(?:^|[\\r\\n])[ \\t]*' : '[\\r\\n][ \\t]*';
return false !== strpos($string, $label) && preg_match('/' . $start . $label . '(?:$|[^_A-Za-z0-9\\x80-\\xff])/', $string);
}
/** @param (Expr|Node\InterpolatedStringPart)[] $parts */
protected function encapsedContainsEndLabel(array $parts, string $label) : bool {
foreach ($parts as $i => $part) {
if ($part instanceof Node\InterpolatedStringPart && $this->containsEndLabel($this->escapeString($part->value, null), $label, $i === 0)) {
return true;
}
}
return false;
}
protected function pDereferenceLhs(Node $node) : string {
if (!$this->dereferenceLhsRequiresParens($node)) {
return $this->p($node);
}
else {
return '(' . $this->p($node) . ')';
}
}
protected function pStaticDereferenceLhs(Node $node) : string {
if (!$this->staticDereferenceLhsRequiresParens($node)) {
return $this->p($node);
}
else {
return '(' . $this->p($node) . ')';
}
}
protected function pCallLhs(Node $node) : string {
if (!$this->callLhsRequiresParens($node)) {
return $this->p($node);
}
else {
return '(' . $this->p($node) . ')';
}
}
protected function pNewOperand(Node $node) : string {
if (!$this->newOperandRequiresParens($node)) {
return $this->p($node);
}
else {
return '(' . $this->p($node) . ')';
}
}
/**
* @param Node[] $nodes
*/
protected function hasNodeWithComments(array $nodes) : bool {
foreach ($nodes as $node) {
if ($node && $node->getComments()) {
return true;
}
}
return false;
}
/** @param Node[] $nodes */
protected function pMaybeMultiline(array $nodes, bool $trailingComma = false) : string {
if (!$this->hasNodeWithComments($nodes)) {
return $this->pCommaSeparated($nodes);
}
else {
return $this->pCommaSeparatedMultiline($nodes, $trailingComma) . $this->nl;
}
}
/** @param Node\AttributeGroup[] $nodes */
protected function pAttrGroups(array $nodes, bool $inline = false) : string {
$result = '';
$sep = $inline ? ' ' : $this->nl;
foreach ($nodes as $node) {
$result .= $this->p($node) . $sep;
}
return $result;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
PrettyPrinterAbstract::$canUseSemicolonNamespaces | protected | property | @var bool Whether semicolon namespaces can be used (i.e. no global namespace is used) | |
PrettyPrinterAbstract::$docStringEndToken | protected | property | Null if flexible doc strings are used. | |
PrettyPrinterAbstract::$emptyListInsertionMap | protected | property | ||
PrettyPrinterAbstract::$fixupMap | protected | property | This is used during format-preserving prints to place additional parens/braces if necessary. | |
PrettyPrinterAbstract::$indent | private | property | @var string String for single level of indentation | |
PrettyPrinterAbstract::$indentLevel | protected | property | @var int Current indentation level. | |
PrettyPrinterAbstract::$indentWidth | private | property | @var int Width in spaces to indent by. | |
PrettyPrinterAbstract::$insertionMap | protected | property | "{$node->getType()}->{$subNode}" to [$find, $beforeToken, $extraLeft, $extraRight]. $find is an optional token after which the insertion occurs. $extraLeft/Right are optionally added before/after the main insertions. |
|
PrettyPrinterAbstract::$labelCharMap | protected | property | @var array<string, bool> Map determining whether a certain character is a label character | |
PrettyPrinterAbstract::$listInsertionMap | protected | property | between elements of this list subnode. | |
PrettyPrinterAbstract::$modifierChangeMap | protected | property | where $printFn is the function to print the modifiers and $token is the token before which the modifiers should be reprinted. |
|
PrettyPrinterAbstract::$newline | protected | property | @var string Newline style. Does not include current indentation. | |
PrettyPrinterAbstract::$nl | protected | property | @var string Newline including current indentation. | |
PrettyPrinterAbstract::$nodeListDiffer | protected | property | @var Internal\Differ<Node> Differ for node lists | |
PrettyPrinterAbstract::$origTokens | protected | property | @var TokenStream|null Original tokens for use in format-preserving pretty print | |
PrettyPrinterAbstract::$phpVersion | protected | property | @var PhpVersion PHP version to target | |
PrettyPrinterAbstract::$precedenceMap | protected | property | @var array<class-string, array{int, int, int}> | |
PrettyPrinterAbstract::$removalMap | protected | property | to ['left' => $l, 'right' => $r], where $l and $r specify the token type that needs to be stripped when removing this node. |
|
PrettyPrinterAbstract::$shortArraySyntax | protected | property | @var bool Whether to use short array syntax if the node specifies no preference | |
PrettyPrinterAbstract::$tabWidth | private | property | @var int Width in spaces of one tab. | |
PrettyPrinterAbstract::$useTabs | private | property | @var bool Whether to use tab indentation. | |
PrettyPrinterAbstract::callLhsRequiresParens | protected | function | Determines whether the LHS of a call must be wrapped in parenthesis. | |
PrettyPrinterAbstract::dereferenceLhsRequiresParens | protected | function | Determines whether the LHS of an array/object operation must be wrapped in parentheses. | |
PrettyPrinterAbstract::FIXUP_BRACED_NAME | protected | constant | ||
PrettyPrinterAbstract::FIXUP_CALL_LHS | protected | constant | ||
PrettyPrinterAbstract::FIXUP_DEREF_LHS | protected | constant | ||
PrettyPrinterAbstract::FIXUP_ENCAPSED | protected | constant | ||
PrettyPrinterAbstract::FIXUP_NEW | protected | constant | ||
PrettyPrinterAbstract::FIXUP_PREC_LEFT | protected | constant | ||
PrettyPrinterAbstract::FIXUP_PREC_RIGHT | protected | constant | ||
PrettyPrinterAbstract::FIXUP_PREC_UNARY | protected | constant | ||
PrettyPrinterAbstract::FIXUP_STATIC_DEREF_LHS | protected | constant | ||
PrettyPrinterAbstract::FIXUP_VAR_BRACED_NAME | protected | constant | ||
PrettyPrinterAbstract::handleMagicTokens | protected | function | Handles (and removes) doc-string-end tokens. | |
PrettyPrinterAbstract::indent | protected | function | Increase indentation level. | |
PrettyPrinterAbstract::initializeEmptyListInsertionMap | protected | function | ||
PrettyPrinterAbstract::initializeFixupMap | protected | function | Lazily initializes fixup map. | |
PrettyPrinterAbstract::initializeInsertionMap | protected | function | ||
PrettyPrinterAbstract::initializeLabelCharMap | protected | function | Lazily initializes label char map. | |
PrettyPrinterAbstract::initializeListInsertionMap | protected | function | ||
PrettyPrinterAbstract::initializeModifierChangeMap | protected | function | ||
PrettyPrinterAbstract::initializeNodeListDiffer | protected | function | Lazily initializes node list differ. | |
PrettyPrinterAbstract::initializeRemovalMap | protected | function | Lazily initializes the removal map. | |
PrettyPrinterAbstract::isMultiline | protected | function | Determine whether a list of nodes uses multiline formatting. | |
PrettyPrinterAbstract::MAX_PRECEDENCE | protected | constant | ||
PrettyPrinterAbstract::newOperandRequiresParens | protected | function | Determines whether an expression used in "new" or "instanceof" requires parentheses. | |
PrettyPrinterAbstract::outdent | protected | function | Decrease indentation level. | |
PrettyPrinterAbstract::p | protected | function | Pretty prints a node. | |
PrettyPrinterAbstract::pArray | protected | function | Perform a format-preserving pretty print of an array. | |
PrettyPrinterAbstract::pCommaSeparated | protected | function | Pretty prints an array of nodes and implodes the printed values with commas. | |
PrettyPrinterAbstract::pCommaSeparatedMultiline | protected | function | Pretty prints a comma-separated list of nodes in multiline style, including comments. | |
PrettyPrinterAbstract::pComments | protected | function | Prints reformatted text of the passed comments. | |
PrettyPrinterAbstract::pFallback | protected | function | ||
PrettyPrinterAbstract::pFixup | protected | function | Print node with fixups. | |
PrettyPrinterAbstract::pImplode | protected | function | Pretty prints an array of nodes and implodes the printed values. | |
PrettyPrinterAbstract::pInfixOp | protected | function | Pretty-print an infix operation while taking precedence into account. | |
PrettyPrinterAbstract::pModifiers | protected | function | Print modifiers, including trailing whitespace. | |
PrettyPrinterAbstract::pPostfixOp | protected | function | Pretty-print a postfix operation while taking precedence into account. | |
PrettyPrinterAbstract::pPrefixOp | protected | function | Pretty-print a prefix operation while taking precedence into account. | |
PrettyPrinterAbstract::preprocessNodes | protected | function | Preprocesses the top-level nodes to initialize pretty printer state. | |
PrettyPrinterAbstract::prettyPrint | public | function | Pretty prints an array of statements. | Overrides PrettyPrinter::prettyPrint |
PrettyPrinterAbstract::prettyPrintExpr | public | function | Pretty prints an expression. | Overrides PrettyPrinter::prettyPrintExpr |
PrettyPrinterAbstract::prettyPrintFile | public | function | Pretty prints a file of statements (includes the opening <?php tag if it is required). | Overrides PrettyPrinter::prettyPrintFile |
PrettyPrinterAbstract::printFormatPreserving | public | function | Perform a format-preserving pretty print of an AST. | Overrides PrettyPrinter::printFormatPreserving |
PrettyPrinterAbstract::pStatic | protected | function | ||
PrettyPrinterAbstract::pStmts | protected | function | Pretty prints an array of nodes (statements) and indents them optionally. | |
PrettyPrinterAbstract::resetState | protected | function | Reset pretty printing state. | |
PrettyPrinterAbstract::safeAppend | protected | function | Appends to a string, ensuring whitespace between label characters. | |
PrettyPrinterAbstract::setIndentLevel | protected | function | Set indentation level | |
PrettyPrinterAbstract::staticDereferenceLhsRequiresParens | protected | function | Determines whether the LHS of a static operation must be wrapped in parentheses. | |
PrettyPrinterAbstract::__construct | public | function | Creates a pretty printer instance using the given options. | |
Standard::containsEndLabel | protected | function | ||
Standard::encapsedContainsEndLabel | protected | function | ||
Standard::escapeString | protected | function | ||
Standard::hasNodeWithComments | protected | function | ||
Standard::indentString | private | function | ||
Standard::pArg | protected | function | ||
Standard::pArrayItem | protected | function | ||
Standard::pAttrGroups | protected | function | ||
Standard::pAttribute | protected | function | ||
Standard::pAttributeGroup | protected | function | ||
Standard::pCallLhs | protected | function | ||
Standard::pClassCommon | protected | function | ||
Standard::pClosureUse | protected | function | ||
Standard::pConst | protected | function | ||
Standard::pDeclareItem | protected | function | ||
Standard::pDereferenceLhs | protected | function | ||
Standard::pEncapsList | protected | function | ||
Standard::pExpr_Array | protected | function | ||
Standard::pExpr_ArrayDimFetch | protected | function | ||
Standard::pExpr_ArrowFunction | protected | function | ||
Standard::pExpr_Assign | protected | function | ||
Standard::pExpr_AssignOp_BitwiseAnd | protected | function | ||
Standard::pExpr_AssignOp_BitwiseOr | protected | function | ||
Standard::pExpr_AssignOp_BitwiseXor | protected | function | ||
Standard::pExpr_AssignOp_Coalesce | protected | function | ||
Standard::pExpr_AssignOp_Concat | protected | function | ||
Standard::pExpr_AssignOp_Div | protected | function | ||
Standard::pExpr_AssignOp_Minus | protected | function | ||
Standard::pExpr_AssignOp_Mod | protected | function | ||
Standard::pExpr_AssignOp_Mul | protected | function | ||
Standard::pExpr_AssignOp_Plus | protected | function | ||
Standard::pExpr_AssignOp_Pow | protected | function | ||
Standard::pExpr_AssignOp_ShiftLeft | protected | function | ||
Standard::pExpr_AssignOp_ShiftRight | protected | function | ||
Standard::pExpr_AssignRef | protected | function | ||
Standard::pExpr_BinaryOp_BitwiseAnd | protected | function | ||
Standard::pExpr_BinaryOp_BitwiseOr | protected | function | ||
Standard::pExpr_BinaryOp_BitwiseXor | protected | function | ||
Standard::pExpr_BinaryOp_BooleanAnd | protected | function | ||
Standard::pExpr_BinaryOp_BooleanOr | protected | function | ||
Standard::pExpr_BinaryOp_Coalesce | protected | function | ||
Standard::pExpr_BinaryOp_Concat | protected | function | ||
Standard::pExpr_BinaryOp_Div | protected | function | ||
Standard::pExpr_BinaryOp_Equal | protected | function | ||
Standard::pExpr_BinaryOp_Greater | protected | function | ||
Standard::pExpr_BinaryOp_GreaterOrEqual | protected | function | ||
Standard::pExpr_BinaryOp_Identical | protected | function | ||
Standard::pExpr_BinaryOp_LogicalAnd | protected | function | ||
Standard::pExpr_BinaryOp_LogicalOr | protected | function | ||
Standard::pExpr_BinaryOp_LogicalXor | protected | function | ||
Standard::pExpr_BinaryOp_Minus | protected | function | ||
Standard::pExpr_BinaryOp_Mod | protected | function | ||
Standard::pExpr_BinaryOp_Mul | protected | function | ||
Standard::pExpr_BinaryOp_NotEqual | protected | function | ||
Standard::pExpr_BinaryOp_NotIdentical | protected | function | ||
Standard::pExpr_BinaryOp_Plus | protected | function | ||
Standard::pExpr_BinaryOp_Pow | protected | function | ||
Standard::pExpr_BinaryOp_ShiftLeft | protected | function | ||
Standard::pExpr_BinaryOp_ShiftRight | protected | function | ||
Standard::pExpr_BinaryOp_Smaller | protected | function | ||
Standard::pExpr_BinaryOp_SmallerOrEqual | protected | function | ||
Standard::pExpr_BinaryOp_Spaceship | protected | function | ||
Standard::pExpr_BitwiseNot | protected | function | ||
Standard::pExpr_BooleanNot | protected | function | ||
Standard::pExpr_Cast_Array | protected | function | ||
Standard::pExpr_Cast_Bool | protected | function | ||
Standard::pExpr_Cast_Double | protected | function | ||
Standard::pExpr_Cast_Int | protected | function | ||
Standard::pExpr_Cast_Object | protected | function | ||
Standard::pExpr_Cast_String | protected | function | ||
Standard::pExpr_Cast_Unset | protected | function | ||
Standard::pExpr_ClassConstFetch | protected | function | ||
Standard::pExpr_Clone | protected | function | ||
Standard::pExpr_Closure | protected | function | ||
Standard::pExpr_ConstFetch | protected | function | ||
Standard::pExpr_Empty | protected | function | ||
Standard::pExpr_Error | protected | function | ||
Standard::pExpr_ErrorSuppress | protected | function | ||
Standard::pExpr_Eval | protected | function | ||
Standard::pExpr_Exit | protected | function | ||
Standard::pExpr_FuncCall | protected | function | ||
Standard::pExpr_Include | protected | function | ||
Standard::pExpr_Instanceof | protected | function | ||
Standard::pExpr_Isset | protected | function | ||
Standard::pExpr_List | protected | function | ||
Standard::pExpr_Match | protected | function | ||
Standard::pExpr_MethodCall | protected | function | ||
Standard::pExpr_New | protected | function | ||
Standard::pExpr_NullsafeMethodCall | protected | function | ||
Standard::pExpr_NullsafePropertyFetch | protected | function | ||
Standard::pExpr_PostDec | protected | function | ||
Standard::pExpr_PostInc | protected | function | ||
Standard::pExpr_PreDec | protected | function | ||
Standard::pExpr_PreInc | protected | function | ||
Standard::pExpr_Print | protected | function | ||
Standard::pExpr_PropertyFetch | protected | function | ||
Standard::pExpr_ShellExec | protected | function | ||
Standard::pExpr_StaticCall | protected | function | ||
Standard::pExpr_StaticPropertyFetch | protected | function | ||
Standard::pExpr_Ternary | protected | function | ||
Standard::pExpr_Throw | protected | function | ||
Standard::pExpr_UnaryMinus | protected | function | ||
Standard::pExpr_UnaryPlus | protected | function | ||
Standard::pExpr_Variable | protected | function | ||
Standard::pExpr_Yield | protected | function | ||
Standard::pExpr_YieldFrom | protected | function | ||
Standard::pIdentifier | protected | function | ||
Standard::pIntersectionType | protected | function | ||
Standard::pKey | protected | function | ||
Standard::pMatchArm | protected | function | ||
Standard::pMaybeMultiline | protected | function | ||
Standard::pName | protected | function | ||
Standard::pName_FullyQualified | protected | function | ||
Standard::pName_Relative | protected | function | ||
Standard::pNewOperand | protected | function | ||
Standard::pNullableType | protected | function | ||
Standard::pObjectProperty | protected | function | ||
Standard::pParam | protected | function | ||
Standard::pPropertyHook | protected | function | ||
Standard::pPropertyItem | protected | function | ||
Standard::pScalar_Float | protected | function | ||
Standard::pScalar_Int | protected | function | ||
Standard::pScalar_InterpolatedString | protected | function | ||
Standard::pScalar_MagicConst_Class | protected | function | ||
Standard::pScalar_MagicConst_Dir | protected | function | ||
Standard::pScalar_MagicConst_File | protected | function | ||
Standard::pScalar_MagicConst_Function | protected | function | ||
Standard::pScalar_MagicConst_Line | protected | function | ||
Standard::pScalar_MagicConst_Method | protected | function | ||
Standard::pScalar_MagicConst_Namespace | protected | function | ||
Standard::pScalar_MagicConst_Property | protected | function | ||
Standard::pScalar_MagicConst_Trait | protected | function | ||
Standard::pScalar_String | protected | function | ||
Standard::pSingleQuotedString | protected | function | ||
Standard::pStaticDereferenceLhs | protected | function | ||
Standard::pStaticVar | protected | function | ||
Standard::pStmt_Block | protected | function | ||
Standard::pStmt_Break | protected | function | ||
Standard::pStmt_Case | protected | function | ||
Standard::pStmt_Catch | protected | function | ||
Standard::pStmt_Class | protected | function | ||
Standard::pStmt_ClassConst | protected | function | ||
Standard::pStmt_ClassMethod | protected | function | ||
Standard::pStmt_Const | protected | function | ||
Standard::pStmt_Continue | protected | function | ||
Standard::pStmt_Declare | protected | function | ||
Standard::pStmt_Do | protected | function | ||
Standard::pStmt_Echo | protected | function | ||
Standard::pStmt_Else | protected | function | ||
Standard::pStmt_ElseIf | protected | function | ||
Standard::pStmt_Enum | protected | function | ||
Standard::pStmt_EnumCase | protected | function | ||
Standard::pStmt_Expression | protected | function | ||
Standard::pStmt_Finally | protected | function | ||
Standard::pStmt_For | protected | function | ||
Standard::pStmt_Foreach | protected | function | ||
Standard::pStmt_Function | protected | function | ||
Standard::pStmt_Global | protected | function | ||
Standard::pStmt_Goto | protected | function | ||
Standard::pStmt_GroupUse | protected | function | ||
Standard::pStmt_HaltCompiler | protected | function | ||
Standard::pStmt_If | protected | function | ||
Standard::pStmt_InlineHTML | protected | function | ||
Standard::pStmt_Interface | protected | function | ||
Standard::pStmt_Label | protected | function | ||
Standard::pStmt_Namespace | protected | function | ||
Standard::pStmt_Nop | protected | function | ||
Standard::pStmt_Property | protected | function | ||
Standard::pStmt_Return | protected | function | ||
Standard::pStmt_Static | protected | function | ||
Standard::pStmt_Switch | protected | function | ||
Standard::pStmt_Trait | protected | function | ||
Standard::pStmt_TraitUse | protected | function | ||
Standard::pStmt_TraitUseAdaptation_Alias | protected | function | ||
Standard::pStmt_TraitUseAdaptation_Precedence | protected | function | ||
Standard::pStmt_TryCatch | protected | function | ||
Standard::pStmt_Unset | protected | function | ||
Standard::pStmt_Use | protected | function | ||
Standard::pStmt_While | protected | function | ||
Standard::pUnionType | protected | function | ||
Standard::pUseItem | protected | function | ||
Standard::pUseType | protected | function | ||
Standard::pVariadicPlaceholder | protected | function | ||
Standard::pVarLikeIdentifier | protected | function |