PHP Класс Prado\Web\UI\ActiveControls\TTimeTriggeredCallback

TTimeTriggeredCallback sends callback request every {@link setInterval Interval} seconds. Upon each callback request, the {@link onCallback OnCallback} event is raised. The timer can be started by calling {@link startTimer()} and stopped using {@link stopTimer()}. The timer can be automatically started when {@link setStartTimerOnLoad StartTimerOnLoad} is true.

С версии: 3.1

Наследование: extends TCallback

Показать файл Открыть проект

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

Метод	Описание
getInterval ( ) : float
getStartTimerOnLoad ( ) : boolean
render ( $writer )	Registers the javascript code for initializing the active control.
setInterval ( $value )
setStartTimerOnLoad ( $value )
startTimer ( )	Registers the javascript code to start the timer.
stopTimer ( )	Registers the javascript code to stop the timer.

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

Метод	Описание
getClientClassName ( ) : string
getTriggerOptions ( ) : array

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

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

protected getClientClassName ( ) : string
Результат	string	corresponding javascript class name for TTimeTriggeredCallback.

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

public getInterval ( ) : float
Результат	float	seconds between callback requests. Default is 1 second.

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

public getStartTimerOnLoad ( ) : boolean
Результат	boolean	true to start the timer when page loads.

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

protected getTriggerOptions ( ) : array
Результат	array	list of timer options for client-side.

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

Registers the javascript code for initializing the active control.

public render ( $writer )

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

public setInterval ( $value )

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

public setStartTimerOnLoad ( $value )

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

Registers the javascript code to start the timer.

public startTimer ( )

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

Registers the javascript code to stop the timer.

public stopTimer ( )