Bitrix API

Preset extends Stepper

FinalYes

Class Stepper

Table of Contents

Constants

CONTINUE_EXECUTION  = true
DELAY_COEFFICIENT  = 0.5
FINISH_EXECUTION  = false
THRESHOLD_TIME  = 20.0

Methods

__destruct()  : mixed
bind()  : void
Adds agent for current class.
bindClass()  : void
Adds agent for class $className for $moduleId module. Example for updater: \Bitrix\Main\Stepper::bindClass('\Bitrix\SomeModule\SomeClass', 'somemodule').
checkRequest()  : void
Just method to check request.
createInstance()  : Stepper
Just a fabric method.
execAgent()  : string
Executes an agent.
execute()  : bool
Executes some action, and if return value is false, agent will be deleted.
getHtml()  : string
Returns HTML to show updates.
getModuleId()  : string
Wrap-function to get moduleId.
getOuterParams()  : array<string|int, mixed>
getTitle()  : mixed
isRolePresetsEnabled()  : bool
makeArguments()  : string
It is possible to pass only integer and string values for now. But you can make your own method or extend this one.
setOuterParams()  : void

Constants

CONTINUE_EXECUTION

public mixed CONTINUE_EXECUTION = true

DELAY_COEFFICIENT

public mixed DELAY_COEFFICIENT = 0.5

FINISH_EXECUTION

public mixed FINISH_EXECUTION = false

THRESHOLD_TIME

public mixed THRESHOLD_TIME = 20.0

Methods

__destruct()

public __destruct() : mixed

Does nothing.

bind()

Adds agent for current class.

public static bind([int $delay = 300 ][, array<string|int, mixed> $withArguments = [] ]) : void
Parameters
$delay : int = 300

Delay for running agent

$withArguments : array<string|int, mixed> = []

Data that will available in $stepper->outerParams

bindClass()

Adds agent for class $className for $moduleId module. Example for updater: \Bitrix\Main\Stepper::bindClass('\Bitrix\SomeModule\SomeClass', 'somemodule').

public static bindClass(string $className, string $moduleId[, int $delay = 300 ][, array<string|int, mixed> $withArguments = [] ]) : void
Parameters
$className : string

Class like \Bitrix\SomeModule\SomeClass extends Stepper.

$moduleId : string

Module ID like somemodule.

$delay : int = 300

Delay for running agent

$withArguments : array<string|int, mixed> = []

checkRequest()

Just method to check request.

public static checkRequest() : void

execAgent()

Executes an agent.

public static execAgent() : string
Return values
string

execute()

Executes some action, and if return value is false, agent will be deleted.

public execute(array<string|int, mixed> &$option) : bool
Parameters
$option : array<string|int, mixed>

Array with main data to show if it is necessary like {steps : 35, count : 7}, where steps is an amount of iterations, count - current position.

Return values
bool

getHtml()

Returns HTML to show updates.

public static getHtml([array<string|int, mixed>|string $ids = [] ][, string $title = "" ]) : string
Parameters
$ids : array<string|int, mixed>|string = []
$title : string = ""
Return values
string

getModuleId()

Wrap-function to get moduleId.

public static getModuleId() : string
Return values
string

getOuterParams()

public getOuterParams() : array<string|int, mixed>
Return values
array<string|int, mixed>

getTitle()

public static getTitle() : mixed

isRolePresetsEnabled()

public static isRolePresetsEnabled() : bool
Return values
bool

makeArguments()

It is possible to pass only integer and string values for now. But you can make your own method or extend this one.

public static makeArguments([array<string|int, mixed> $arguments = [] ]) : string
Parameters
$arguments : array<string|int, mixed> = []
Return values
string

setOuterParams()

public setOuterParams(array<string|int, mixed> $outerParams) : void
Parameters
$outerParams : array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results