forked from symfony/symfony
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
generating template names moved out from controller to another class
- Loading branch information
Showing
5 changed files
with
328 additions
and
59 deletions.
There are no files selected for viewing
This file contains 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
133 changes: 133 additions & 0 deletions
133
src/Symfony/Bundle/WebProfilerBundle/Profiler/Template.php
This file contains 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 |
---|---|---|
@@ -0,0 +1,133 @@ | ||
<?php | ||
|
||
/* | ||
* This file is part of the Symfony package. | ||
* | ||
* (c) Fabien Potencier <fabien@symfony.com> | ||
* | ||
* For the full copyright and license information, please view the LICENSE | ||
* file that was distributed with this source code. | ||
*/ | ||
|
||
namespace Symfony\Bundle\WebProfilerBundle\Profiler; | ||
|
||
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException; | ||
use Symfony\Component\HttpKernel\Profiler\Profiler; | ||
use Symfony\Component\HttpKernel\Profiler\Profile; | ||
use Symfony\Bundle\TwigBundle\TwigEngine; | ||
|
||
/** | ||
* ProfilerController. | ||
* | ||
* @author Fabien Potencier <fabien@symfony.com> | ||
* @author Artur Wielogórski <wodor@wodor.net> | ||
*/ | ||
class Template { | ||
|
||
/** | ||
* @var \Symfony\Bundle\TwigBundle\TwigEngine | ||
*/ | ||
public $templating; | ||
|
||
/** | ||
* @var \Twig_Environment | ||
*/ | ||
public $twig; | ||
|
||
/** | ||
* @var array | ||
*/ | ||
public $templates; | ||
|
||
/** | ||
* @var \Symfony\Component\HttpKernel\Profiler\Profiler | ||
*/ | ||
protected $profiler; | ||
|
||
/** | ||
* @param \Symfony\Bundle\TwigBundle\TwigEngine $templating | ||
* @param \Twig_Environment $twig | ||
* @param array $templates | ||
*/ | ||
public function __construct(TwigEngine $templating, \Twig_Environment $twig, array $templates) | ||
{ | ||
$this->templating = $templating; | ||
$this->twig = $twig; | ||
$this->templates = $templates; | ||
} | ||
|
||
/** | ||
* @param \Symfony\Component\HttpKernel\Profiler\Profile $profile | ||
* @param $panel | ||
* @return mixed | ||
* @throws \Symfony\Component\HttpKernel\Exception\NotFoundHttpException | ||
*/ | ||
public function getName(Profile $profile, $panel) | ||
{ | ||
$templates = $this->getNames($profile); | ||
|
||
if (!isset($templates[$panel])) { | ||
throw new NotFoundHttpException(sprintf('Panel "%s" is not registered in profiler or is not present in viewed profile.', $panel)); | ||
} | ||
|
||
return $templates[$panel]; | ||
} | ||
|
||
/** | ||
* @param \Symfony\Component\HttpKernel\Profiler\Profile $profile | ||
* @return array | ||
*/ | ||
public function getTemplates(Profile $profile) | ||
{ | ||
$templates = $this->getNames($profile); | ||
foreach ($templates as $name => $template) { | ||
$templates[$name] = $this->twig->loadTemplate($template); | ||
} | ||
|
||
return $templates; | ||
} | ||
|
||
/** | ||
* @param \Symfony\Component\HttpKernel\Profiler\Profiler $profiler | ||
*/ | ||
public function setProfiler(Profiler $profiler) | ||
{ | ||
$this->profiler = $profiler; | ||
} | ||
|
||
/** | ||
* Gets template names of templates that are | ||
* present in the viewed profile | ||
* @param \Symfony\Component\HttpKernel\Profiler\Profile $profile | ||
* @return array | ||
* @throws \UnexpectedValueException | ||
*/ | ||
protected function getNames(Profile $profile) | ||
{ | ||
$templates = array(); | ||
|
||
foreach ($this->templates as $arguments) { | ||
if (null === $arguments) { | ||
continue; | ||
} | ||
|
||
list($name, $template) = $arguments; | ||
|
||
if (!$this->profiler->has($name) || !$profile->hasCollector($name)) { | ||
continue; | ||
} | ||
|
||
if ('.html.twig' === substr($template, -10)) { | ||
$template = substr($template, 0, -10); | ||
} | ||
|
||
if (!$this->templating->exists($template.'.html.twig')) { | ||
throw new \UnexpectedValueException(sprintf('The profiler template "%s.html.twig" for data collector "%s" does not exist.', $template, $name)); | ||
} | ||
|
||
$templates[$name] = $template.'.html.twig'; | ||
} | ||
|
||
return $templates; | ||
} | ||
} |
This file contains 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 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
Oops, something went wrong.
abd0eb7
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.
I thought passing over two arguments (profile and profiler) through 3 methods isn't nice, also I wanted to be able to write tests, so I've pulled out that methods. Although I'm not happy with the name of this class (Profiler\Template).
If this change is too invasive i can revert to passing profile and profiler.
How to move these changes to 2.0 easily ?