PHP Класс Prado\Web\UI\TClientScriptManager

TClientScriptManager manages javascript and CSS stylesheets for a page.
С версии: 3.0
Автор: Qiang Xue ([email protected])
Наследование: extends Prado\TApplicationComponent
Показать файл Открыть проект

Открытые методы

Метод Описание
__construct ( TPage $owner ) Constructor.
flushScriptFiles ( $writer, $control = null ) Flushes all pending script registrations
getCallbackReference ( Prado\Web\UI\ActiveControls\ICallbackEventHandler $callbackHandler, $options = null ) : string Returns javascript statement that create a new callback request object.
getHiddenFields ( )
getPradoPackages ( )
getPradoScriptAssetPath ( $script = 'prado' ) : string
getPradoScriptAssetUrl ( $script = 'prado' ) : string
getPradoScripts ( )
getRequiresHead ( ) : boolean
getScriptUrls ( ) : array Returns the URLs of all script files referenced on the page
getStyleSheetCodes ( ) : array Returns all the stylesheet code snippets referenced on the page
getStyleSheetUrls ( ) : array Returns the URLs of all stylesheet files referenced on the page
hasBeginScripts ( ) : boolean
hasEndScripts ( ) : boolean
isBeginScriptRegistered ( $key ) : boolean
isEndScriptRegistered ( $key ) : boolean
isHeadScriptFileRegistered ( $key ) : boolean
isHeadScriptRegistered ( $key ) : boolean
isHiddenFieldRegistered ( $key ) : boolean
isScriptFileRegistered ( $key ) : boolean
isStyleSheetFileRegistered ( $key ) : boolean
isStyleSheetRegistered ( $key ) : boolean
markScriptFileAsRendered ( $url )
registerBeginScript ( $key, $script ) Registers a javascript script block at the beginning of the form
registerCallbackControl ( $class, $options ) Registers callback javascript for a control.
registerDefaultButton ( $panel, $button ) Register a default button to panel. When the $panel is in focus and the 'enter' key is pressed, the $button will be clicked.
registerEndScript ( $key, $script ) Registers a javascript script block at the end of the form
registerFocusControl ( $target ) Registers the control to receive default focus.
registerHeadScript ( $key, $script ) Registers a javascript block in the page head.
registerHeadScriptFile ( $key, $url ) Registers a javascript file in the page head
registerHiddenField ( $name, $value ) Registers a hidden field to be rendered in the form.
registerPostBackControl ( $class, $options ) Registers postback javascript for a control. A null class parameter will prevent the javascript code registration.
registerPradoScript ( $name ) Registers Prado javascript by library name. See "Web/Javascripts/packages.php" for library names.
registerPradoStyle ( $name ) Registers Prado style by library name. See "Web/Javascripts/packages.php" for library names.
registerScriptFile ( $key, $url ) Registers a javascript file to be rendered within the form
registerStyleSheet ( $key, $css, $media = '' ) Registers a CSS block to be rendered in the page head
registerStyleSheetFile ( $key, $url, $media = '' ) Registers a CSS file to be rendered in the page head
renderAllPendingScriptFiles ( $writer )
renderBeginScripts ( $writer )
renderBeginScriptsCallback ( $writer )
renderEndScripts ( $writer )
renderEndScriptsCallback ( $writer )
renderHeadScriptFiles ( $writer )
renderHeadScripts ( $writer )
renderHiddenFieldsBegin ( $writer )
renderHiddenFieldsEnd ( $writer )
renderScriptFilesBegin ( $writer )
renderScriptFilesEnd ( $writer )
renderStyleSheetFiles ( $writer )
renderStyleSheets ( $writer )

Защищенные методы

Метод Описание
checkIfNotInRender ( ) Checks whether page rendering has not begun yet
getDefaultButtonOptions ( $panelID, $buttonID ) : array
getPackagePathUrl ( $base ) : array
getRenderedScriptFiles ( )
getScriptPackageFolder ( $script ) : array
getStylePackageFolder ( $script ) : array
registerPradoScriptInternal ( $name ) Registers a Prado javascript library to be loaded.
registerPradoStyleInternal ( $name ) Registers a Prado style library to be loaded.
renderHiddenFieldsInt ( $writer, $initial )
renderScriptFiles ( $writer, array $scripts )

Описание методов

__construct() публичный Метод

Constructor.
public __construct ( TPage $owner )
$owner TPage

checkIfNotInRender() защищенный Метод

Checks whether page rendering has not begun yet
protected checkIfNotInRender ( )

flushScriptFiles() публичный Метод

Flushes all pending script registrations
public flushScriptFiles ( $writer, $control = null )

getCallbackReference() публичный Метод

Returns javascript statement that create a new callback request object.
public getCallbackReference ( Prado\Web\UI\ActiveControls\ICallbackEventHandler $callbackHandler, $options = null ) : string
$callbackHandler Prado\Web\UI\ActiveControls\ICallbackEventHandler
Результат string javascript statement that creates a new callback request.

getDefaultButtonOptions() защищенный Метод

protected getDefaultButtonOptions ( $panelID, $buttonID ) : array
Результат array default button options.

getHiddenFields() публичный Метод

public getHiddenFields ( )

getPackagePathUrl() защищенный Метод

protected getPackagePathUrl ( $base ) : array
Результат array tuple($path,$url).

getPradoPackages() публичный статический Метод

public static getPradoPackages ( )

getPradoScriptAssetPath() публичный Метод

public getPradoScriptAssetPath ( $script = 'prado' ) : string
Результат string Prado javascript library base asset path in local filesystem.

getPradoScriptAssetUrl() публичный Метод

public getPradoScriptAssetUrl ( $script = 'prado' ) : string
Результат string Prado javascript library base asset url.

getPradoScripts() публичный статический Метод

public static getPradoScripts ( )

getRenderedScriptFiles() защищенный Метод

protected getRenderedScriptFiles ( )

getRequiresHead() публичный Метод

С версии: 3.1.1
public getRequiresHead ( ) : boolean
Результат boolean whether THead is required in order to render CSS and js within head

getScriptPackageFolder() защищенный Метод

protected getScriptPackageFolder ( $script ) : array
Результат array tuple($basepath,$subpath).

getScriptUrls() публичный Метод

Returns the URLs of all script files referenced on the page
public getScriptUrls ( ) : array
Результат array Combined list of all script urls used in the page

getStylePackageFolder() защищенный Метод

protected getStylePackageFolder ( $script ) : array
Результат array tuple($basepath,$subpath).

getStyleSheetCodes() публичный Метод

Returns all the stylesheet code snippets referenced on the page
public getStyleSheetCodes ( ) : array
Результат array List of all stylesheet snippets used in the page

getStyleSheetUrls() публичный Метод

Returns the URLs of all stylesheet files referenced on the page
public getStyleSheetUrls ( ) : array
Результат array List of all stylesheet urls used in the page

hasBeginScripts() публичный Метод

public hasBeginScripts ( ) : boolean
Результат boolean true if any begin scripts are registered.

hasEndScripts() публичный Метод

public hasEndScripts ( ) : boolean
Результат boolean true if any end scripts are registered.

isBeginScriptRegistered() публичный Метод

public isBeginScriptRegistered ( $key ) : boolean
Результат boolean whether there is a beginning javascript block registered with the specified key

isEndScriptRegistered() публичный Метод

public isEndScriptRegistered ( $key ) : boolean
Результат boolean whether there is an ending javascript block registered with the specified key

isHeadScriptFileRegistered() публичный Метод

public isHeadScriptFileRegistered ( $key ) : boolean
Результат boolean whether there is a head javascript file registered with the specified key

isHeadScriptRegistered() публичный Метод

public isHeadScriptRegistered ( $key ) : boolean
Результат boolean whether there is a head javascript block registered with the specified key

isHiddenFieldRegistered() публичный Метод

public isHiddenFieldRegistered ( $key ) : boolean
Результат boolean whether there is a hidden field registered with the specified key

isScriptFileRegistered() публичный Метод

public isScriptFileRegistered ( $key ) : boolean
Результат boolean whether there is a javascript file registered with the specified key

isStyleSheetFileRegistered() публичный Метод

public isStyleSheetFileRegistered ( $key ) : boolean
Результат boolean whether there is a CSS file registered with the specified key

isStyleSheetRegistered() публичный Метод

public isStyleSheetRegistered ( $key ) : boolean
Результат boolean whether there is a CSS block registered with the specified key

markScriptFileAsRendered() публичный Метод

public markScriptFileAsRendered ( $url )

registerBeginScript() публичный Метод

Registers a javascript script block at the beginning of the form
public registerBeginScript ( $key, $script )

registerCallbackControl() публичный Метод

Registers callback javascript for a control.
public registerCallbackControl ( $class, $options )

registerDefaultButton() публичный Метод

Register a default button to panel. When the $panel is in focus and the 'enter' key is pressed, the $button will be clicked.
public registerDefaultButton ( $panel, $button )

registerEndScript() публичный Метод

Registers a javascript script block at the end of the form
public registerEndScript ( $key, $script )

registerFocusControl() публичный Метод

Registers the control to receive default focus.
public registerFocusControl ( $target )

registerHeadScript() публичный Метод

Registers a javascript block in the page head.
public registerHeadScript ( $key, $script )

registerHeadScriptFile() публичный Метод

Registers a javascript file in the page head
public registerHeadScriptFile ( $key, $url )

registerHiddenField() публичный Метод

Registers a hidden field to be rendered in the form.
public registerHiddenField ( $name, $value )

registerPostBackControl() публичный Метод

Registers postback javascript for a control. A null class parameter will prevent the javascript code registration.
public registerPostBackControl ( $class, $options )

registerPradoScript() публичный Метод

Registers Prado javascript by library name. See "Web/Javascripts/packages.php" for library names.
public registerPradoScript ( $name )

registerPradoScriptInternal() защищенный Метод

Registers a Prado javascript library to be loaded.
protected registerPradoScriptInternal ( $name )

registerPradoStyle() публичный Метод

Registers Prado style by library name. See "Web/Javascripts/packages.php" for library names.
public registerPradoStyle ( $name )

registerPradoStyleInternal() защищенный Метод

Registers a Prado style library to be loaded.
protected registerPradoStyleInternal ( $name )

registerScriptFile() публичный Метод

Registers a javascript file to be rendered within the form
public registerScriptFile ( $key, $url )

registerStyleSheet() публичный Метод

Registers a CSS block to be rendered in the page head
public registerStyleSheet ( $key, $css, $media = '' )

registerStyleSheetFile() публичный Метод

The CSS files in themes are registered in {@link OnPreRenderComplete onPreRenderComplete} if you want to override CSS styles in themes you need to register it after this event is completed. Example: Page->ClientScript->registerStyleSheetFile($url, $url); } }
public registerStyleSheetFile ( $key, $url, $media = '' )

renderAllPendingScriptFiles() публичный Метод

public renderAllPendingScriptFiles ( $writer )

renderBeginScripts() публичный Метод

public renderBeginScripts ( $writer )

renderBeginScriptsCallback() публичный Метод

public renderBeginScriptsCallback ( $writer )

renderEndScripts() публичный Метод

public renderEndScripts ( $writer )

renderEndScriptsCallback() публичный Метод

public renderEndScriptsCallback ( $writer )

renderHeadScriptFiles() публичный Метод

public renderHeadScriptFiles ( $writer )

renderHeadScripts() публичный Метод

public renderHeadScripts ( $writer )

renderHiddenFieldsBegin() публичный Метод

public renderHiddenFieldsBegin ( $writer )

renderHiddenFieldsEnd() публичный Метод

public renderHiddenFieldsEnd ( $writer )

renderHiddenFieldsInt() защищенный Метод

protected renderHiddenFieldsInt ( $writer, $initial )

renderScriptFiles() защищенный Метод

protected renderScriptFiles ( $writer, array $scripts )
$scripts array

renderScriptFilesBegin() публичный Метод

public renderScriptFilesBegin ( $writer )

renderScriptFilesEnd() публичный Метод

public renderScriptFilesEnd ( $writer )

renderStyleSheetFiles() публичный Метод

public renderStyleSheetFiles ( $writer )

renderStyleSheets() публичный Метод

public renderStyleSheets ( $writer )