Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
decoupled global variables system in Twig from the Templating one
  • Loading branch information
fabpot committed Jan 10, 2015
1 parent 861804b commit be5a208
Show file tree
Hide file tree
Showing 5 changed files with 172 additions and 4 deletions.
Expand Up @@ -18,7 +18,7 @@
use Symfony\Component\Security\Core\SecurityContext;

/**
* GlobalVariables is the entry point for Symfony global variables in Twig templates.
* GlobalVariables is the entry point for Symfony global variables in PHP templates.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
Expand Down
160 changes: 160 additions & 0 deletions src/Symfony/Bundle/TwigBundle/AppVariable.php
@@ -0,0 +1,160 @@
<?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\TwigBundle;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\HttpFoundation\Session\Session;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
use Symfony\Component\Security\Core\SecurityContextInterface;

/**
* Exposes some Symfony parameters and services as an "app" global variable.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class AppVariable
{
private $security;
private $tokenStorage;
private $requestStack;
private $environment;
private $debug;

/**
* @deprecated since version 2.7, to be removed in 3.0.
*/
public function setSecurity(SecurityContextInterface $security)
{
$this->security = $security;
}

public function setTokenStorage(TokenStorageInterface $tokenStorage)
{
$this->tokenStorage = $tokenStorage;
}

public function setRequestStack(RequestStack $requestStack)
{
$this->requestStack = $requestStack;
}

public function setEnvironment($environment)
{
$this->environment = $environment;
}

public function setDebug($debug)
{
$this->debug = (bool) $debug;
}

/**
* Returns the security context service.
*
* @deprecated since version 2.6, to be removed in 3.0.
*
* @return SecurityContext|null The security context
*/
public function getSecurity()
{
trigger_error('The "app.security" variable is deprecated since version 2.6 and will be removed in 3.0.', E_USER_DEPRECATED);

if (null === $this->security) {
throw new \RuntimeException('The "app.security" variable is not available.');
}

return $this->security;
}

/**
* Returns the current user.
*
* @return mixed
*
* @see TokenInterface::getUser()
*/
public function getUser()
{
if (null === $this->tokenStorage) {
throw new \RuntimeException('The "app.user" variable is not available.');
}

if (!$token = $this->tokenStorage->getToken()) {
return;
}

$user = $token->getUser();
if (is_object($user)) {
return $user;
}
}

/**
* Returns the current request.
*
* @return Request|null The HTTP request object
*/
public function getRequest()
{
if (null === $this->requestStack) {
throw new \RuntimeException('The "app.request" variable is not available.');
}

return $this->requestStack->getCurrentRequest();
}

/**
* Returns the current session.
*
* @return Session|null The session
*/
public function getSession()
{
if (null === $this->requestStack) {
throw new \RuntimeException('The "app.session" variable is not available.');
}

if ($request = $this->getRequest()) {
return $request->getSession();
}
}

/**
* Returns the current app environment.
*
* @return string The current environment string (e.g 'dev')
*/
public function getEnvironment()
{
if (null === $this->environment) {
throw new \RuntimeException('The "app.environment" variable is not available.');
}

return $this->environment;
}

/**
* Returns the current app debug mode.
*
* @return bool The current debug mode
*/
public function getDebug()
{
if (null === $this->debug) {
throw new \RuntimeException('The "app.debug" variable is not available.');
}

return $this->debug;
}
}
10 changes: 9 additions & 1 deletion src/Symfony/Bundle/TwigBundle/Resources/config/twig.xml
Expand Up @@ -34,10 +34,18 @@
<argument>%twig.options%</argument>
<call method="addGlobal">
<argument>app</argument>
<argument type="service" id="templating.globals" />
<argument type="service" id="twig.app_variable" />
</call>
</service>

<service id="twig.app_variable" class="Symfony\Bundle\TwigBundle\AppVariable" public="false">
<call method="setEnvironment"><argument>%kernel.environment%</argument></call>
<call method="setDebug"><argument>%kernel.debug%</argument></call>
<call method="setSecurity"><argument type="service" id="security.context" on-invalid="ignore" /></call>
<call method="setTokenStorage"><argument type="service" id="security.token_storage" on-invalid="ignore" /></call>
<call method="setRequestStack"><argument type="service" id="request_stack" on-invalid="ignore" /></call>
</service>

<service id="twig.cache_warmer" class="%twig.cache_warmer.class%" public="false">
<tag name="kernel.cache_warmer" />
<argument type="service" id="service_container" />
Expand Down
Expand Up @@ -99,7 +99,7 @@ public function testLoadFullConfiguration($format)
// Globals
$calls = $container->getDefinition('twig')->getMethodCalls();
$this->assertEquals('app', $calls[0][1][0], '->load() registers services as Twig globals');
$this->assertEquals(new Reference('templating.globals'), $calls[0][1][1]);
$this->assertEquals(new Reference('twig.app_variable'), $calls[0][1][1]);
$this->assertEquals('foo', $calls[1][1][0], '->load() registers services as Twig globals');
$this->assertEquals(new Reference('bar'), $calls[1][1][1], '->load() registers services as Twig globals');
$this->assertEquals('baz', $calls[2][1][0], '->load() registers variables as Twig globals');
Expand Down
2 changes: 1 addition & 1 deletion src/Symfony/Bundle/TwigBundle/composer.json
Expand Up @@ -28,7 +28,7 @@
"symfony/config": "~2.2|~3.0.0",
"symfony/routing": "~2.1|~3.0.0",
"symfony/templating": "~2.1|~3.0.0",
"symfony/framework-bundle": "~2.1|~3.0.0"
"symfony/framework-bundle": "~2.7|~3.0.0"
},
"autoload": {
"psr-0": { "Symfony\\Bundle\\TwigBundle\\": "" }
Expand Down

0 comments on commit be5a208

Please sign in to comment.