|
|
The symfony Reference BookIl file di configurazione routing.yml |
|
You are currently reading "The symfony Reference Book" which is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported License license.
class url params param options requirements type sfRoute sfRequestRoute sf_method sfObjectRoute model type method allow_empty convert sfPropelRoute method_for_criteria sfDoctrineRoute method_for_query sfRouteCollection sfObjectRouteCollection model actions module prefix_path column with_show segment_names model_methods requirements with_wildcard_routes route_class collection_actions object_actions sfPropelRouteCollection sfDoctrineRouteCollection 
|
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 Unported License. |
Il file di configurazione routing.yml permette la definizione di rotte.
Il file di configurazione principale routing.yml per una applicazione si trova
nella cartella apps/NOME_APP/config/.
Il file di configurazione routing.yml contiene un elenco di definizioni
di rotte, basate su nomi:
ROTTA_1: # definizione della rotta 1 ROTTA_2: # definizione della rotta 2 # ...
Quando arriva una richiesta, il sistema delle rotte prova a confrontare una rotta con
l'URL entrante. La prima rotta che combacia vince, in questo modo l'ordine con il quale sono
definite le rotte nel file di configurazione routing.yml è importante.
Quando viene letto il file di configurazione routing.yml, ciascuna rotta è convertita in
un oggetto della classe class:
NOME_ROTTA: class: NOME_CLASSE # configurazione della rotta
Il nome class dovrebbe estendere la classe base sfRoute. Se così non avviene, come
ripiego è usata la classe base sfRoute.
Il file di configurazione
routing.ymlè messo in cache come file PHP; il processo è gestito automaticamente dalla classesfRoutingConfigHandler.
Il file di configurazione routing.yml supporta diverse impostazioni per configurare
ulteriormente le rotte. Queste impostazioni sono usate dalla classe sfRoutingConfigHandler
per convertire ciascuna rotta in un oggetto.
classPredefinito: sfRoute (o sfRouteCollection se type è collection, vedere sotto)
L'impostazione class consente di cambiare la classe route da usare per la rotta.
urlPredefinito: /
L'impostazione url è lo schema che deve confrontare un URL entrante con la rotta
che deve essere usata per la richiesta corrente.
Lo schema è costituito da segmenti:
:)*) per confrontare una sequenza di coppie chiave/valoreCiascun segmento deve essere separato da uno dei separatori predefiniti
(/ o . per impostazione predefinita).
paramsPredefinito: Un array vuoto
L'impostazione params definisce un array di parametri associati con la rotta.
Possono essere valori predefiniti per variabili contenute nell'url, o qualsiasi altra
pertinente variabile per questa rotta.
paramPredefinito: Un array vuoto
Questa impostazione è equivalente all'impostazione params.
optionsPredefinito: Un array vuoto
L'impostazione options è un array di opzioni che possono essere passate all'oggetto route
per personalizzare ulteriormente il comportamento. Le seguenti sezioni descrivono le
opzioni disponibili per ciascuna classe di rotte.
requirementsPredefinito: Un array vuoto
L'impostazione requirements è un array di requisiti che devono essere soddisfatti
dalle variabili url. Le chiavi sono le variabili url e i valori sono
espressioni regolari a cui i valori della variabile devono corrispondere.
L'espressione regolare sarà inclusa in un'altra espressione regolare, questo vuol dire che non c'è bisogno di racchiuderla tra separatori e non c'è bisogno di delimitarla con
^o$per far corrispondere l'intero valore.
typePredefinito: null
Se valorizzato a collection, la rotta verrà letta come un insieme di rotte.
Questa impostazione è automaticamente valorizzata a
collectiondalla classe che gestisce il config, se il nomeclasscontiene la parolaCollection. Questo significa che, la maggior parte delle volte, non si ha la necessità di usare questa impostazione.
sfRouteTutte le classi per le rotte estendono la classe base sfRoute, che fornisce le
impostazioni richieste per configurare una rotta.
sfRequestRoutesf_methodPredefinito: get
L'opzione sf_method deve essere utilizzata nell'array requirements. Si applica
la richiesta HTTP nel processo di confronto rotte.
sfObjectRouteTutte le seguenti opzioni di sfObjectRoute devono essere utilizzate all'interno dell'impostazione
options del file di configurazione routing.yml.
modelL'opzione model è obbligatoria ed è il nome della classe del modello che è
associato con la rotta corrente.
typeL'opzione type è obbligatoria ed è il tipo di rotta che si vuole per il
modello; essa può essere object o list. Una rotta di tipo object
rappresenta un oggetto per un singolo modello e una rotta di tipo list rappresenta un
insieme di oggetti di modelli.
methodL'opzione method è obbligatoria. È il metodo da chiamare sulla classe del modello
per recuperare l'oggetto o gli oggetti associati a questa rotta. Deve essere un
metodo statico. Il metodo è chiamato con i parametri della rotta scansionata come
parametro.
allow_emptyPredefinito: true
Se l'opzione allow_empty è false, la rotta lancerà una
eccezione 404 se nessun oggetto è restituito dalla chiamata a method di model.
convertPredefinito: toParams
L'opzione convert è un metodo da chiamare per convertire l'oggetto di un modello in un array
di parametri adatto a generare rotte basate su questo oggetto di modello.
Deve restituire un array con almeno i parametri richiesti dallo schema
della rotta (come definito dall'impostazione url).
sfPropelRoutemethod_for_criteriaPredefinito: doSelect per insiemi, doSelectOne per oggetti singoli
L'opzione method_for_criteria definisce il metodo chiamato sulla classe del
modello Peer per recuperare l'oggetto (o gli oggetti) associati con la richiesta corrente. Il
metodo è chiamato con i parametri della rotta scansionata come parametro.
sfDoctrineRoutemethod_for_queryPredefinito: none
L'opzione method_for_query definisce il metodo da chiamare sul modello per
recuperare l'oggetto (o gli oggetti) associati con la richiesta corrente. L'oggetto della richiesta
corrente è passato come parametro.
Se l'opzione non è assegnata, la richiesta è solo "eseguita" con il metodo
execute().
sfRouteCollectionLa classe base sfRouteCollection rappresenta un insieme di rotte.
sfObjectRouteCollectionmodelL'opzione model è obbligatoria ed è il nome della classe del modello che deve essere
associato con la rotta corrente.
actionsPredefinito: false
L'opzione actions definisce un array di azioni autorizzate per la rotta. Le
azioni devono essere un sottoinsieme di tutte le azioni disponibili: list, new, create,
edit, update, delete e show.
Se l'opzione è false, il valore predefinito, tutte le azioni saranno disponibili
eccetto per l'azione show se l'opzione with_show è false (vedere
sotto).
modulePredefinito: Il nome della rotta
L'opzione module definisce il nome del modulo.
prefix_pathPredefinito: / seguito dal nome della rotta
L'opzione prefix_path definisce un prefisso da anteporre a tutti i modelli degli url.
Può essere un qualunque modello valido e può contenere variabili e diversi segmenti.
columnPredefinito: id
L'opzione column definisce la colonna del modello da usare come identificativo
univoco per l'oggetto del modello.
with_showPredefinito: true
L'opzione with_show è usata quando l'opzione actions è false per
determinare se l'azione show deve essere inclusa nell'elenco delle azioni
autorizzate per la rotta.
segment_namesPredefinito: array('edit' => 'edit', 'new' => 'new'),
segment_names definisce le parole da usare nei modelli degli url per le
azioni edit e new.
model_methodsPredefinito: Un array vuoto
L'opzione model_methods definisce i metodi da chiamare per recuperare l'oggetto
(o gli oggetti) dal modello (vedere l'opzione method di sfObjectRoute). Questo
si realizza definendo i metodi list e object:
model_methods: list: getObjects object: getObject
requirementsPredefinito: \d+ per column
L'opzione requirements definisce un array di requisiti da applicare
alle variabili della rotta.
with_wildcard_routesPredefinito: false
L'opzione with_wildcard_routes permette a ogni azione di essere acceduta tramite due
rotte jolly: una per un singolo oggetto e un'altra per insiemi di oggetti.
route_classPredefinito: sfObjectRoute
L'opzione route_class può sovrascrivere l'oggetto della rotta predefinita utilizzata
per l'insieme.
collection_actionsPredefinito: Un array vuoto
L'opzione collection_actions definisce un array di azioni aggiuntive
disponibili per l'insieme di rotte. Le chiavi sono i nomi delle azioni e i valori
sono metodi validi per quelle azioni:
articles:
options:
collection_actions: { filter: post, filterBis: [post, get] }
# ...
object_actionsPredefinito: Un array vuoto
L'opzione object_actions definisce un array di azioni aggiuntive disponibili
per l'oggetto delle rotte. Le chiavi sono i nomi delle azioni e i valori
sono metodi validi per quelle azioni:
articles:
options:
object_actions: { publish: put, publishBis: [post, put] }
# ...
sfPropelRouteCollectionLa classe per la rotta sfPropelRouteCollection estende sfRouteCollection e
cambia la classe predefinita della rotta in sfPropelRoute (vedere sopra
l'opzione route_class).
sfDoctrineRouteCollectionLa classe per la rotta sfDoctrineRouteCollection estende sfRouteCollection,
e cambia la classe predefinita della rotta in sfDoctrineRoute (vedere sopra
l'opzione route_class).
If you find a typo or an error, please register and open a ticket.
If you need support or have a technical question, please post to the official user mailing-list.
