Add return type annotations on Twig 3 to prepare Twig 4 #4534

smnandre · 2025-01-05T19:08:27Z

Started to add missing type annotation following @stof comment here.

Update: I checked here every class (but one) in the src directory.

But you should ~~probably~~ certainely have another look.

Remains:

src/ExpressionParser.php, where i'm not confident enough about the best return types (AbstractExpression|null works almost everytime, but lack some precision)
extra directory
tests directory

I'm happy to let them to someone else.... this was less fun than I expected 😅

# Conflicts: # src/Node/ModuleNode.php

SandboxExtension Add return type on public methods

…` on tests

smnandre · 2025-01-05T22:49:12Z

(fabbot unrelated)

smnandre · 2025-01-07T02:23:35Z

(fixed my mistakes, all seems ok now)

stof · 2025-01-07T08:39:50Z

src/AbstractTwigCallable.php

@@ -79,6 +79,9 @@ public function getDynamicName(): string
        return $this->dynamicName;
    }

+    /**
+     * @return callable


This is wrong. The callable of a AbstractTwigCallable might not be a PHP callable, due to the case of Twig runtimes.

See the constructor parameter type (on child classes, as it is missing on the constructor of that class currently)

stof · 2025-01-07T08:41:38Z

src/Extension/SandboxExtension.php

@@ -117,6 +120,13 @@ public function checkPropertyAllowed($obj, $property, int $lineno = -1, ?Source
        }
    }

+    /**
+     * @param array|object $obj


This function actually supports mixed as input (and as output)

stof · 2025-01-07T08:42:55Z

src/Extension/SandboxExtension.php

@@ -72,6 +72,9 @@ private function isSourceSandboxed(?Source $source): bool
        return $this->sourcePolicy->enableSandbox($source);
    }

+    /**
+     * @return void


As this class is final, the return type can be added as a native one directly.

stof · 2025-01-07T08:43:59Z

src/Markup.php

@@ -27,6 +27,9 @@ public function __construct($content, $charset)
        $this->charset = $charset;
    }

+    /**
+     * @return string


this type can be added directly (__toString is special in PHP and has an implicit string return type)

stof · 2025-01-07T08:46:47Z

src/NodeVisitor/EscaperNodeVisitor.php

@@ -157,7 +157,7 @@ private function isSafeFor(string $type, AbstractExpression $expression, Environ
        return \in_array($type, $safe) || \in_array('all', $safe);
    }

-    private function needEscaping()
+    private function needEscaping(): string|bool


string|false actually. true is not a valid strategy.

"true" will wait Twig4 / PHP 8.2 no ?

stof · 2025-01-07T08:47:23Z

src/Sandbox/SecurityNotAllowedMethodError.php

@@ -33,6 +33,9 @@ public function getClassName(): string
        return $this->className;
    }

+    /**
+     * @return string


Can be a native one as the class is final

stof · 2025-01-07T08:49:30Z

src/Token.php

@@ -80,6 +80,9 @@ public function getType(): int
        return $this->type;
    }

+    /**
+     * @return string|int|float|bool|null


This is wrong if the constructor does not have a parameter type restricting the type of the value.

stof · 2025-01-07T08:51:33Z

src/Parser.php

@@ -307,6 +313,9 @@ public function addImportedSymbol(string $type, string $alias, ?string $name = n
        $this->importedSymbols[0][$type][$alias] = ['name' => $name, 'node' => $internalRef];
    }

+    /**
+     * @return string|null


This is wrong. It returns array{name: string, node: AssignTemplateVariable|null}

…able|null}|null)

…tring}|null)

smnandre · 2025-01-08T08:43:12Z

Thank you very much @stof! (and sorry i make that many mistakes 😮‍💨 )

I've fixed all your comments

smnandre added 22 commits January 5, 2025 20:07

Add return types in src/Node

a558f9d

# Conflicts: # src/Node/ModuleNode.php

EscapeNodeVisitor + Missing return on private

845a319

BlackfireDumper: return type on private methods

dfd57f8

EscaperRuntime: add "@return void" on public setters

e142e9a

Sandbox errors: add "@return string" on public getters

42e4c5a

Sansbox erros: add type for private strings properties

1814b5c

CS fixes

6066161

EscaperExtension Add "@return void" annotation on public methods

27b8970

SandboxExtension Add return type on public methods

IntegrationTestCase Add "@return": iterable on dataproviders, `void…

a2cc09e

…` on tests

NodeTestCase Add "@return" annotations

f1fc4f4

IncludeTokenParser: add "@return array{...}" on parseArguments method

8cd9fbc

ReflectionCallable: add "@return callable" on getCallable method

0e7159e

AbstractTwigCallable: add "@return callable" on getCallable method

5c48db3

Environment: add 21 "@return void" on public adders or setters

057a45f

ExtensionSet: add "@return void" on public method

a92ed43

Lexer: add "void" return type on private method

760ab30

Markup: add "@return string" on __toString method

815eedc

Parser: add "@return" annotations on public methods

af09f0f

TemplateWrapper: add "@return void" on display and displayBlock methods

36dcada

Token: add return type string|int|float|bool|null on getValue

69b6e11

TokenStream: add "@return void" on public method

ab4510a

CS - unwanted spaces

bd18477

Fix wrong return type cast strategy into "1"

5e8f8cb

stof reviewed Jan 7, 2025

View reviewed changes

smnandre added 4 commits January 8, 2025 09:34

Add return types on __toString

c835bbb

Add "@return bool|false" annotation

786f7d2

Token: fix return type (mixed)

0839327

Parser: fix return type (array{name: string, node: AssignTemplateVari…

1c99dc7

…able|null}|null)

smnandre added 2 commits January 8, 2025 09:39

AbstractTwigCallable: fix return type (callable|array{class-string, s…

2325d56

…tring}|null)

Security...Error: set return type (final class)

de4dc5e

smnandre requested a review from stof January 10, 2025 01:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add return type annotations on Twig 3 to prepare Twig 4 #4534

Add return type annotations on Twig 3 to prepare Twig 4 #4534

smnandre commented Jan 5, 2025 •

edited

Loading

smnandre commented Jan 5, 2025

smnandre commented Jan 7, 2025

stof Jan 7, 2025

stof Jan 7, 2025

stof Jan 7, 2025

stof Jan 7, 2025

stof Jan 7, 2025

smnandre Jan 8, 2025

stof Jan 7, 2025

stof Jan 7, 2025

stof Jan 7, 2025

smnandre commented Jan 8, 2025

Add return type annotations on Twig 3 to prepare Twig 4 #4534

Are you sure you want to change the base?

Add return type annotations on Twig 3 to prepare Twig 4 #4534

Conversation

smnandre commented Jan 5, 2025 • edited Loading

smnandre commented Jan 5, 2025

smnandre commented Jan 7, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smnandre commented Jan 8, 2025

smnandre commented Jan 5, 2025 •

edited

Loading