Routing (2/3) | Train to Symfony

http://traintosymfony.com1
Emanuele Gaspari
TRAIN
TO SYMFONY
Verona, 13•14 Aprile 2013
the frameworkshop
http://traintosymfony.com
@TrainToSymfony
Media partner:
Routing (2/3)

Emanuele Gaspari
about me
creatore di SymfonyBricks
Emanuele Gaspari
ultimo sito pubblicato (copiaincolla): www.ilovesanmartino.it
4 bundles
21 controllers
6 services
9 entities
5 repositories custom
4 estensioni twig
14 macros
10 bundles aggiuntivi
(FOSUserBundle, FOSJsRoutingBundle, KnpPaginatorBundle, CopiaincollaMetaTagsBundle, etc..)
co-sviluppatore di CopiaincollaMetaTagsBundle https://github.com/copiaincolla/MetaTagsBundle
https://symfonybricks.com
inmarelibero@gmail.com @inmarelibero

Emanuele Gaspari
Symfony: teoria e codice
Routing Templating
frameworkshop: il programma
overview
obiettivo della seconda parte:
il sistema di Routing in Symfony

Emanuele Gaspari
Routing
il Routing è il meccanismo di associazione tra url e controllers

Emanuele Gaspari
Routes
Controller e Action
specificare una Route
Routes parametriche
annotation @Route
collisione di urls
Controller Naming Pattern
Request
oggetto Request
i parametri
Response
oggetto Response
redirect
parametri per il template
ROUTING

Emanuele Gaspari
Controller
SymfonyBundleFrameworkBundleControllerController
●
riceve i parametri
●
esegue delle operazioni e restituisce una risposta
in Symfony un Controller è una classe PHP che estende la classe
task comuni: passaggio di variabili ai templates,
accesso a “servizi”, comunicazione con database, redirect

Emanuele Gaspari
●
funzione definita all'interno di un controller
●
la firma ha la sintassi public function ...Action()
nel Controller vengono definite le
actions (azioni)
Action

Emanuele Gaspari
actions: esempi
# src/Tts/DemoBundle/Controller/DefaultController.php
<?php
namespace TtsDemoBundleController;
use SymfonyBundleFrameworkBundleControllerController;
class DefaultController extends Controller
{
public function homepageAction()
{
[...]
}
public function contattiAction()
{
[...]
}
public function chiSiamoAction()
{
[...]
}
}
<?php
{
{
[...]
}
public function contattiAction()
{
[...]
}
public function chiSiamoAction()
{
[...]
}
}

Emanuele Gaspari
scopo di un'azione
lo scopo di un'azione è di preparare i dati
che verranno mostrati nel template
le azioni non dovrebbero essere molto estese
se un'azione lo è, chiediti se la logica debba essere
ridistribuita in altri servizi, repository, entities

Emanuele Gaspari
Routes
Controller e Action
Routes parametriche
annotation @Route
collisione di urls
Request
oggetto Request
i parametri
Response
oggetto Response
redirect
ROUTING

Emanuele Gaspari
una Route è un'associazione tra url e controller che specifico:
Route: tra url e Controller
●
in app/config/routing.yml
●
in un altro file yml
●
nel controller

Emanuele Gaspari
# app/config/routing.yml
homepage:
path: /
defaults: { _controller: TtsDemoBundle:Default:homepage }
homepage:
path: /
<?php
{
{
return $this->render(
'TtsDemoBundle:Default:homepage.html.twig'
);
}
}
<?php
{
{
return $this->render(
'TtsDemoBundle:Default:homepage.html.twig'
);
}
}
/

Emanuele Gaspari
index_catalogo:
path: /catalogo
defaults: { _controller: TtsDemoBundle:Catalogo:index }
index_catalogo:
path: /catalogo
# src/Tts/DemoBundle/Controller/CatalogoController.php
<?php
class CatalogoController extends Controller
{
public function indexAction()
{
[...]
}
}
<?php
{
public function indexAction()
{
[...]
}
}
/catalogo

Emanuele Gaspari
Routes
Controller e Action
Routes parametriche
annotation @Route
collisione di urls
Request
oggetto Request
i parametri
Response
oggetto Response
redirect
ROUTING

Emanuele Gaspari
stabilisco che una parte del path è variabile
Routes {parametriche}
le parti variabili sono comprese tra { } e vengono passate
all'azione come argomenti

Emanuele Gaspari
# src/Tts/DemoBundle/Controller/ProdottoController.php
<?php
use SmfonyBundleFrameworkBundleControllerController;
class ProdottoController extends Controller
{
public function showAction($codice)
{
$em = $this->getDoctrine()->getManager();
$entity = $em->getRepository('TtsDemoBundle:Prodotto')->find($codice);
[...]
}
}
<?php
use SmfonyBundleFrameworkBundleControllerController;
{
{
$em = $this->getDoctrine()->getManager();
$entity = $em->getRepository('TtsDemoBundle:Prodotto')->find($codice);
[...]
}
}
prodotto_show:
path: /prodotto/{codice}
defaults: { _controller: TtsDemoBundle:Prodotto:show }
prodotto_show:
/prodotto/{codice}

Emanuele Gaspari
prodotto_show:
path: /prodotto/{categoria}/{codice}/{slug}
prodotto_show:
/prodotto/{categoria}/{codice}/{slug}

Emanuele Gaspari
GET /prodotto/147?mobile_layout=trueGET /prodotto/147?mobile_layout=true
prodotto_show:
prodotto_show:
<?php
{
$request = $this->getRequest();
$mobileLayout = $request->get('mobile_layout');
// oppure, più estesamente
$mobileLayout = $request->query->get('mobile_layout', 'false');
[…]
}
<?php
{
$mobileLayout = $request->get('mobile_layout');
// oppure, più estesamente
$mobileLayout = $request->query->get('mobile_layout', 'false');
[…]
}
passaggio di parametri $_GET

Emanuele Gaspari
Routes
Controller e Action
Routes parametriche
annotation @Route
collisione di urls
Request
oggetto Request
i parametri
Response
oggetto Response
redirect
ROUTING

Emanuele Gaspari
al posto di definire una Route per ogni (sintassi di) url in un file yml
posso usare l'annotazione @Route direttamente nel controller

Emanuele Gaspari
=
<?php
use SensioBundleFrameworkExtraBundleConfigurationRoute;
{
/**
* @Route("/", name=”homepage”)
*/
public function homepageAction() {
[...]
}
}
<?php
{
/**
*/
public function homepageAction() {
[...]
}
}
homepage:
path: /

Emanuele Gaspari
index_catalogo:
path: /catalogo
<?php
{
/**
* @Route("/catalogo", name=”index_catalogo”)
*/
public function indexAction() {
[...]
}
}
<?php
{
/**
* @Route("/catalogo", name=”index_catalogo”)
*/
public function indexAction() {
[...]
}
}
=

Emanuele Gaspari
prodotto_show:
<?php
{
/**
* @Route("/prodotto/{codice}", name=”prodotto_show”)
*/
public function showAction($codice) {
[...]
}
}
<?php
{
/**
* @Route("/prodotto/{codice}", name=”prodotto_show”)
*/
public function showAction($codice) {
[...]
}
}
=

Emanuele Gaspari
prodotto_show:
<?php
{
/**
* @Route("/prodotto/{categoria}/{codice}/{slug}", name=”prodotto_show”)
*/
public function showAction($categoria, $codice, $slug) {
[...]
}
}
<?php
{
/**
*/
public function showAction($categoria, $codice, $slug) {
[...]
}
}
=

Emanuele Gaspari
definisco in app/config/routing.yml quali controller caricare

Emanuele Gaspari
type: annotation
# app/config/config.yml
# TtsDemoBundle Default controller
default:
resource: “@TtsDemoBundle/Controller/DefaultController.php”
type: annotation
# TtsDemoBundle Catalogo controller
catalogo:
resource: “@TtsDemoBundle/Controller/CatalogoController.php”
type: annotation
# TtsDemoBundle Prodotto controller
prodotto:
resource: “@TtsDemoBundle/Controller/ProdottoController.php”
type: annotation
# TtsDemoBundle Default controller
default:
resource: “@TtsDemoBundle/Controller/DefaultController.php”
type: annotation
# TtsDemoBundle Catalogo controller
catalogo:
resource: “@TtsDemoBundle/Controller/CatalogoController.php”
type: annotation
# TtsDemoBundle Prodotto controller
prodotto:
resource: “@TtsDemoBundle/Controller/ProdottoController.php”
type: annotation

Emanuele Gaspari
type: annotation (2)
# TtsDemoBundle
tts_demo:
resource: “@TtsDemoBundle/Controller/”
type: annotation
# TtsDemoBundle
tts_demo:
resource: “@TtsDemoBundle/Controller/”
type: annotation
o, semplicemente, specifico la cartella che li contiene tutti

Emanuele Gaspari
Routes
Controller e Action
Routes parametriche
annotation @Route
collisione di urls
Request
oggetto Request
i parametri
Response
oggetto Response
redirect
ROUTING

Emanuele Gaspari
best practice
far corrispondere ad ogni url una sola route

Emanuele Gaspari
GET /prodotto/EG-124 => prodotto_show
GET /prodotto/index => prodotto_show, prodotto_index
prodotto_show:
prodotto_index:
path: /prodotto/index
defaults: { _controller: TtsDemoBundle:Prodotto:index }
prodotto_show:
prodotto_index:
defaults: { _controller: TtsDemoBundle:Prodotto:index }
collisione di urls

Emanuele Gaspari
sfrutto l'ordine con cui vengono definite le Routes
il controller si ferma alla prima Route abbinata all'url
è sufficiente definire prima la Route che non contiene parametri
GET /prodotto/index
GET /prodotto/EG-124
prodotto_index:
prodotto_show:
prodotto_index:
prodotto_show:
soluzione 1, ordine delle Routes

Emanuele Gaspari
rimane ancora il problema della collisione di urls verso più di una Route
basarsi sull'ordine con cui vengono esaminate le Routes non è sufficiente:
dopo un anno che il sito è in produzione, mi ricordo che la
posizione di quella specifica Route è vitale?
anche usando l'annotazione @Route, posso non volere che
all'interno di un Controller una funzione venga spostata
in alto solo perché la Route venga esaminata prima
l'ordine non basta

Emanuele Gaspari
sfrutto il parametro requirements
prodotto_show:
requirements:
codice: [A-Z]{2}-[0-9]+
prodotto_index:
prodotto_show:
requirements:
codice: [A-Z]{2}-[0-9]+
prodotto_index:
GET /prodotto/index
GET /prodotto/EG-124
non c'è più collisione tra Routes
non mi affido più all'ordine di caricamento
soluzione 2, parametro requirements
pongo dei vincoli sul formato di un parametro di una Route

Emanuele Gaspari
Routes
Controller e Action
Routes parametriche
annotation @Route
collisione di urls
Request
oggetto Request
i parametri
Response
oggetto Response
redirect
ROUTING

Emanuele Gaspari
Symfony associa il nome logico ad una
specifica classe e metodo (Controller e Action)
bundle:controller:action
nome logico di un Controller
sintassi per riferirsi ad un'azione da qualunque punto dell'applicazione

Emanuele Gaspari
TtsDemoBundle:Default:homepage
Bundle Controller Metodo
TtsDemoBundleTtsDemoBundle DefaultControllerDefaultController homepageAction()homepageAction()
<?php
{
{
[…]
}
}
<?php
{
{
[…]
}
}

Emanuele Gaspari
# template twig
{{ render(controller(“TtsDemoBundle:Blog:latestPosts”, {“max”: 5})) }}
# template twig
{{ render(controller(“TtsDemoBundle:Blog:latestPosts”, {“max”: 5})) }}
esempio

Emanuele Gaspari
$ php app/console router:debug$ php app/console router:debug
$ php app/console router:match /prodotto/EG-124$ php app/console router:match /prodotto/EG-124
tips
stampare a console l'elenco di tutte le Routes caricate
verificare se un path è associato da Symfony ad una Route

Emanuele Gaspari
Routes
Controller e Action
Routes parametriche
annotation @Route
collisione di urls
Request
oggetto Request
i parametri
Response
oggetto Response
redirect
ROUTING

Emanuele Gaspari
oggetto Request
SymfonyComponentHttpFoundationRequest
oggetto che ho a disposizione all'interno di ogni azione
per gestire tutti i parametri della richiesta
Symfony utilizza un oggetto Request per modellare una richiesta HTTP

Emanuele Gaspari
accedere ad un oggetto Request
<?php
{
}
<?php
{
}
use SymfonyComponentHttpFoundationRequest;
$request = Request::createFromGlobals();
use SymfonyComponentHttpFoundationRequest;
$request = Request::createFromGlobals();
accedere a Request in una Action:
accedere a Request da qualunque punto dell'applicazione (in PHP):
$this->getRequest() => 0.04 Kb
Request::createFromGlobals() => 7.07 Kb
{{ app.request }}{{ app.request }}
accedere a Request da twig:

Emanuele Gaspari
panoramica
$_GET
$request->query
$_POST
$request->request
$_COOKIE
$request->cookies
$_FILE
$request->files
$_SERVER
$request->server
http://api.symfony.com/master/Symfony/Component/HttpFoundation/Request.html
$request
->getPathInfo() ->getMethod() ->getLanguages()
->getRequestUri() ->getClientIp() ->getPreferredLanguage()
->getScriptName() ->getSession() ->isXmlHttpRequest()

Emanuele Gaspari
Routes
Controller e Action
Routes parametriche
annotation @Route
collisione di urls
Request
oggetto Request
i parametri
Response
oggetto Response
redirect
ROUTING

Emanuele Gaspari
/**
*/
public function showAction($codice, $slug, $categoria)
{
[...]
}
/**
*/
{
[...]
}
url con parametri
200 GET /prodotto/nuovi/EG-124/eg-124-new-hammer
non importa l'ordine
possono non essere specificati tutti
l'ordine è importante, per associare i parametri dell'url
404 GET /prodotto/nuovi/EG-124
404 GET /prodotto/nuovi/EG-124/

Emanuele Gaspari
defaults (1)
200 GET /prodotto/nuovi/EG-124/eg-124-new-hammer
200 GET /prodotto/nuovi/EG-124
404 GET /prodotto/nuovi/EG-124/
/**
* @Route("/prodotto/{categoria}/{codice}/{slug}", name=”prodotto_show”,
defaults={“slug”: “-”})
*/
public function showAction($codice, $categoria, $slug) { [...] }
/**
*/
public function showAction($codice, $categoria) { [...] }
/**
*/
public function showAction($codice, $categoria, $slug = “-”) { [...] }
/**
*/
public function showAction($codice, $categoria, $slug) { [...] }
/**
*/
public function showAction($codice, $categoria) { [...] }
/**
*/
public function showAction($codice, $categoria, $slug = “-”) { [...] }

Emanuele Gaspari
accesso ai parametri
200 GET /prodotto/nuovi/EG-124/eg-124-new-hammer?color=red
200 GET /prodotto/nuovi/EG-124?color=red
/**
*/
public function showAction($codice, $slug = “-”, $categoria)
{
// nell'url
$codice;
$codice = $request->get(“codice”);
// in $_GET
$color = $request->get(“color”);
$color = $request->query->get(“color”);
[...]
}
/**
*/
public function showAction($codice, $slug = “-”, $categoria)
{
// nell'url
$codice;
$codice = $request->get(“codice”);
// in $_GET
$color = $request->get(“color”);
$color = $request->query->get(“color”);
[...]
}

Emanuele Gaspari
?get= o /{param}
●
parametro essenziale?
●
eleganza degli url
●
cambio successivo degli url
●
indicizzazione dei motori di ricerca
●
multilingua
quando passare un parametro come
?get=
e quando come
/{param}

Emanuele Gaspari
Routes
Controller e Action
Routes parametriche
annotation @Route
collisione di urls
Request
oggetto Request
i parametri
Response
oggetto Response
redirect
ROUTING

Emanuele Gaspari
Response
ogni Action restituisce sempre un oggetto Response
real life: molte volte la Action che implementerai restituirà
semplicemente un array di variabili, utilizzabili
in un template che viene scelto più o meno “automaticamente”

Emanuele Gaspari
return array
la situazione più semplice è quella in cui utilizzo
l'annotation @Template e la mia Action restituisce
semplicemente un array

Emanuele Gaspari
return array
<?php
use SensioBundleFrameworkExtraBundleConfigurationTemplate;
{
/**
* @Route(“/prodotto/{categoria}/{codice}/{slug}”, name=”prodotto_show”)
* @Template()
*/
{
$entity = $this->getRepository('TtsDemoBundle:Prodotto')->findOneBy(
array(“codice” => $codice)
);
return array('entity' => $entity);
}
<?php
use SensioBundleFrameworkExtraBundleConfigurationTemplate;
{
/**
* @Route(“/prodotto/{categoria}/{codice}/{slug}”, name=”prodotto_show”)
* @Template()
*/
{
);
return array('entity' => $entity);
}

Emanuele Gaspari
render()
posso fare in modo che l'azione restituisca un template TWIG compilato,
ad esempio perché è diverso in base alla logica interna dell'azione
utlizzo la funzione $this->render() specificando il template

Emanuele Gaspari
<?php
{
/**
*/
{
);
return $this->render('TtsDemoBundle:Prodotto:show_offer.html.twig', array(
'entity' => $entity
));
}
<?php
{
/**
*/
{
);
return $this->render('TtsDemoBundle:Prodotto:show_offer.html.twig', array(
'entity' => $entity
));
}
$this->render()

Emanuele Gaspari
costruire una Response
è possibile anche costruire un oggetto Response
utile nel caso in cui abbia necessità di costruire la risposta
in più passaggi a seconda di variabili
o di effettuare delle operazioni successivamente

Emanuele Gaspari
costruire una Response
utilizzo la funzione $this->renderView() per memorizzare
un contenuto HTML in una variabile
creo un oggetto Response con quella variabile come primo
argomentoimpostando

Emanuele Gaspari
<?php
use SymfonyComponentHttpFoundationResponse;
{
/**
*/
{
$entity = [...]
$content = $this->renderView('TtsDemoBundle:Prodotto:show.html.twig', array(
'entity' => $entity
));
[...]
return new Response($content);
}
<?php
{
/**
*/
{
$entity = [...]
$content = $this->renderView('TtsDemoBundle:Prodotto:show.html.twig', array(
'entity' => $entity
));
[...]
return new Response($content);
}

Emanuele Gaspari
<?php
{
/**
*/
{
$entity = [...]
$response = new Response($entity->getCodice(), 200, array(
'content-type' => 'text/html'
));
$response->prepare($this->getRequest());
$response->send();
}
<?php
{
/**
*/
{
$entity = [...]
$response = new Response($entity->getCodice(), 200, array(
'content-type' => 'text/html'
));
$response->prepare($this->getRequest());
$response->send();
}

Emanuele Gaspari
json
anche restituire una risposta in formato json è semplice

Emanuele Gaspari
json Response
<?php
use SymfonyComponentHttpFoundationJsonResponse;
public function jsonAction($codice, $slug, $categoria)
{
$entity = [...]
$jsonResponse = array(“codice” => $entity->getCodice(), [...]);
// crea una risposta JSON
$response = new Response(json_encode($jsonResponse));
$response->headers->set('Content-Type', 'application/json');
return $response;
// crea una risposta JSON utilizzando la classe JsonResponse (Symfony >= 2.1)
$response = new JsonResponse();
$response->setData($jsonResponse);
return $response;
}
<?php
use SymfonyComponentHttpFoundationJsonResponse;
public function jsonAction($codice, $slug, $categoria)
{
$entity = [...]
$jsonResponse = array(“codice” => $entity->getCodice(), [...]);
// crea una risposta JSON
$response = new Response(json_encode($jsonResponse));
$response->headers->set('Content-Type', 'application/json');
return $response;
// crea una risposta JSON utilizzando la classe JsonResponse (Symfony >= 2.1)
$response = new JsonResponse();
$response->setData($jsonResponse);
return $response;
}

Emanuele Gaspari
riassunto
●
un array
●
$this->render()
●
$this->renderView()
●
un oggetto Response
●
un oggetto JsonResponse
abbiamo visto che un'azione può utilizzare:
...e può fare molto altro!

Emanuele Gaspari
Routes
Controller e Action
Routes parametriche
annotation @Route
collisione di urls
Request
oggetto Request
i parametri
Response
oggetto Response
redirect
ROUTING

Emanuele Gaspari
redirect
il redirect è un messaggio al browser
cambia l'url perché è effettivamente una nuova richiesta
in caso di:
●
redirect temporaneo (302, default) o permanente (301)
●
invio corretto di un form: redirezione ad una pagina di conferma
●
se il sito è multilingua, si può effettuare un redirect dopo aver scelto la lingua
in base al browser

Emanuele Gaspari
redirect temporaneo
<?php
{
/**
*/
{
return $this->redirect($this->generateUrl('homepage_natale'));
}
}
<?php
{
/**
*/
{
return $this->redirect($this->generateUrl('homepage_natale'));
}
}
redirect temporaneo ad un altro url

Emanuele Gaspari
RedirectResponse
c'è un oggetto dedicato (che sorpresa!) che la Action può
restituire in caso di redirect: RedirectResponse

Emanuele Gaspari
RedirectResponse
<?php
use SymfonyComponentHttpFoundationRedirectResponse
{
/**
* @Route(“/”, name=”homepage”)
*/
{
$respose = new RedirectResponse($this->generateUrl('homepage_natale'));
[..]
return $response;
}
}
<?php
use SymfonyComponentHttpFoundationRedirectResponse
{
/**
* @Route(“/”, name=”homepage”)
*/
{
$respose = new RedirectResponse($this->generateUrl('homepage_natale'));
[..]
return $response;
}
}

Emanuele Gaspari
<?php
{
/**
* @Route("/chisiamo", name=”chisiamo”)
*/
public function chisiamoAction()
{
return $this->redirect($this->generateUrl('homepage_contatti'), 301);
}
}
<?php
{
/**
* @Route("/chisiamo", name=”chisiamo”)
*/
public function chisiamoAction()
{
return $this->redirect($this->generateUrl('homepage_contatti'), 301);
}
}
redirect permanente
redirect permanente con codice di stato HTTP 301

Emanuele Gaspari
Routes
Controller e Action
Routes parametriche
annotation @Route
collisione di urls
Request
oggetto Request
i parametri
Response
oggetto Response
redirect
ROUTING

Emanuele Gaspari
l'azione può passare delle variabili al template restituendo un array
{
[...]
return array(
'entity' => $entity,
'show_extended_version' => true
);
}
{
[...]
return array(
'entity' => $entity,
'show_extended_version' => true
);
}
utilizzabili nel template twig
{% if show_extended_version %}
[...]
{% else %}
<a href=”...”>
{{ entity.codice }}
</a>
{% endif %}
{% if show_extended_version %}
[...]
{% else %}
<a href=”...”>
{{ entity.codice }}
</a>
{% endif %}

TRAIN
TO SYMFONY
Verona, 13•14 Aprile 2013
the frameworkshop
http://traintosymfony.com
@TrainToSymfony
Media partner:©Copyright Emanuele Gaspari Castelletti

Routing (2/3) | Train to Symfony

More Related Content

Similar to Routing (2/3) | Train to Symfony (20)

Routing (2/3) | Train to Symfony