Класс Stepper

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

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

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

Поля данных
const	CONTINUE_EXECUTION = true
const	FINISH_EXECUTION = false
const	THRESHOLD_TIME = 20.0
const	DELAY_COEFFICIENT = 0.5

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

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

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

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

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

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

__destruct()

__destruct

(

)

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

Методы

checkRequest()

checkRequest ( )

static

Just method to check request.

Возвращает

void

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

createInstance()

createInstance ( )

static

Just a fabric method.

Возвращает

Stepper

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

execAgent()

execAgent ( )

static

Executes an agent.

Возвращает

string

См. также

main/classes/general/agent.php:498

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

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

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

getHtml()

getHtml ( $ids = [], $title = "" )

static

Returns HTML to show updates.

Аргументы

array | string	$ids
string	$title

Возвращает

string

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

getModuleId()

getModuleId ( )

static

Wrap-function to get moduleId.

Возвращает

string

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

getOuterParams()

getOuterParams

(

)

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

getTitle()

getTitle ( )

static

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

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

makeArguments()

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 строка 222

setOuterParams()

setOuterParams

(

array

$outerParams

)

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

writeToLog()

writeToLog ( \Exception $exception )

protected

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

Поля

$moduleId

$moduleId = "main"

staticprotected

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

$outerParams

$outerParams = []

protected

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

CONTINUE_EXECUTION

const CONTINUE_EXECUTION = true

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

DELAY_COEFFICIENT

const DELAY_COEFFICIENT = 0.5

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

FINISH_EXECUTION

const FINISH_EXECUTION = false

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

THRESHOLD_TIME

const THRESHOLD_TIME = 20.0

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

---

Объявления и описания членов класса находятся в файле:

• C:/bitrix/modules/main/lib/update/stepper.php