Класс Stepper

Граф наследования:Stepper:

Открытые члены
	__destruct ()
	execute (array &$option)
	setOuterParams (array $outerParams)
	getOuterParams ()

Открытые статические члены
static	getHtml ($ids=array(), $title="")
static	getTitle ()
static	execAgent ()
static	makeArguments ($arguments=[])
static	createInstance ()
static	getModuleId ()
static	checkRequest ()

Открытые атрибуты
const	CONTINUE_EXECUTION = true
const	FINISH_EXECUTION = false

Защищенные члены
	writeToLog (\Exception $exception)

Защищенные данные
	$deleteFile = false
	$outerParams = []

Статические защищенные данные
static	$moduleId = "main"

Подробное описание

См. определение в файле stepper.php строка 26

Конструктор(ы)

__destruct()

__destruct

(

)

См. определение в файле stepper.php строка 175

Методы

checkRequest()

static checkRequest ( )

static

Just method to check request.

Возвращает

void

См. определение в файле stepper.php строка 366

createInstance()

static createInstance ( )

static

Just fabric method.

Возвращает

Stepper

См. определение в файле stepper.php строка 261

execAgent()

static execAgent ( )

static

Execute an agent

Возвращает

string

См. определение в файле stepper.php строка 145

execute()

execute ( array & $option )

abstract

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

Аргументы

array

$option

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.

Возвращает

boolean

Переопределяется в DeleteStepper, UserToWorkflowStepper, GroupStepper, UpdatedGoogleEventCleaner, IblockCatalogPermissionStepper, SetDefaultValueStepper, FilterOption, GridOption, ProductBatchConverter, Topic, MessageCleaner, Forum, TopicMembersStepper, User, Iblock, Section, FilterOption, GridOption, CallBackgroundFolderRights, ChatConfigConnectionsRestorer, ChatConfigConverter, ChatInvalidCounter, ChatOptionMigration, DeletedMessageFiles, LinkFileMigration, LinkUrlMigration, OpenLinesIndex, GroupStepper, LastUsed, GroupStepper, ContactsStepper, MessageClosureStepper, MessageIndexStepper, MessageSearchContentStepper, AdminFilterOption, AdminGridOption, SettingsEncryptor, GroupStepper, Section, FilterOption, GridOption, CalendarLogEvent, Stepper, LivefeedIndexComment, LivefeedIndexPost, ConverterObjectColor, CorrectEventInGoogle, EventDuplicateCleaner, EventWithLocationUpdate, IndexCalendar, InitLocalDataToGoogle, LivefeedIndexCalendar, LocationDuplicateCleaner, SectionStructureUpdate, LivefeedConvertServiceMessage, LivefeedIndexComment, LivefeedIndexMessage, TopicServiceCounter, ChatActiveUserCount, ChatDiskAccess, ChatIndex, ChatMessageCount, ChatReadRecount, ChatStartingCount, ChatUserCount, MessageIndex, NotifyReadRecount, RemoveHumanType, FixFontWeight, FontFix, WebpackClear, Block, DomainUa, FixSrcImg, NodeAttributes, NodeImg, SearchContent, Check, InitApp, SearchContent, EcrmPropertyUpdate, LivefeedIndexItem, UserSelectorStepper, UserStepper, CrmEntityCreatorStepper, DiscountExecutionModeIndex, DiscountExecutionModeIndex, WorkgroupDeptSync, WorkgroupIndex, WorkgroupTasksFilterMigration, WorkgroupTasksPinMigration, PhraseFtsIndexConverter, LivefeedIndexComment и LivefeedIndexLog.

getHtml()

static getHtml ( $ids = array(), $title = "" )

static

Returns HTML to show updates.

Аргументы

array | string	$ids
string	$title

Возвращает

string

См. определение в файле stepper.php строка 42

getModuleId()

static getModuleId ( )

static

Wrap-function to get moduleId.

Возвращает

string

См. определение в файле stepper.php строка 269

getOuterParams()

getOuterParams

(

)

См. определение в файле stepper.php строка 228

getTitle()

static getTitle ( )

static

Переопределяется в Stepper, SetDefaultValueStepper, ProductBatchConverter, Topic, MessageCleaner, Forum, TopicMembersStepper, User и CrmEntityCreatorStepper.

См. определение в файле stepper.php строка 137

makeArguments()

static makeArguments ( $arguments = [] )

static

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

Аргументы

array

$arguments

Возвращает

string

См. определение в файле stepper.php строка 238

setOuterParams()

setOuterParams

(

array

$outerParams

)

См. определение в файле stepper.php строка 223

writeToLog()

writeToLog ( \Exception $exception )

protected

См. определение в файле stepper.php строка 406

Данные класса

$deleteFile

$deleteFile = false

protected

См. определение в файле stepper.php строка 29

$moduleId

$moduleId = "main"

staticprotected

См. определение в файле stepper.php строка 28

$outerParams

$outerParams = []

protected

См. определение в файле stepper.php строка 30

CONTINUE_EXECUTION

const CONTINUE_EXECUTION = true

См. определение в файле stepper.php строка 33

FINISH_EXECUTION

const FINISH_EXECUTION = false

См. определение в файле stepper.php строка 34