PHP Class Prado\Web\UI\WebControls\TClientScript

Allows importing of Prado Client Scripts from template via the {@link setPradoScripts PradoScripts} property. Multiple Prado client-scripts can be specified using comma delimited string of the javascript library to include on the page. For example,

Custom javascript files can be register using the {@link setScriptUrl ScriptUrl} property.

/>

Contents within TClientScript will be treated as javascript code and will be rendered in place. Since Prado 3.2 the property {@link setFlushScriptFiles FlushScriptFiles} controls whether Prado will flush the script files defined in the page before rendering the TClientScript contents. If you're not using any external functions in your TClientScript block, you should set the {@link setFlushScriptFiles FlushScriptFiles} property to false, so Prado can postpone the loading of all the referenced script files further down the page generation cycle.

Since: 3.0

Inheritance: extends Prado\Web\UI\TControl

Datei anzeigen Open project: pradosoft/prado

Public Methods

Method	Description
getFlushScriptFiles ( ) : boolean
getPradoScripts ( ) : string
getScriptUrl ( ) : string
onPreRender ( $param )	Calls the client script manager to add each of the requested client script libraries.
render ( $writer )	Renders the body content as javascript block.
setFlushScriptFiles ( $value )
setPradoScripts ( $value )	Include javascript library to the current page. The current supported libraries are: "prado", "effects", "ajax", "validator", "logger", "datepicker", "colorpicker". Library dependencies are automatically resolved.
setScriptUrl ( $value )

Protected Methods

Method	Description
renderCustomScript ( $writer )	Registers the body content as javascript.
renderCustomScriptFile ( $writer )	Renders the custom script file.

Method Details

getFlushScriptFiles() public method

public getFlushScriptFiles ( ) : boolean
return	boolean	whether to flush script files using TClientScriptManager::flushScriptFiles() before rendering the script block

getPradoScripts() public method

public getPradoScripts ( ) : string
return	string	comma delimited list of javascript libraries to included on the page.

getScriptUrl() public method

public getScriptUrl ( ) : string
return	string	custom javascript file url.

onPreRender() public method

Calls the client script manager to add each of the requested client script libraries.

public onPreRender ( $param )

render() public method

Overrides parent implementation, parent renderChildren method is called during {@link registerCustomScript}.

public render ( $writer )

renderCustomScript() protected method

Registers the body content as javascript.

protected renderCustomScript ( $writer )

renderCustomScriptFile() protected method

Renders the custom script file.

protected renderCustomScriptFile ( $writer )

setFlushScriptFiles() public method

public setFlushScriptFiles ( $value )

setPradoScripts() public method

Include javascript library to the current page. The current supported libraries are: "prado", "effects", "ajax", "validator", "logger", "datepicker", "colorpicker". Library dependencies are automatically resolved.

public setPradoScripts ( $value )

setScriptUrl() public method

public setScriptUrl ( $value )