Skip to content

[WebProfilerBundle] Deprecating templateExists method #32462

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 9, 2019
Merged

[WebProfilerBundle] Deprecating templateExists method #32462

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions UPGRADE-4.4.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -137,3 +137,9 @@ Validator
when the `min` option is used.
Set it to `true` to keep the current behavior and `false` to reject empty strings.
In 5.0, it'll become optional and will default to `false`.

WebProfilerBundle
-----------------

* Deprecated the `ExceptionController::templateExists()` method
* Deprecated the `TemplateManager::templateExists()` method
6 changes: 6 additions & 0 deletions UPGRADE-5.0.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -477,6 +477,12 @@ Validator
* The `egulias/email-validator` component is now required for using the `Email` constraint in strict mode
* The `symfony/expression-language` component is now required for using the `Expression` constraint

WebProfilerBundle
-----------------

* Removed the `ExceptionController::templateExists()` method
* Removed the `TemplateManager::templateExists()` method

Workflow
--------

Expand Down
4 changes: 3 additions & 1 deletion src/Symfony/Bundle/WebProfilerBundle/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ CHANGELOG
4.4.0
-----

* Added button to clear the ajax request tab
* Added button to clear the ajax request tab
* Deprecated the `ExceptionController::templateExists()` method
* Deprecated the `TemplateManager::templateExists()` method

4.3.0
-----
Expand Down
12 changes: 9 additions & 3 deletions src/Symfony/Bundle/WebProfilerBundle/Controller/ExceptionController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ public function cssAction($token)

$template = $this->getTemplate();

if (!$this->templateExists($template)) {
if (!$this->templateExists($template, false)) {
return new Response($this->errorRenderer->getStylesheet(), 200, ['Content-Type' => 'text/css']);
}

Expand All @@ -113,9 +113,15 @@ protected function getTemplate()
return '@Twig/Exception/'.($this->debug ? 'exception' : 'error').'.html.twig';
}

// to be removed when the minimum required version of Twig is >= 2.0
protected function templateExists($template)
/**
* @deprecated since Symfony 4.4
*/
protected function templateExists($template/*, bool $triggerDeprecation = true */)
{
if (1 === \func_num_args()) {
@trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.4, use the "exists()" method of the Twig loader instead.', __METHOD__), E_USER_DEPRECATED);
}

$loader = $this->twig->getLoader();
if ($loader instanceof ExistsLoaderInterface) {
return $loader->exists($template);
Expand Down
13 changes: 9 additions & 4 deletions src/Symfony/Bundle/WebProfilerBundle/Profiler/TemplateManager.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@
use Twig\Error\LoaderError;
use Twig\Loader\ExistsLoaderInterface;
use Twig\Loader\SourceContextLoaderInterface;
use Twig\Template;

/**
* Profiler Templates Manager.
Expand Down Expand Up @@ -86,7 +85,7 @@ public function getNames(Profile $profile)
$template = substr($template, 0, -10);
}

if (!$this->templateExists($template.'.html.twig')) {
if (!$this->templateExists($template.'.html.twig', false)) {
throw new \UnexpectedValueException(sprintf('The profiler template "%s.html.twig" for data collector "%s" does not exist.', $template, $name));
}

Expand All @@ -96,9 +95,15 @@ public function getNames(Profile $profile)
return $templates;
}

// to be removed when the minimum required version of Twig is >= 2.0
protected function templateExists($template)
/**
* @deprecated since Symfony 4.4
*/
protected function templateExists($template/*, bool $triggerDeprecation = true */)
{
if (1 === \func_num_args()) {
@trigger_error(sprintf('The "%s()" method is deprecated since Symfony 4.4, use the "exists()" method of the Twig loader instead.', __METHOD__), E_USER_DEPRECATED);
}

$loader = $this->twig->getLoader();
if ($loader instanceof ExistsLoaderInterface) {
return $loader->exists($template);
Expand Down