Class TApplicationComponent
Direct Known Sub-classes:
TClientScriptManager
, TControlAdapter
, TCallbackClientScript
, TTheme
, TDataGridColumn
, TTemplate
, TControl
, THtmlWriter
, THttpResponseAdapter
, TSoapServer
, TJsonResponse
, THttpRequest
, THttpSession
, TLogRoute
, TService
, TModule
TApplicationComponent class
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 Application property gives the application instance that this component belongs to; Service gives the current running service; Request, Response and Session return the request and response modules, respectively; And User gives the current user instance. Besides, TApplicationComponent defines two shortcut methods for publishing private files: publishAsset and publishFilePath.
Methods Inherited From TComponent |
TComponent::addParsedObject(), TComponent::attachEventHandler(), TComponent::canGetProperty(), TComponent::canSetProperty(), TComponent::createdOnTemplate(), TComponent::detachEventHandler(), TComponent::evaluateExpression(), TComponent::evaluateStatements(), TComponent::getEventHandlers(), TComponent::getSubProperty(), TComponent::hasEvent(), TComponent::hasEventHandler(), TComponent::hasProperty(), TComponent::raiseEvent(), TComponent::setSubProperty(), TComponent::__get(), TComponent::__set()
|
Method Details |
getApplication
|
getRequest
|
getResponse
|
getService
Output |
IService
| the current service |
Exception |
|
getSession
|
getUser
Output |
IUser
| information about the current user |
Exception |
|
publishAsset
public string publishAsset |
(string $assetPath , string $className ) |
Publishes a private asset and gets its URL.
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.
Input |
string | $assetPath | path of the asset that is relative to the directory containing the specified class file. |
string | $className | name of the class whose containing directory will be prepend to the asset path. If null, it means get_class($this). |
Output |
string
| URL to the asset path. |
Exception |
|
publishFilePath
public string publishFilePath |
(string $fullPath ) |
Publishes a file or directory and returns its URL.
Input |
string | $fullPath | absolute path of the file or directory to be published |
Output |
string
| URL to the published file or directory |
Exception |
|
|