I factory sono oggetti del core necessari al framework durante la vita di ogni richiesta.
Sono inizializzati nel file di configurazione factories.yml e sempre accessibili tramite l'oggetto
sfContext:
// restituisce il factory per l'oggetto User sfContext::getInstance()->getUser();
Per una applicazione il file di configurazione factories.yml può essere trovato nella cartella
apps/NOME_APP/config/.
Come abbiamo detto durante l'introduzione, il file factories.yml è
consapevole dell'ambiente, beneficia del
meccanismo di configurazione a cascata,
e può includere costanti.
Il file di configurazione factories.yml contiene un elenco di dichiarazioni di factory:
FACTORY_1: # definizione del factory 1 FACTORY_2: # definizione del factory 2 # ...
I nomi dei factory supportati sono: controller, logger, i18n, request,
response, routing, storage, user, view_cache, e
view_cache_manager.
Quando sfContext inizializza i factory, legge dal file factories.yml
i nomi delle classi dei factory (class) ed i relativi parametri (param)
per configurare i corrispettivi oggetti:
NOME_DEL_FACTORY:
class: NOME_DELLA_CLASSE
param: { ARRAY DI PARAMETRI }
La possibilità di modificare i factory significa che è possibile usare una classe personalizzata per istanziare un oggetto del core di symfony piuttosto che quella predefinita. È inoltre possibile cambiare anche il comportamento di queste classi modificando i parametri inviati alle stesse.
Se la classe di un factory non può essere caricata automaticamente, deve essere definito
un parametro file che sarà utilizzato per indicare il percorso della classe che verrà
automaticamente usato prima che il factory sia creato:
FACTORY_NAME: class: NOME_DELLA_CLASSE file: PERCORSO_ASSOLUTO_DEL_FILE
note
Il file di configurazione factories.yml viene salvato in cache come file PHP; Il processo
è automaticamente gestito dalla classe
sfFactoryConfigHandler.
Factory
request
sfContext Accessor: $context->getRequest()
Configurazione standard:
request:
class: sfWebRequest
param:
logging: %SF_LOGGING_ENABLED%
path_info_array: SERVER
path_info_key: PATH_INFO
relative_url_root: ~
formats:
txt: text/plain
js: [application/javascript, application/x-javascript, text/javascript]
css: text/css
json: [application/json, application/x-json]
xml: [text/xml, application/xml, application/x-xml]
rdf: application/rdf+xml
atom: application/atom+xml
path_info_array
L'opzione path_info_array definisce l'array PHP globale che sarà usato per recuperare informazioni.
In alcune configurazioni il valore predefinito potrebbe essere cambiato da SERVER ad ENV.
path_info_key
L'opzione path_info_key definisce la chiave sotto la quale l'informazione relativa a PATH_INFO
può essere trovata.
Se è usato IIS con un modulo di riscrittura delle URL come IIFR o ISAPI, è necessario impostare questo parametro
a HTTP_X_REWRITE_URL.
formats
L'opzione formats definisce un array di estensioni di file ed il corrispettivo
Content-Type. È usata automaticamente dal framework per gestire il Content-Type di una risposta,
in base all'estensione dell'URI richiesta.
relative_url_root
L'opzione relative_url_root definisce la parte di URL che precede il front
controller. Normalmente, è automaticamente gestita dal framework e non necessita
cambiamenti.
response
sfContext Accessor: $context->getResponse()
Configurazione standard:
response:
class: sfWebResponse
param:
logging: %SF_LOGGING_ENABLED%
charset: %SF_CHARSET%
send_http_headers: true
Configurazione standard per l'ambiente di test:
response:
class: sfWebResponse
param:
send_http_headers: false
send_http_headers
L'opzione send_http_headers specifica quando deve essere inviato un
header di risposta insieme al contenuto della risposta. Questa opzione è particolarmente
comoda per fare test, in quanto gli header sono inviati tramite la funzione PHP
header(), che invia un warning se si sta provando ad inviare header dopo qualche tipo
di output.
charset
L'opzione charset definisce il charset da utilizzare nella risposta. Il valore predefinito,
preso dal parametro charset nel file settings.yml, è quello che serve la maggior parte
delle volte.
http_protocol
L'opzione http_protocol definisce la versione del protocollo HTTP da utilizzare
per la risposta. Come valore predefinito utilizza $_SERVER['SERVER_PROTOCOL']
altrimenti usa HTTP/1.0.
user
sfContext Accessor: $context->getUser()
Configurazione standard:
user:
class: myUser
param:
timeout: 1800
logging: %SF_LOGGING_ENABLED%
use_flash: true
default_culture: %SF_DEFAULT_CULTURE%
note
La classe myUser eredita da sfBasicSecurityUser,
che può essere configurata nel file di configurazione
security.yml.
timeout
L'opzione timeout definisce il timeout per l'autenticazione utente.
Non è correlata al timeout della sessione. Il valore predefinito rimuove l'autenticazione
ad un utente dopo 30 minuti di inattività.
Questa impostazione è usata solo dalle classi user che ereditano dalla classe base
sfBasicSecurityUser, come nel caso della classe generata dal sistema myUser.
note
Per evitare comportamenti inaspettati, la classe user forza automaticamente la massima durata
per il garbage collector delle sessioni (session.gc_maxlifetime) in modo che
sia maggiore, o uguale, al timeout.
use_flash
L'opzione use_flash abilita o disabilita il componente flash.
default_culture
L'opzione default_culture definisce la direttiva di traduzione da usare per
l'utente che entra nel sito per la prima volta. Se non dichiarato, utilizza il valore
default_culture impostato nel file settings.yml.
caution
Se l'impostazione default_culture viene cambiata in factories.yml o
in settings.yml, è necessario eliminare i cookie del browser per vedere le modifiche.
storage
Il factory storage è usato dal factory user per salvare i dati dell'utente tra una richiesta HTTP e l'altra.
sfContext Accessor: $context->getStorage()
Configurazione standard:
storage:
class: sfSessionStorage
param:
session_name: symfony
Configurazione standard per l'ambiente di test:
storage:
class: sfSessionTestStorage
param:
session_path: %SF_TEST_CACHE_DIR%/sessions
auto_start
L'opzione auto_start abilita o disabilita la partenza automatica della sessione di PHP
(usando la funzione session_start() del linguaggio).
session_name
L'opzione session_name definisce il nome del cookie usato da symfony per
memorizzare la sessione utente. Per impostazione predefinita, il nome è symfony, il che significa che
tutte le applicazioni condividono lo stesso cookie (e quindi anche le corrispondenti
autenticazioni e autorizzazioni).
session_set_cookie_params() parameters
Il factory storage chiama la funzione
session_set_cookie_params()
con il valore delle seguenti opzioni:
session_cookie_lifetime: Durata del cookie di sessione, definita in secondi.session_cookie_path: Percorso sul dominio dove il cookie andrà a lavorare. Usare una barra singola (/) per tutti i percorsi sul dominio.session_cookie_domain: Dominio del cookie, per esempiowww.php.net. Per rendere visibili i cookie su tutti i sotto domini, il dominio deve essere preceduto da un punto, come.php.net.session_cookie_secure: Setrue, il cookie sarà inviato solo su connessioni sicure.session_cookie_httponly: Setrue, PHP tenterà di inviare il flaghttponlyquando imposta il cookie di sessione.
note
La descrizione di ciascuna opzione proviene dalla descrizione della funzione
session_set_cookie_params() presente sul sito web del PHP
session_cache_limiter
Se l'opzione session_cache_limiter è assegnata, la funzione PHP
session_cache_limiter()
è chiamata e il valore dell'opzione è passato come parametro.
Database Storage-specific Options
Quando si utilizza uno storage che eredita dalla classe sfDatabaseSessionStorage,
sono disponibili molte altre opzioni:
database: Il nome del database (necessario)db_table: Il nome della tabella (necessario)db_id_col: Il nome della colonna della chiave primaria (sess_idper impostazione predefinita)db_data_col: Il nome della colonna con i dati (sess_dataper impostazione predefinita)db_time_col: Il nome della colonna con il tempo (sess_timeper impostazione predefinita)
view_cache_manager
sfContext Accessor: $context->getViewCacheManager()
Configurazione standard:
view_cache_manager: class: sfViewCacheManager
caution
Questo factory è creato solo se l'impostazione cache
è on.
La configurazione del gestore della cache della vista non include una chiave param. Questa
configurazione è fatta attraverso il factory view_cache, che definisce il
sottostante oggetto cache usato dal gestore della cache della vista.
view_cache
sfContext Accessor: none (usato direttamente dal factory view_cache_manager)
Configurazione standard:
view_cache:
class: sfFileCache
param:
automatic_cleaning_factor: 0
cache_dir: %SF_TEMPLATE_CACHE_DIR%
lifetime: 86400
prefix: %SF_APP_DIR%/template
caution
Questo factory è definito solo se l'impostazione cache
è on.
Il factory view_cache definisce una classe cache che deve ereditare da
sfCache (vedere la sezione Cache per maggiori informazioni).
i18n
sfContext Accessor: $context->getI18N()
Configurazione standard:
i18n:
class: sfI18N
param:
source: XLIFF
debug: off
untranslated_prefix: "[T]"
untranslated_suffix: "[/T]"
cache:
class: sfFileCache
param:
automatic_cleaning_factor: 0
cache_dir: %SF_I18N_CACHE_DIR%
lifetime: 31556926
prefix: %SF_APP_DIR%/i18n
caution
Questo factory è definito solo se l'impostazione i18n
è on.
source
L'opzione source definisce il tipo di contenitore per le traduzioni.
Built-in containers: XLIFF, SQLite, MySQL, and gettext.
debug
L'opzione debug imposta la modalità debug. Se on, i messaggi
non tradotti sono decorati con un prefisso e un suffisso (vedere sotto).
untranslated_prefix
untranslated_prefix definisce un prefisso da usare per i messaggi non tradotti.
untranslated_suffix
untranslated_suffix definisce un suffisso da usare per i messaggi non tradotti.
cache
L'opzione cache definisce un factory cache anonimo da usare per mettere
in cache i dati i18n (vedere la sezione Cache per maggiori informazioni).
routing
sfContext Accessor: $context->getRouting()
Configurazione standard:
routing:
class: sfPatternRouting
param:
load_configuration: true
suffix: ''
default_module: default
default_action: index
debug: %SF_DEBUG%
logging: %SF_LOGGING_ENABLED%
generate_shortest_url: true
extra_parameters_as_query_string: true
cache:
class: sfFileCache
param:
automatic_cleaning_factor: 0
cache_dir: %SF_CONFIG_CACHE_DIR%/routing
lifetime: 31556926
prefix: %SF_APP_DIR%/routing
variable_prefixes
Predefinito: :
L'opzione variable_prefixes definisce l'elenco dei caratteri che iniziano un
nome variabile in uno schema di rotta.
segment_separators
Predefinito: / and .
L'opzione segment_separators definisce l'elenco dei separatori delle parti di rotta.
La maggior parte delle volte, non si vuole sovrascrivere questa opzione per tutte le
rotte, ma per alcune specifiche rotte.
generate_shortest_url
Predefinito: true per i nuovi progetti, false per i progetti aggiornati
Se true, l'opzione generate_shortest_url chiederà al sistema
per le rotte di generare la rotta più corta possibile. Impostare a false se si vuole
che le rotte siano retrocompatibili con symfony 1.0 e 1.1.
extra_parameters_as_query_string
Predefinito: true per i nuovi progetti, false per i progetti aggiornati
Se alcuni parametri non sono utilizzati per la generazione di una rotta,
extra_parameters_as_query_string permette ai parametri aggiuntivi di essere
convertiti in una query string. Settare a false per tornare al comportamento di
symfony 1.0 o 1.1. In queste versioni, i parametri extra erano semplicemente ignorati
dal sistema delle rotte.
cache
L'opzione cache definisce un factory cache anonimo da usare per mettere in cache
la configurazione delle rotte e i dati (vedere la sezione Cache per maggiori informazioni).
suffix
Predefinito: none
Il suffisso predefinito da utilizzare per tutte le rotte. Questa opzione è deprecata e non è più di nessuna utilità.
load_configuration
Predefinito: true
L'opzione load_configuration definisce se i file routing.yml devono
essere automaticamente caricati ed elaborati. Impostare a false se si vuole usare il
sistema delle rotte di symfony fuori da un progetto symfony.
lazy_routes_deserialize
Predefinito: false
Se true, l'impostazione lazy_routes_deserialize abilita la
de-serializzazione "lazy" della cache delle rotte. Questa opzione può migliorare le
prestazioni delle applicazioni se si ha un elevato numero di rotte e se la maggior parte
delle corrispondenze con le rotte sono collocate nelle prime posizioni. Si consiglia vivamente
di verificare l'impostazione prima di andare in produzione, perché in certe circostanze
può fare degradare le prestazioni.
caution
Questa impostazione è disponibile solo per symfony 1.2.7 o superiore.
lookup_cache_dedicated_keys
Predefinito: false
L'impostazione lookup_cache_dedicated_keys determina come la cache del routing è
costruita. Se false, la cache è memorizzata come un solo grande valore; se
true, ciascuna rotta ha la sua memorizzazione nella cache. Questa impostazione
ottimizza le prestazioni.
Come regola generale, l'impostazione a false è migliore quando si usa una classe cache
basata su file (per esempio sfFileCache), l'impostazione a true è migliore
quando si usa una classe cache basata sulla memoria (per esempio sfAPCCache).
caution
Questo parametro è disponibile solo dalla versione 1.2.7 in poi di symfony.
logger
sfContext Accessor: $context->getLogger()
Configurazione standard:
logger:
class: sfAggregateLogger
param:
level: debug
loggers:
sf_web_debug:
class: sfWebDebugLogger
param:
level: debug
condition: %SF_WEB_DEBUG%
xdebug_logging: true
web_debug_class: sfWebDebug
sf_file_debug:
class: sfFileLogger
param:
level: debug
file: %SF_LOG_DIR%/%SF_APP%_%SF_ENVIRONMENT%.log
Configurazione standard per l'ambiente prod:
logger:
class: sfNoLogger
param:
level: err
loggers: ~
caution
Questo factory è sempre definito, ma il logging si verifica soltanto se
l'impostazione logging_enabled è on.
level
L'opzione level definisce il livello del logger.
Possibili valori: EMERG, ALERT, CRIT, ERR, WARNING, NOTICE,
INFO, or DEBUG.
loggers
L'opzione loggers definisce un elenco di logger da usare. L'elenco è un array di
factory logger anonimi.
Built-in logger classes: sfConsoleLogger, sfFileLogger, sfNoLogger,
sfStreamLogger, and sfVarLogger.
controller
sfContext Accessor: $context->getController()
Configurazione standard:
controller: class: sfFrontWebController
Factory cache anonimi
Alcuni factory (view_cache, i18n e routing) possono trarre vantaggio da
un oggetto cache se definito nella loro configurazione. La configurazione
dell'oggetto cache è simile per tutti i factory. La chiave cache definisce un
factory cache anonimo. Come ogni altro factory, accetta le voci class e
param. La voce param può accettare qualunque opzione disponibile per la data
classe cache.
L'opzione prefix è la più importante, dal momento che permette di condividere o
separare una cache tra differenti ambienti/applicazioni/progetti.
Classi cache disponibili: sfAPCCache, sfEAcceleratorCache, sfFileCache,
sfMemcacheCache, sfNoCache, sfSQLiteCache, e sfXCacheCache.
This work is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported License license.