Bitrix API

CrmEntityCreatorStepper extends Stepper

FinalYes

Class CrmEntityCreatorStepper Stepper for creating crm entities

Table of Contents

Constants

CONTINUE_EXECUTING  = true
CONTINUE_EXECUTION  = true
DELAY_COEFFICIENT  = 0.5
FINISH_EXECUTION  = false
IS_CRM_SITE_MASTER_OPENED  = "~IS_CRM_SITE_MASTER_OPENED"
IS_SALE_CRM_SITE_MASTER_FINISH  = "~IS_SALE_CRM_SITE_MASTER_FINISH"
IS_SALE_CRM_SITE_MASTER_STUB  = "~IS_SALE_CRM_SITE_MASTER_STUB"
MAX_EXECUTION_TIME  = 5
MAX_ORDERS  = 100
ORDER_CONVERT_IS_FINISH  = "~ORDER_CONVERT_IS_FINISH"
ORDER_CONVERTER_CRM_ERROR_COUNT  = "~ORDER_CONVERTER_CRM_ERROR_COUNT"
PREFIX_OPTION_ADMIN_PANEL_IS_ENABLED  = "~ADMIN_PANEL_IS_ENABLED_FOR_"
STEPPER_PARAMS  = "~CRM_ENTITY_CREATOR_STEPPER_PARAMS"
STOP_EXECUTING  = false
THRESHOLD_TIME  = 20.0
UPDATE_ORDER_CONVERTER_CRM_ERROR_TABLE  = "~UPDATE_ORDER_CONVERTER_CRM_ERROR_TABLE"
WIZARD_SITE_ID  = "~CRM_WIZARD_SITE_ID"

Methods

__destruct()  : mixed
bind()  : void
Adds agent for current class.
bindAgent()  : void
bindAgentOrderUpdate()  : void
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.
getErrors()  : mixed
getHtml()  : string
Returns HTML to show updates.
getModuleId()  : string
Wrap-function to get moduleId.
getOuterParams()  : array<string|int, mixed>
getPathToOrderList()  : string
getTitle()  : string
isAgent()  : bool
isFinished()  : bool
isNeedStub()  : 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.
OnAfterUserLogin()  : void
registerEventHandler()  : void
Register event handler for show progressbar
registerOrderUpdateEventHandler()  : void
Register event handler for show progressbar
setFinishStatus()  : void
setOuterParams()  : void
showProgressBar()  : void
Show progress bar in crm and shop section
unregisterEventHandler()  : void
Unregister event handler for show progressbar
unregisterOrderUpdateEventHandler()  : void
Unregister event handler for show progressbar

Constants

CONTINUE_EXECUTION

public mixed CONTINUE_EXECUTION = true

DELAY_COEFFICIENT

public mixed DELAY_COEFFICIENT = 0.5

FINISH_EXECUTION

public mixed FINISH_EXECUTION = false

IS_SALE_CRM_SITE_MASTER_FINISH

public string IS_SALE_CRM_SITE_MASTER_FINISH = "~IS_SALE_CRM_SITE_MASTER_FINISH"

IS_SALE_CRM_SITE_MASTER_STUB

public string IS_SALE_CRM_SITE_MASTER_STUB = "~IS_SALE_CRM_SITE_MASTER_STUB"

ORDER_CONVERTER_CRM_ERROR_COUNT

public mixed ORDER_CONVERTER_CRM_ERROR_COUNT = "~ORDER_CONVERTER_CRM_ERROR_COUNT"

PREFIX_OPTION_ADMIN_PANEL_IS_ENABLED

public mixed PREFIX_OPTION_ADMIN_PANEL_IS_ENABLED = "~ADMIN_PANEL_IS_ENABLED_FOR_"

THRESHOLD_TIME

public mixed THRESHOLD_TIME = 20.0

UPDATE_ORDER_CONVERTER_CRM_ERROR_TABLE

public mixed UPDATE_ORDER_CONVERTER_CRM_ERROR_TABLE = "~UPDATE_ORDER_CONVERTER_CRM_ERROR_TABLE"

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> &$result) : bool
Parameters
$result : array<string|int, mixed>
Return values
bool

getErrors()

public static getErrors([array<string|int, mixed> $parameters = [] ]) : mixed
Parameters
$parameters : array<string|int, mixed> = []

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>

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

OnAfterUserLogin()

public static OnAfterUserLogin(mixed $params) : void
Parameters
$params : mixed

registerEventHandler()

Register event handler for show progressbar

public static registerEventHandler() : void

registerOrderUpdateEventHandler()

Register event handler for show progressbar

public static registerOrderUpdateEventHandler() : void

setOuterParams()

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

unregisterEventHandler()

Unregister event handler for show progressbar

public static unregisterEventHandler() : void

unregisterOrderUpdateEventHandler()

Unregister event handler for show progressbar

public static unregisterOrderUpdateEventHandler() : void 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results