[Bridge\Twig] Trigger deprecation when using FormExtension::$renderer #20769
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 |
|---|---|---|
|
|
@@ -13,6 +13,7 @@ | |
|
|
||
| use Symfony\Bridge\Twig\TokenParser\FormThemeTokenParser; | ||
| use Symfony\Bridge\Twig\Form\TwigRendererInterface; | ||
| use Symfony\Component\DependencyInjection\ContainerInterface; | ||
| use Symfony\Component\Form\ChoiceList\View\ChoiceView; | ||
|
|
||
| /** | ||
|
|
@@ -23,12 +24,17 @@ | |
| */ | ||
| class FormExtension extends \Twig_Extension implements \Twig_Extension_InitRuntimeInterface | ||
| { | ||
| /** | ||
| * @deprecated since version 3.2, to be removed in 4.0 alongside with magic methods below | ||
| */ | ||
| private $renderer; | ||
|
|
||
| public function __construct($renderer = null) | ||
| { | ||
| if ($this->renderer instanceof TwigRendererInterface) { | ||
| @trigger_error(sprintf('Passing a Twig Form Renderer to the "%s" constructor is deprecated since version 3.2 and won\'t be possible in 4.0. Pass the Twig_Environment to the TwigRendererEngine constructor instead.', static::class), E_USER_DEPRECATED); | ||
| } elseif (null !== $renderer && !(is_array($renderer) && isset($renderer[0], $renderer[1]) && $renderer[0] instanceof ContainerInterface)) { | ||
| throw new \InvalidArgumentException(sprintf('Passing any arguments the constructor of %s is reserved for internal use.', __CLASS__)); | ||
| } | ||
| $this->renderer = $renderer; | ||
| } | ||
|
|
@@ -40,8 +46,10 @@ public function __construct(TwigRendererInterface $renderer = null) | |
| */ | ||
| public function initRuntime(\Twig_Environment $environment) | ||
| { | ||
| if ($this->renderer instanceof TwigRendererInterface) { | ||
| $this->renderer->setEnvironment($environment); | ||
| } elseif (null !== $this->renderer) { | ||
| $this->renderer[2] = $environment; | ||
| } | ||
| } | ||
|
|
||
|
|
@@ -94,6 +102,62 @@ public function getTests() | |
| ); | ||
| } | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
| public function __get($name) | ||
| { | ||
| if ('renderer' === $name) { | ||
|
There was a problem hiding this comment. we should throw an exception for any other name There was a problem hiding this comment. no no no, see #20769 (comment) |
||
| @trigger_error(sprintf('Using the "%s::$renderer" property is deprecated since version 3.2 as it will be removed in 4.0.', __CLASS__), E_USER_DEPRECATED); | ||
|
|
||
| if (is_array($this->renderer)) { | ||
| $renderer = $this->renderer[0]->get($this->renderer[1]); | ||
| if (isset($this->renderer[2])) { | ||
| $renderer->setEnvironment($this->renderer[2]); | ||
| } | ||
| $this->renderer = $renderer; | ||
| } | ||
| } | ||
|
|
||
| return $this->$name; | ||
| } | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
| public function __set($name, $value) | ||
| { | ||
| if ('renderer' === $name) { | ||
|
There was a problem hiding this comment. we should throw an exception for any other name |
||
| @trigger_error(sprintf('Using the "%s::$renderer" property is deprecated since version 3.2 as it will be removed in 4.0.', __CLASS__), E_USER_DEPRECATED); | ||
| } | ||
|
|
||
| $this->$name = $value; | ||
| } | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
| public function __isset($name) | ||
| { | ||
| if ('renderer' === $name) { | ||
| @trigger_error(sprintf('Using the "%s::$renderer" property is deprecated since version 3.2 as it will be removed in 4.0.', __CLASS__), E_USER_DEPRECATED); | ||
| } | ||
|
|
||
| return isset($this->$name); | ||
| } | ||
|
|
||
| /** | ||
| * @internal | ||
| */ | ||
| public function __unset($name) | ||
| { | ||
| if ('renderer' === $name) { | ||
|
|
||
| @trigger_error(sprintf('Using the "%s::$renderer" property is deprecated since version 3.2 as it will be removed in 4.0.', __CLASS__), E_USER_DEPRECATED); | ||
| } | ||
|
|
||
| unset($this->$name); | ||
| } | ||
|
|
||
| /** | ||
| * {@inheritdoc} | ||
| */ | ||
|
|
||
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
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.
Should we initialize renderer here?
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.
done (in a lazy way again)