feature #33269 [TwigBridge] Mark all classes extending twig as @Final (fabpot)

fabpot · fabpot · commit 451daa0b0685 · 2019-08-21T10:34:41.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [TwigBridge] Mark all classes extending twig as @Final | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | yes-ish | New feature? | no  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | refs #33039 | License | MIT | Doc PR | n/a Classes defining extensions/nodes/node visitors/token parsers should not be changed. They should be final. That would also help with Twig 3.0 which introduces type hints (including return types). Commits ------- d657459 [TwigBridge] Mark all classes extending twig as @Final
diff --git a/src/Symfony/Bridge/Twig/CHANGELOG.md b/src/Symfony/Bridge/Twig/CHANGELOG.md
@@ -4,6 +4,7 @@ CHANGELOG
 4.4.0
 -----
 
+ * marked all classes extending twig as `@final`
  * deprecated to pass `$rootDir` and `$fileLinkFormatter` as 5th and 6th argument respectively to the 
    `DebugCommand::__construct()` method, swap the variables position.
 
diff --git a/src/Symfony/Bridge/Twig/Extension/AssetExtension.php b/src/Symfony/Bridge/Twig/Extension/AssetExtension.php
@@ -19,6 +19,8 @@
  * Twig extension for the Symfony Asset component.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class AssetExtension extends AbstractExtension
 {
diff --git a/src/Symfony/Bridge/Twig/Extension/CodeExtension.php b/src/Symfony/Bridge/Twig/Extension/CodeExtension.php
@@ -19,6 +19,8 @@
  * Twig extension relate to PHP code and used by the profiler and the default exception templates.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class CodeExtension extends AbstractExtension
 {
diff --git a/src/Symfony/Bridge/Twig/Extension/CsrfExtension.php b/src/Symfony/Bridge/Twig/Extension/CsrfExtension.php
@@ -17,6 +17,8 @@
 /**
  * @author Christian Flothmann <christian.flothmann@sensiolabs.de>
  * @author Titouan Galopin <galopintitouan@gmail.com>
+ *
+ * @final since Symfony 4.4
  */
 class CsrfExtension extends AbstractExtension
 {
diff --git a/src/Symfony/Bridge/Twig/Extension/CsrfRuntime.php b/src/Symfony/Bridge/Twig/Extension/CsrfRuntime.php
@@ -16,6 +16,8 @@
 /**
  * @author Christian Flothmann <christian.flothmann@sensiolabs.de>
  * @author Titouan Galopin <galopintitouan@gmail.com>
+ *
+ * @final since Symfony 4.4
  */
 class CsrfRuntime
 {
diff --git a/src/Symfony/Bridge/Twig/Extension/DumpExtension.php b/src/Symfony/Bridge/Twig/Extension/DumpExtension.php
@@ -24,6 +24,8 @@
  * Provides integration of the dump() function with Twig.
  *
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @final since Symfony 4.4
  */
 class DumpExtension extends AbstractExtension
 {
diff --git a/src/Symfony/Bridge/Twig/Extension/ExpressionExtension.php b/src/Symfony/Bridge/Twig/Extension/ExpressionExtension.php
@@ -19,6 +19,8 @@
  * ExpressionExtension gives a way to create Expressions from a template.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class ExpressionExtension extends AbstractExtension
 {
diff --git a/src/Symfony/Bridge/Twig/Extension/FormExtension.php b/src/Symfony/Bridge/Twig/Extension/FormExtension.php
@@ -25,6 +25,8 @@
  *
  * @author Fabien Potencier <fabien@symfony.com>
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @final since Symfony 4.4
  */
 class FormExtension extends AbstractExtension
 {
diff --git a/src/Symfony/Bridge/Twig/Extension/HttpFoundationExtension.php b/src/Symfony/Bridge/Twig/Extension/HttpFoundationExtension.php
@@ -22,6 +22,8 @@
  * Twig extension for the Symfony HttpFoundation component.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class HttpFoundationExtension extends AbstractExtension
 {
diff --git a/src/Symfony/Bridge/Twig/Extension/HttpKernelExtension.php b/src/Symfony/Bridge/Twig/Extension/HttpKernelExtension.php
@@ -19,6 +19,8 @@
  * Provides integration with the HttpKernel component.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class HttpKernelExtension extends AbstractExtension
 {
diff --git a/src/Symfony/Bridge/Twig/Extension/HttpKernelRuntime.php b/src/Symfony/Bridge/Twig/Extension/HttpKernelRuntime.php
@@ -18,6 +18,8 @@
  * Provides integration with the HttpKernel component.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class HttpKernelRuntime
 {
diff --git a/src/Symfony/Bridge/Twig/Extension/LogoutUrlExtension.php b/src/Symfony/Bridge/Twig/Extension/LogoutUrlExtension.php
@@ -19,6 +19,8 @@
  * LogoutUrlHelper provides generator functions for the logout URL to Twig.
  *
  * @author Jeremy Mikola <jmikola@gmail.com>
+ *
+ * @final since Symfony 4.4
  */
 class LogoutUrlExtension extends AbstractExtension
 {
diff --git a/src/Symfony/Bridge/Twig/Extension/ProfilerExtension.php b/src/Symfony/Bridge/Twig/Extension/ProfilerExtension.php
@@ -17,6 +17,8 @@
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class ProfilerExtension extends BaseProfilerExtension
 {
diff --git a/src/Symfony/Bridge/Twig/Extension/RoutingExtension.php b/src/Symfony/Bridge/Twig/Extension/RoutingExtension.php
@@ -22,6 +22,8 @@
  * Provides integration of the Routing component with Twig.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class RoutingExtension extends AbstractExtension
 {
diff --git a/src/Symfony/Bridge/Twig/Extension/SecurityExtension.php b/src/Symfony/Bridge/Twig/Extension/SecurityExtension.php
@@ -21,6 +21,8 @@
  * SecurityExtension exposes security context features.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class SecurityExtension extends AbstractExtension
 {
diff --git a/src/Symfony/Bridge/Twig/Extension/StopwatchExtension.php b/src/Symfony/Bridge/Twig/Extension/StopwatchExtension.php
@@ -20,6 +20,8 @@
  * Twig extension for the stopwatch helper.
  *
  * @author Wouter J <wouter@wouterj.nl>
+ *
+ * @final since Symfony 4.4
  */
 class StopwatchExtension extends AbstractExtension
 {
diff --git a/src/Symfony/Bridge/Twig/Extension/WebLinkExtension.php b/src/Symfony/Bridge/Twig/Extension/WebLinkExtension.php
@@ -21,6 +21,8 @@
  * Twig extension for the Symfony WebLink component.
  *
  * @author Kévin Dunglas <dunglas@gmail.com>
+ *
+ * @final since Symfony 4.4
  */
 class WebLinkExtension extends AbstractExtension
 {
diff --git a/src/Symfony/Bridge/Twig/Extension/WorkflowExtension.php b/src/Symfony/Bridge/Twig/Extension/WorkflowExtension.php
@@ -21,6 +21,8 @@
  * WorkflowExtension.
  *
  * @author Grégoire Pineau <lyrixx@lyrixx.info>
+ *
+ * @final since Symfony 4.4
  */
 class WorkflowExtension extends AbstractExtension
 {
diff --git a/src/Symfony/Bridge/Twig/Extension/YamlExtension.php b/src/Symfony/Bridge/Twig/Extension/YamlExtension.php
@@ -20,6 +20,8 @@
  * Provides integration of the Yaml component with Twig.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class YamlExtension extends AbstractExtension
 {
diff --git a/src/Symfony/Bridge/Twig/Node/DumpNode.php b/src/Symfony/Bridge/Twig/Node/DumpNode.php
@@ -16,6 +16,8 @@
 
 /**
  * @author Julien Galenski <julien.galenski@gmail.com>
+ *
+ * @final since Symfony 4.4
  */
 class DumpNode extends Node
 {
diff --git a/src/Symfony/Bridge/Twig/Node/FormThemeNode.php b/src/Symfony/Bridge/Twig/Node/FormThemeNode.php
@@ -17,6 +17,8 @@
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class FormThemeNode extends Node
 {
diff --git a/src/Symfony/Bridge/Twig/Node/RenderBlockNode.php b/src/Symfony/Bridge/Twig/Node/RenderBlockNode.php
@@ -21,6 +21,8 @@
  * is "foo", the block "foo" will be rendered.
  *
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @final since Symfony 4.4
  */
 class RenderBlockNode extends FunctionExpression
 {
diff --git a/src/Symfony/Bridge/Twig/Node/SearchAndRenderBlockNode.php b/src/Symfony/Bridge/Twig/Node/SearchAndRenderBlockNode.php
@@ -18,6 +18,8 @@
 
 /**
  * @author Bernhard Schussek <bschussek@gmail.com>
+ *
+ * @final since Symfony 4.4
  */
 class SearchAndRenderBlockNode extends FunctionExpression
 {
diff --git a/src/Symfony/Bridge/Twig/Node/StopwatchNode.php b/src/Symfony/Bridge/Twig/Node/StopwatchNode.php
@@ -19,6 +19,8 @@
  * Represents a stopwatch node.
  *
  * @author Wouter J <wouter@wouterj.nl>
+ *
+ * @final since Symfony 4.4
  */
 class StopwatchNode extends Node
 {
diff --git a/src/Symfony/Bridge/Twig/Node/TransDefaultDomainNode.php b/src/Symfony/Bridge/Twig/Node/TransDefaultDomainNode.php
@@ -17,6 +17,8 @@
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class TransDefaultDomainNode extends Node
 {
diff --git a/src/Symfony/Bridge/Twig/Node/TransNode.php b/src/Symfony/Bridge/Twig/Node/TransNode.php
@@ -24,6 +24,8 @@ class_exists('Twig\Node\Expression\ArrayExpression');
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class TransNode extends Node
 {
diff --git a/src/Symfony/Bridge/Twig/NodeVisitor/TranslationDefaultDomainNodeVisitor.php b/src/Symfony/Bridge/Twig/NodeVisitor/TranslationDefaultDomainNodeVisitor.php
@@ -27,6 +27,8 @@
 
 /**
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class TranslationDefaultDomainNodeVisitor extends AbstractNodeVisitor
 {
diff --git a/src/Symfony/Bridge/Twig/NodeVisitor/TranslationNodeVisitor.php b/src/Symfony/Bridge/Twig/NodeVisitor/TranslationNodeVisitor.php
@@ -22,6 +22,8 @@
  * TranslationNodeVisitor extracts translation messages.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class TranslationNodeVisitor extends AbstractNodeVisitor
 {
diff --git a/src/Symfony/Bridge/Twig/TokenParser/DumpTokenParser.php b/src/Symfony/Bridge/Twig/TokenParser/DumpTokenParser.php
@@ -26,6 +26,8 @@
  *     {% dump foo, bar %}
  *
  * @author Julien Galenski <julien.galenski@gmail.com>
+ *
+ * @final since Symfony 4.4
  */
 class DumpTokenParser extends AbstractTokenParser
 {
diff --git a/src/Symfony/Bridge/Twig/TokenParser/FormThemeTokenParser.php b/src/Symfony/Bridge/Twig/TokenParser/FormThemeTokenParser.php
@@ -21,6 +21,8 @@
  * Token Parser for the 'form_theme' tag.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class FormThemeTokenParser extends AbstractTokenParser
 {
diff --git a/src/Symfony/Bridge/Twig/TokenParser/StopwatchTokenParser.php b/src/Symfony/Bridge/Twig/TokenParser/StopwatchTokenParser.php
@@ -21,6 +21,8 @@
  * Token Parser for the stopwatch tag.
  *
  * @author Wouter J <wouter@wouterj.nl>
+ *
+ * @final since Symfony 4.4
  */
 class StopwatchTokenParser extends AbstractTokenParser
 {
diff --git a/src/Symfony/Bridge/Twig/TokenParser/TransChoiceTokenParser.php b/src/Symfony/Bridge/Twig/TokenParser/TransChoiceTokenParser.php
@@ -18,15 +18,18 @@
 use Twig\Node\Node;
 use Twig\Node\TextNode;
 use Twig\Token;
+use Twig\TokenParser\AbstractTokenParser;
 
 /**
  * Token Parser for the 'transchoice' tag.
  *
  * @author Fabien Potencier <fabien@symfony.com>
  *
  * @deprecated since Symfony 4.2, use the "trans" tag with a "%count%" parameter instead
+ *
+ * @final since Symfony 4.4
  */
-class TransChoiceTokenParser extends TransTokenParser
+class TransChoiceTokenParser extends AbstractTokenParser
 {
     /**
      * {@inheritdoc}
diff --git a/src/Symfony/Bridge/Twig/TokenParser/TransDefaultDomainTokenParser.php b/src/Symfony/Bridge/Twig/TokenParser/TransDefaultDomainTokenParser.php
@@ -20,6 +20,8 @@
  * Token Parser for the 'trans_default_domain' tag.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class TransDefaultDomainTokenParser extends AbstractTokenParser
 {
diff --git a/src/Symfony/Bridge/Twig/TokenParser/TransTokenParser.php b/src/Symfony/Bridge/Twig/TokenParser/TransTokenParser.php
@@ -24,6 +24,8 @@
  * Token Parser for the 'trans' tag.
  *
  * @author Fabien Potencier <fabien@symfony.com>
+ *
+ * @final since Symfony 4.4
  */
 class TransTokenParser extends AbstractTokenParser
 {

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,8 @@`
`19`	`19`	`* Twig extension for the Symfony Asset component.`
`20`	`20`	`*`
`21`	`21`	`* @author Fabien Potencier <fabien@symfony.com>`
	`22`	`+ *`
	`23`	`+ * @final since Symfony 4.4`
`22`	`24`	`*/`
`23`	`25`	`class AssetExtension extends AbstractExtension`
`24`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,8 @@`
`17`	`17`	`/**`
`18`	`18`	`* @author Christian Flothmann <christian.flothmann@sensiolabs.de>`
`19`	`19`	`* @author Titouan Galopin <galopintitouan@gmail.com>`
	`20`	`+ *`
	`21`	`+ * @final since Symfony 4.4`
`20`	`22`	`*/`
`21`	`23`	`class CsrfExtension extends AbstractExtension`
`22`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,8 @@`
`16`	`16`	`/**`
`17`	`17`	`* @author Christian Flothmann <christian.flothmann@sensiolabs.de>`
`18`	`18`	`* @author Titouan Galopin <galopintitouan@gmail.com>`
	`19`	`+ *`
	`20`	`+ * @final since Symfony 4.4`
`19`	`21`	`*/`
`20`	`22`	`class CsrfRuntime`
`21`	`23`	`{`
Original file line number	Diff line number	Diff line change
`@@ -24,6 +24,8 @@`
`24`	`24`	`* Provides integration of the dump() function with Twig.`
`25`	`25`	`*`
`26`	`26`	`* @author Nicolas Grekas <p@tchwork.com>`
	`27`	`+ *`
	`28`	`+ * @final since Symfony 4.4`
`27`	`29`	`*/`
`28`	`30`	`class DumpExtension extends AbstractExtension`
`29`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,6 +25,8 @@`
`25`	`25`	`*`
`26`	`26`	`* @author Fabien Potencier <fabien@symfony.com>`
`27`	`27`	`* @author Bernhard Schussek <bschussek@gmail.com>`
	`28`	`+ *`
	`29`	`+ * @final since Symfony 4.4`
`28`	`30`	`*/`
`29`	`31`	`class FormExtension extends AbstractExtension`
`30`	`32`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,8 @@`
`22`	`22`	`* Twig extension for the Symfony HttpFoundation component.`
`23`	`23`	`*`
`24`	`24`	`* @author Fabien Potencier <fabien@symfony.com>`
	`25`	`+ *`
	`26`	`+ * @final since Symfony 4.4`
`25`	`27`	`*/`
`26`	`28`	`class HttpFoundationExtension extends AbstractExtension`
`27`	`29`	`{`