• Accueil
• Prado
• TApplication

PHP Class Prado\TApplication

TApplication coordinates modules and services, and serves as a configuration context for all Prado components. TApplication uses a configuration file to specify the settings of the application, the modules, the services, the parameters, and so on. TApplication adopts a modular structure. A TApplication instance is a composition of multiple modules. A module is an instance of class implementing {@link IModule} interface. Each module accomplishes certain functionalities that are shared by all Prado components in an application. There are default modules and user-defined modules. The latter offers extreme flexibility of extending TApplication in a plug-and-play fashion. Modules cooperate with each other to serve a user request by following a sequence of lifecycles predefined in TApplication. TApplication has four modes that can be changed by setting {@link setMode Mode} property (in the application configuration file). - Off mode will prevent the application from serving user requests. - Debug mode is mainly used during application development. It ensures the cache is always up-to-date if caching is enabled. It also allows exceptions are displayed with rich context information if they occur. - Normal mode is mainly used during production stage. Exception information will only be recorded in system error logs. The cache is ensured to be up-to-date if it is enabled. - Performance mode is similar to Normal mode except that it does not ensure the cache is up-to-date. TApplication dispatches each user request to a particular service which finishes the actual work for the request with the aid from the application modules. TApplication maintains a lifecycle with the following stages: - [construct] : construction of the application instance - [initApplication] : load application configuration and instantiate modules and the requested service - onBeginRequest : this event happens right after application initialization - onAuthentication : this event happens when authentication is needed for the current request - onAuthenticationComplete : this event happens right after the authentication is done for the current request - onAuthorization : this event happens when authorization is needed for the current request - onAuthorizationComplete : this event happens right after the authorization is done for the current request - onLoadState : this event happens when application state needs to be loaded - onLoadStateComplete : this event happens right after the application state is loaded - onPreRunService : this event happens right before the requested service is to run - runService : the requested service runs - onSaveState : this event happens when application needs to save its state - onSaveStateComplete : this event happens right after the application saves its state - onPreFlushOutput : this event happens right before the application flushes output to client side. - flushOutput : the application flushes output to client side. - onEndRequest : this is the last stage a request is being completed - [destruct] : destruction of the application instance Modules and services can attach their methods to one or several of the above events and do appropriate processing when the events are raised. By this way, the application is able to coordinate the activities of modules and services in the above order. To terminate an application before the whole lifecycle completes, call {@link completeRequest}. Examples: - Create and run a Prado application: $application=new TApplication($configFile); $application->run(); Afficher le fichier Open project: pradosoft/prado

Méthodes publiques

Méthode	Description
__construct ( $basePath = 'protected', $cacheConfig = true, $configType = self::CONFIG_TYPE_XML )	Constructor.
applyConfiguration ( $config, $withinService = false )	Applies an application configuration.
clearGlobalState ( $key )	Clears a global value.
completeRequest ( )	Completes current request processing.
flushOutput ( $continueBuffering = true )	Flushes output to client side.
getApplicationStatePersister ( ) : prado\IStatePersister
getAssetManager ( ) : TAssetManager
getAuthorizationRules ( ) : TAuthorizationRuleCollection
getBasePath ( ) : string
getCache ( ) : ICache
getConfigurationFile ( ) : string
getConfigurationFileExt ( ) : string
getConfigurationFileName ( ) : string
getConfigurationType ( ) : string
getErrorHandler ( ) : TErrorHandler
getGlobalState ( $key, $defaultValue = null ) : mixed	Returns a global value.
getGlobalization ( $createIfNotExists = true ) : TGlobalization
getID ( ) : string
getMode ( ) : TApplicationMode
getModule ( $id ) : prado\IModule
getModules ( ) : array	Returns a list of application modules indexed by module IDs.
getPageServiceID ( ) : string
getParameters ( ) : TMap	Returns the list of application parameters.
getRequest ( ) : THttpRequest
getRequestCompleted ( ) : boolean
getResponse ( ) : THttpResponse
getRuntimePath ( ) : string
getSecurityManager ( ) : TSecurityManager
getService ( ) : prado\IService
getSession ( ) : THttpSession
getUniqueID ( ) : string
getUser ( ) : IUser
onAuthentication ( )	Raises OnAuthentication event.
onAuthenticationComplete ( )	Raises OnAuthenticationComplete event.
onAuthorization ( )	Raises OnAuthorization event.
onAuthorizationComplete ( )	Raises OnAuthorizationComplete event.
onBeginRequest ( )	Raises OnBeginRequest event.
onEndRequest ( )	Raises OnEndRequest event.
onError ( $param )	Raises OnError event.
onLoadState ( )	Raises OnLoadState event.
onLoadStateComplete ( )	Raises OnLoadStateComplete event.
onPreFlushOutput ( )	Raises OnPreFlushOutput event.
onPreRunService ( )	Raises OnPreRunService event.
onSaveState ( )	Raises OnSaveState event.
onSaveStateComplete ( )	Raises OnSaveStateComplete event.
run ( )	Executes the lifecycles of the application.
runService ( )	Runs the requested service.
setApplicationStatePersister ( prado\IStatePersister $persister )
setAssetManager ( TAssetManager $value )
setBasePath ( $value )
setCache ( Prado\Caching\ICache $cache )
setConfigurationFile ( $value )
setConfigurationType ( $value )
setErrorHandler ( TErrorHandler $handler )
setGlobalState ( $key, $value, $defaultValue = null, $forceSave = false )	Sets a global value.
setGlobalization ( TGlobalization $glob )
setID ( $value )
setMode ( $value )
setModule ( $id, prado\IModule $module = null )	Adds a module to application.
setPageServiceID ( $value )
setRequest ( THttpRequest $request )
setResponse ( THttpResponse $response )
setRuntimePath ( $value )
setSecurityManager ( TSecurityManager $sm )
setService ( $value )
setSession ( THttpSession $session )
setUser ( Prado\Security\IUser $user )
startService ( $serviceID )	Starts the specified service.

Méthodes protégées

Méthode	Description
getApplicationConfigurationClass ( )
initApplication ( )	Loads configuration and initializes application.
internalLoadModule ( $id, $force = false )
loadGlobals ( )	Loads global values from persistent storage.
resolvePaths ( $basePath )	Resolves application-relevant paths.
saveGlobals ( )	Saves global values into persistent storage.

Method Details