Bitrix API

Timer implements ITimeLimit

Timer class.

Table of Contents

Interfaces

ITimeLimit

Methods

__construct() : mixed
getTimeLimit() : int: Gets limitation time in seconds.
hasTimeLimitReached() : bool: Tells true if time limit reached.
setTimeLimit() : self: Sets limitation time in seconds.
startTimer() : self: Start up timer.

__construct()


    public
                    __construct([int $timeLimit = -1 ]) : mixed

Parameters

$timeLimit : int = -1: Timeout in seconds.

getTimeLimit()

Gets limitation time in seconds.


    public
                    getTimeLimit() : int

Return values

int

hasTimeLimitReached()

Tells true if time limit reached.


    public
                    hasTimeLimitReached() : bool

Return values

bool

setTimeLimit()

Sets limitation time in seconds.


    public
                    setTimeLimit(int $timeLimit) : self

Parameters

$timeLimit : int: Timeout in seconds.

Return values

self

startTimer()

Start up timer.


    public
                    startTimer([int $startingTime = null ]) : self

Parameters

$startingTime : int = null: Starting time.

Return values

self