Skip to content
Permalink
Browse files

minor #32216 [5.0] [WebProfilerBundle] Add parameter type-hints where…

… possible (Matts)

This PR was merged into the 5.0-dev branch.

Discussion
----------

[5.0] [WebProfilerBundle] Add parameter type-hints where possible

| Q             | A
| ------------- | ---
| Branch?       | 5.0
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #32179
| License       | MIT
| Doc PR        | symfony/symfony-docs#... <!-- required for new features -->

Add type-hints for WebProfilerBundle in 5.0

Commits
-------

8f33c6f [WebProfilerBundle] Use scalar type-hints where possible
  • Loading branch information...
fabpot committed Jul 5, 2019
2 parents 53e68f7 + 8f33c6f commit 885a1922e16060b6981104a4910444622abd9ab3
@@ -47,13 +47,11 @@ public function __construct(Profiler $profiler = null, Environment $twig, bool $
/**
* Renders the exception panel for the given token.
*
* @param string $token The profiler token
*
* @return Response A Response instance
*
* @throws NotFoundHttpException
*/
public function showAction($token)
public function showAction(string $token)
{
if (null === $this->profiler) {
throw new NotFoundHttpException('The profiler must be enabled.');
@@ -85,13 +83,11 @@ public function showAction($token)
/**
* Renders the exception panel stylesheet for the given token.
*
* @param string $token The profiler token
*
* @return Response A Response instance
*
* @throws NotFoundHttpException
*/
public function cssAction($token)
public function cssAction(string $token)
{
if (null === $this->profiler) {
throw new NotFoundHttpException('The profiler must be enabled.');
@@ -114,7 +110,7 @@ protected function getTemplate()
}
// to be removed when the minimum required version of Twig is >= 2.0
protected function templateExists($template)
protected function templateExists(string $template)
{
$loader = $this->twig->getLoader();
if ($loader instanceof ExistsLoaderInterface) {
@@ -62,14 +62,11 @@ public function homeAction()
/**
* Renders a profiler panel for the given token.
*
* @param Request $request The current HTTP request
* @param string $token The profiler token
*
* @return Response A Response instance
*
* @throws NotFoundHttpException
*/
public function panelAction(Request $request, $token)
public function panelAction(Request $request, string $token)
{
$this->denyAccessIfProfilerDisabled();
@@ -108,14 +105,11 @@ public function panelAction(Request $request, $token)
/**
* Renders the Web Debug Toolbar.
*
* @param Request $request The current HTTP Request
* @param string $token The profiler token
*
* @return Response A Response instance
*
* @throws NotFoundHttpException
*/
public function toolbarAction(Request $request, $token)
public function toolbarAction(Request $request, string $token = null)
{
if (null === $this->profiler) {
throw new NotFoundHttpException('The profiler must be enabled.');
@@ -210,14 +204,11 @@ public function searchBarAction(Request $request)
/**
* Renders the search results.
*
* @param Request $request The current HTTP Request
* @param string $token The token
*
* @return Response A Response instance
*
* @throws NotFoundHttpException
*/
public function searchResultsAction(Request $request, $token)
public function searchResultsAction(Request $request, string $token)
{
$this->denyAccessIfProfilerDisabled();
@@ -45,13 +45,11 @@ public function __construct(Profiler $profiler = null, Environment $twig, UrlMat
/**
* Renders the profiler panel for the given token.
*
* @param string $token The profiler token
*
* @return Response A Response instance
*
* @throws NotFoundHttpException
*/
public function panelAction($token)
public function panelAction(string $token)
{
if (null === $this->profiler) {
throw new NotFoundHttpException('The profiler must be enabled.');
@@ -190,7 +190,7 @@ private function generateCspHeader(array $directives)
*
* @return array The directive set
*/
private function parseDirectives($header)
private function parseDirectives(string $header)
{
$directives = [];
@@ -214,7 +214,7 @@ private function parseDirectives($header)
*
* @return bool
*/
private function authorizesInline(array $directivesSet, $type)
private function authorizesInline(array $directivesSet, string $type)
{
if (isset($directivesSet[$type])) {
$directives = $directivesSet[$type];
@@ -42,14 +42,11 @@ public function __construct(Profiler $profiler, Environment $twig, array $templa
/**
* Gets the template name for a given panel.
*
* @param Profile $profile
* @param string $panel
*
* @return mixed
*
* @throws NotFoundHttpException
*/
public function getName(Profile $profile, $panel)
public function getName(Profile $profile, string $panel)
{
$templates = $this->getNames($profile);
@@ -97,7 +94,7 @@ public function getNames(Profile $profile)
}
// to be removed when the minimum required version of Twig is >= 2.0
protected function templateExists($template)
protected function templateExists(string $template)
{
$loader = $this->twig->getLoader();
if ($loader instanceof ExistsLoaderInterface) {
@@ -69,7 +69,7 @@ public function getFunctions()
];
}
public function dumpData(Environment $env, Data $data, $maxDepth = 0)
public function dumpData(Environment $env, Data $data, int $maxDepth = 0)
{
$this->dumper->setCharset($env->getCharset());
$this->dumper->dump($data, null, [
@@ -83,7 +83,7 @@ public function dumpData(Environment $env, Data $data, $maxDepth = 0)
return str_replace("\n</pre", '</pre', rtrim($dump));
}
public function dumpLog(Environment $env, $message, Data $context = null)
public function dumpLog(Environment $env, string $message, Data $context = null)
{
$message = twig_escape_filter($env, $message);
$message = preg_replace('/&quot;(.*?)&quot;/', '&quot;<b>$1</b>&quot;', $message);

0 comments on commit 885a192

Please sign in to comment.
You can’t perform that action at this time.