Symfony 3 Rediriger Toutes Les Voies De Paramètres Régionaux En Cours De Version

Après 12 heures de recherche dans ce que j'ai finalement trouvé une solution acceptable. Veuillez publier des versions révisées de cette solution si vous pouvez la rendre plus efficace.

Des choses à noter, ma solution est particulier à mon besoin. Ce qu'il fait, c'est la force de n'importe quelle URL pour accéder à une version localisée, si elle existe.

Cela nécessite certaines conventions à suivre lorsque vous créez des itinéraires.

DefaultController.php

<?php
namespace AppBundle\Controller;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;
class DefaultController extends Controller
{
/**
* @Route("/{_locale}/", name="home_locale", requirements={"_locale" = "%app.locales%"})
*/
public function indexAction(Request $request)
{
$translated = $this->get('translator')->trans('Symfony is great');
//replace this example code with whatever you need
return $this->render('default/index.html.twig', [
'base_dir' => realpath($this->container->getParameter('kernel.root_dir').'/..'),
'translated' => $translated
]);
}
/**
* @Route("/{_locale}/admin", name="admin_locale", requirements={"_locale" = "%app.locales%"})
*/
public function adminAction(Request $request)
{
$translated = $this->get('translator')->trans('Symfony is great');
//replace this example code with whatever you need
return $this->render('default/index.html.twig', [
'base_dir' => realpath($this->container->getParameter('kernel.root_dir').'/..'),
'translated' => $translated
]);
}
}
?>

D'avis que les deux routes de toujours commencer par "/{_locale}/". Pour que cela fonctionne, chaque route dans votre projet doit avoir cette. Vous venez de mettre le vrai nom de la route par la suite. Pour moi, j'étais d'accord avec ce scénario. Vous pouvez modifier ma solution adaptée à vos besoins assez facilement.

La première étape consiste à créer l'écouter sur httpKernal d'intercepter les demandes avant d'aller pour les routeurs de rendre leur.

LocaleRewriteListener.php

<?php
//src/AppBundle/EventListener/LocaleRewriteListener.php
namespace AppBundle\EventListener;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\Routing\RouterInterface;
use Symfony\Component\HttpKernel\Event\GetResponseEvent;
use Symfony\Component\HttpKernel\KernelEvents;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpFoundation\Session\Session;
use Symfony\Component\Routing\RouteCollection;
class LocaleRewriteListener implements EventSubscriberInterface
{
/**
* @var Symfony\Component\Routing\RouterInterface
*/
private $router;
/**
* @var routeCollection \Symfony\Component\Routing\RouteCollection
*/
private $routeCollection;
/**
* @var string
*/
private $defaultLocale;
/**
* @var array
*/
private $supportedLocales;
/**
* @var string
*/
private $localeRouteParam;
public function __construct(RouterInterface $router, $defaultLocale = 'en', array $supportedLocales = array('en'), $localeRouteParam = '_locale')
{
$this->router = $router;
$this->routeCollection = $router->getRouteCollection();
$this->defaultLocale = $defaultLocale;
$this->supportedLocales = $supportedLocales;
$this->localeRouteParam = $localeRouteParam;
}
public function isLocaleSupported($locale) 
{
return in_array($locale, $this->supportedLocales);
}
public function onKernelRequest(GetResponseEvent $event)
{
//GOAL:
//Redirect all incoming requests to their /locale/route equivlent as long as the route will exists when we do so.
//Do nothing if it already has /locale/in the route to prevent redirect loops
$request = $event->getRequest();
$path = $request->getPathInfo();
$route_exists = false; //by default assume route does not exist.
foreach($this->routeCollection as $routeObject){
$routePath = $routeObject->getPath();
if($routePath == "/{_locale}".$path){
$route_exists = true;
break;
}
}
//If the route does indeed exist then lets redirect there.
if($route_exists == true){
//Get the locale from the users browser.
$locale = $request->getPreferredLanguage();
//If no locale from browser or locale not in list of known locales supported then set to defaultLocale set in config.yml
if($locale==""  || $this->isLocaleSupported($locale)==false){
$locale = $request->getDefaultLocale();
}
$event->setResponse(new RedirectResponse("/".$locale.$path));
}
//Otherwise do nothing and continue on~
}
public static function getSubscribedEvents()
{
return array(
//must be registered before the default Locale listener
KernelEvents::REQUEST => array(array('onKernelRequest', 17)),
);
}
}

Enfin, vous définissez les services.yml pour démarrer l'auditeur.

Services.yml

# Learn more about services, parameters and containers at
# http://symfony.com/doc/current/book/service_container.html
parameters:
#    parameter_name: value
services:
#    service_name:
#        class: AppBundle\Directory\ClassName
#        arguments: ["@another_service_name", "plain_value", "%parameter_name%"]
appBundle.eventListeners.localeRewriteListener:
class: AppBundle\EventListener\LocaleRewriteListener
arguments: ["@router", "%kernel.default_locale%", "%locale_supported%"]
tags:
- { name: kernel.event_subscriber }

Aussi dans la config.yml vous souhaitez ajouter les informations suivantes sous paramètres:

config.yml

parameters:
locale: en
app.locales: en|es|zh
locale_supported: ['en','es','zh']

Je voulais n'être qu'un seul endroit où vous définissez les paramètres régionaux, mais j'ai fini par avoir à faire 2...mais au moins ils sont dans le même endroit, donc facile à changer.

app.locales est utilisé dans le contrôleur par défaut (requirements={"_locale" = "%app.locales%"}) et locale_supported est utilisé dans le LocaleRewriteListener. S'il détecte une locale qui n'est pas dans la liste, il se replie sur les paramètres régionaux par défaut, qui dans ce cas est la valeur de paramètres régionaux:fr.

app.locales est gentil avec les exigences de commande car cela risque de provoquer une erreur 404 pour tous les paramètres régionaux qui ne correspondent pas.

Si vous utilisez des formulaires et d'avoir une connexion, vous devez faire ce qui suit pour votre sécurité.yml

De sécurité.yml

# To get started with security, check out the documentation:
# http://symfony.com/doc/current/book/security.html
security:
encoders:
Symfony\Component\Security\Core\User\User:
algorithm: bcrypt
cost: 12
AppBundle\Entity\User:
algorithm: bcrypt
cost: 12
role_hierarchy:
ROLE_ADMIN:       ROLE_USER
ROLE_SUPER_ADMIN: [ROLE_USER, ROLE_ADMIN, ROLE_ALLOWED_TO_SWITCH]
providers:
# http://symfony.com/doc/current/book/security.html#where-do-users-come-from-user-providers
database:
entity: { class: AppBundle:User }
#property: username
# if you're using multiple entity managers
# manager_name: customer
firewalls:
# disables authentication for assets and the profiler, adapt it according to your needs
dev:
pattern: ^/(_(profiler|wdt)|css|images|js)/
security: false
main:
pattern: ^/
anonymous: true
form_login:
check_path: login_check
login_path: login_route
provider: database
csrf_token_generator: security.csrf.token_manager
remember_me:
secret:   '%secret%'
lifetime: 604800 # 1 week in seconds
path:     /
httponly: false
#httponly false does make this vulnerable in XSS attack, but I will make sure that is not possible.
logout:
path:   /logout
target: /
access_control:
# require ROLE_ADMIN for /admin*
#- { path: ^/login, roles: ROLE_ADMIN }
- { path: ^/login, roles: IS_AUTHENTICATED_ANONYMOUSLY }
- { path: ^/(.*?)/login, roles: IS_AUTHENTICATED_ANONYMOUSLY }
- { path: ^/, roles: ROLE_USER }

Le changement important à noter ici est que (.*?)/login permettra de s'authentifier de manière anonyme afin que vos utilisateurs puissent toujours vous connecter. Cela signifie que les routes, comme..dogdoghere/login pourrait déclencher, mais les exigences, je vais vous montrer prochainement sur les routes de connexion de prévenir cette situation et va lancer des erreurs 404. J'aime cette solution avec le (.*?) contre [a-z]{2} au cas où vous vouliez l'utiliser en_US type de paramètres régionaux.

SecurityController.php

<?php
//src/AppBundle/Controller/SecurityController.php
namespace AppBundle\Controller;
use Symfony\Bundle\FrameworkBundle\Controller\Controller;
use Symfony\Component\HttpFoundation\Request;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
class SecurityController extends Controller
{
/**
* @Route("{_locale}/login", name="login_route", defaults={"_locale"="en"}, requirements={"_locale" = "%app.locales%"})
*/
public function loginAction(Request $request)
{
$authenticationUtils = $this->get('security.authentication_utils');
//get the login error if there is one
$error = $authenticationUtils->getLastAuthenticationError();
//last username entered by the user
$lastUsername = $authenticationUtils->getLastUsername();
return $this->render(
'security/login.html.twig',
array(
//last username entered by the user
'last_username' => $lastUsername,
'error'         => $error,
)
);
}
/**
* @Route("/{_locale}/login_check", name="login_check", defaults={"_locale"="en"}, requirements={"_locale" = "%app.locales%"})
*/
public function loginCheckAction()
{
//this controller will not be executed,
//as the route is handled by the Security system
}
/**
* @Route("/logout", name="logout")
*/
public function logoutAction()
{
}
}
?>

Noter que même ces chemins utiliser {_locale} en face. J'aime ceci, cependant, afin que je puisse donner personnalisée connexions pour les différents paramètres régionaux. Il suffit de garder cela à l'esprit. La seule voie qui n'a pas besoin de la locale est de déconnexion qui fonctionne très bien depuis son en réalité qu'une seule interception de route pour la sécurité du système. Notez également qu'il se fonde sur les prescriptions qui est définie à partir de la config.yml, de sorte que vous n'avez qu'à éditer dans un seul endroit pour tous les itinéraires dans tous vos projets.

Espère que cela aide quelqu'un qui essaie de faire ce que je faisais!

REMARQUE: Pour tester facilement j'utilise le plus Rapide de la Langue Switcher' extension pour Google Chrome, qui modifie l'-tête accept-language sur toutes les demandes.

OriginalL'auteur Joseph Astrahan

fonction finale smallResumeOfResearching($localeRewrite, $avis = 'mon humble avis') 🙂

1. La méthode, fournies par le monsieur. Joseph génial de travailler avec des voies comme /{route_name} ou /, mais pas avec de tels axes /article/slug/autres.

2. Si nous utilisons modifié monsieur.Joseph méthode, fournis par https://stackoverflow.com/a/37168304/9451542, nous avons perdu profiler et le débogueur en dev mode.

3. Si nous voulons solution plus flexible, onKernelRequest méthode peut être modifiée comme ceci (merci à monsieur. Joseph, grâce à https://stackoverflow.com/a/37168304/9451542):

   public function onKernelRequest(GetResponseEvent $event)
   {
   $pathInfo = $event->getRequest()->getPathinfo();
   $baseUrl = $event->getRequest()->getBaseUrl();
   $checkLocale = explode('/', ltrim($pathInfo, '/'))[0];
   //Or some other logic to detect/provide locale
   if (($this->isLocaleSupported($checkLocale) == false) && ($this->defaultLocale !== $checkLocale)) {
   if ($this->isProfilerRoute($checkLocale) == false) {
   $locale = $this->defaultLocale;
   $event->setResponse(new RedirectResponse($baseUrl . '/' . $locale . $pathInfo));
   }
   /* Or with matcher:
   try {
   //Try to match the path with the locale prefix
   $this->matcher->match('/' . $locale . $pathInfo);
   //$event->setResponse(new RedirectResponse($baseUrl . '/' . $locale . $pathInfo));
   } catch (\Symfony\Component\Routing\Exception\ResourceNotFoundException $e) {
   } catch (\Symfony\Component\Routing\Exception\MethodNotAllowedException $e) {
   }
   */
   }
   }

   note: $this->profilerRoutes = array('_profiler', '_wdt', '_error');

4. Merci à Susana Santos pour indiquer une simple config méthode 🙂

OriginalL'auteur Vitalijus Trainys