Bitrix-D7 23.9
 
Загрузка...
Поиск...
Не найдено
Открытые члены | Открытые статические члены | Открытые атрибуты | Защищенные члены | Защищенные данные | Статические защищенные данные | Полный список членов класса
Класс History

Открытые члены

 __construct (int $entityId, string $entityType)
 
 clear ()
 
 clearOld (int $days)
 
 getStackCount ()
 
 getJsStack ()
 
 getStep ()
 
 push (string $actionName, array $params)
 
 undo ()
 
 redo ()
 
 getJsCommand (bool $undo=true)
 

Открытые статические члены

static activate ()
 
static deactivate ()
 
static setMultiplyMode ()
 
static unsetMultiplyMode ()
 
static isActive ()
 

Открытые атрибуты

const ENTITY_TYPE_LANDING = 'L'
 
const ENTITY_TYPE_DESIGNER_BLOCK = 'D'
 
const AVAILABLE_TYPES
 

Защищенные члены

 loadStack ()
 
 fixBrokenStep (int $step, int $id)
 
 clearBefore (int $step)
 
 clearAfter (int $step)
 
 deleteStep (int $step)
 
 resetStackSteps ()
 
 loadStep ()
 
 saveStep (int $step)
 
 canUndo ()
 
 canRedo ()
 
 getActionForStep (int $step, bool $undo)
 

Защищенные данные

int $entityId
 
string $entityType = self::ENTITY_TYPE_LANDING
 
int $stepRowId = null
 
array $stack = []
 
int $step = 0
 
array $actions = []
 

Статические защищенные данные

static bool $isActive = false
 
static bool $multiplyMode = false
 
static int $multiplyId = null
 
static int $multiplyStep = null
 

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

Work with History

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

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

◆ __construct()

__construct ( int $entityId,
string $entityType )
Аргументы
int$entityId
string$entityType- one of constants AVAILABLE_TYPES

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

Методы

◆ activate()

static activate ( )
static

Enable history for all

Возвращает
void

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

◆ canRedo()

canRedo ( )
protected

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

◆ canUndo()

canUndo ( )
protected

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

◆ clear()

clear ( )

Clear all history

Возвращает
bool

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

◆ clearAfter()

clearAfter ( int $step)
protected

Delete chosen step and all after them.

Аргументы
int$stepnumber of step in stack
Возвращает
bool

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

◆ clearBefore()

clearBefore ( int $step)
protected

Delete chosen step and all before them.

Аргументы
int$stepnumber of step in stack
Возвращает
bool

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

◆ clearOld()

clearOld ( int $days)

Remove history records older X days. And save new step.

Аргументы
int$days
Возвращает
bool

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

◆ deactivate()

static deactivate ( )
static

Disable history for all

Возвращает
void

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

◆ deleteStep()

deleteStep ( int $step)
protected

Remove one step by step number, with run action delete processing and save new step

Аргументы
int$step
Возвращает
bool

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

◆ fixBrokenStep()

fixBrokenStep ( int $step,
int $id )
protected

For some reasons history row can be broken. For consistency need remove row and decrease step.

Аргументы
int$stepnumber of broken step
int$idID of broken History row
Возвращает
bool

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

◆ getActionForStep()

getActionForStep ( int $step,
bool $undo )
protected

Create and save in stack action object by step number

Аргументы
int$step
bool$undo
Возвращает
BaseAction|null

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

◆ getJsCommand()

getJsCommand ( bool $undo = true)

Get params for JS command for frontend changes

Аргументы
bool$undo
Возвращает
array

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

◆ getJsStack()

getJsStack ( )

Return stack of js commands for actions

Возвращает
array

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

◆ getStackCount()

getStackCount ( )

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

◆ getStep()

getStep ( )

Get current step

Возвращает
int

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

◆ isActive()

static isActive ( )
static

Check enable or disable global history

Возвращает
bool

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

◆ loadStack()

loadStack ( )
protected

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

◆ loadStep()

loadStep ( )
protected

Get step from table

Возвращает
int

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

◆ push()

push ( string $actionName,
array $params )

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

◆ redo()

redo ( )

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

◆ resetStackSteps()

resetStackSteps ( )
protected

Re calculate steps after change stack

Возвращает
void

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

◆ saveStep()

saveStep ( int $step)
protected

Add exists or add new step row

Аргументы
int$step
Возвращает
bool

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

◆ setMultiplyMode()

static setMultiplyMode ( )
static

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

◆ undo()

undo ( )

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

◆ unsetMultiplyMode()

static unsetMultiplyMode ( )
static

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

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

◆ $actions

array $actions = []
protected

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

◆ $entityId

int $entityId
protected

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

◆ $entityType

string $entityType = self::ENTITY_TYPE_LANDING
protected

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

◆ $isActive

bool $isActive = false
staticprotected

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

◆ $multiplyId

int $multiplyId = null
staticprotected

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

◆ $multiplyMode

bool $multiplyMode = false
staticprotected

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

◆ $multiplyStep

int $multiplyStep = null
staticprotected

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

◆ $stack

array $stack = []
protected

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

◆ $step

int $step = 0
protected

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

◆ $stepRowId

int $stepRowId = null
protected

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

◆ AVAILABLE_TYPES

const AVAILABLE_TYPES
Инициализатор
= [
self::ENTITY_TYPE_LANDING,
self::ENTITY_TYPE_DESIGNER_BLOCK,
]

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

◆ ENTITY_TYPE_DESIGNER_BLOCK

const ENTITY_TYPE_DESIGNER_BLOCK = 'D'

Entity type designer block.

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

◆ ENTITY_TYPE_LANDING

const ENTITY_TYPE_LANDING = 'L'

Entity type landing.

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