PHP Class Prado\TApplicationComponent

TApplicationComponent is the base class for all components that are application-related, such as controls, modules, services, etc. TApplicationComponent mainly defines a few properties that are shortcuts to some commonly used methods. The {@link getApplication Application} property gives the application instance that this component belongs to; {@link getService Service} gives the current running service; {@link getRequest Request}, {@link getResponse Response} and {@link getSession Session} return the request and response modules, respectively; And {@link getUser User} gives the current user instance. Besides, TApplicationComponent defines two shortcut methods for publishing private files: {@link publishAsset} and {@link publishFilePath}.

Since: 3.0

Author: Qiang Xue ([email protected])

Inheritance: extends TComponent

Show file Open project: pradosoft/prado Class Usage Examples

Public Methods

Method	Description
getApplication ( ) : TApplication
getRequest ( ) : THttpRequest
getResponse ( ) : THttpResponse
getService ( ) : prado\IService
getSession ( ) : THttpSession
getUser ( ) : IUser
publishAsset ( $assetPath, $className = null ) : string	Publishes a private asset and gets its URL.
publishFilePath ( $fullPath, $checkTimestamp = false ) : string	Publishes a file or directory and returns its URL.

Method Details

getApplication() public method

public getApplication ( ) : TApplication
return	TApplication	current application instance

getRequest() public method

public getRequest ( ) : THttpRequest
return	THttpRequest	the current user request

getResponse() public method

public getResponse ( ) : THttpResponse
return	THttpResponse	the response

getService() public method

public getService ( ) : prado\IService
return	prado\IService	the current service

getSession() public method

public getSession ( ) : THttpSession
return	THttpSession	user session

getUser() public method

public getUser ( ) : IUser
return	IUser	information about the current user

publishAsset() public method

This method will publish a private asset (file or directory) and gets the URL to the asset. Note, if the asset refers to a directory, all contents under that directory will be published. Also note, it is recommended that you supply a class name as the second parameter to the method (e.g. publishAsset($assetPath,__CLASS__) ). By doing so, you avoid the issue that child classes may not work properly because the asset path will be relative to the directory containing the child class file.

public publishAsset ( $assetPath, $className = null ) : string
return	string	URL to the asset path.

publishFilePath() public method

Publishes a file or directory and returns its URL.

public publishFilePath ( $fullPath, $checkTimestamp = false ) : string
return	string	URL to the published file or directory