Пространство имен Bitrix\Translate\Controller

Пространства имен
namespace	Asset
namespace	Editor
namespace	Export
namespace	Import
namespace	Index

Структуры данных
class	Action
class	CheckPermission
class	Controller
interface	IProcessParameters
interface	ITimeLimit
class	Timer

Функции
	getProgressParameterOptionName ()
	keepField ($fieldName)
	restoreProgressParameters ()
	saveProgressParameters ()
	getProgressParameters ()
	clearProgressParameters ()
	performStep ($action, array $params=[])
	declareAccomplishment (bool $flag=true)
	hasProcessCompleted ()
	instanceTimer ()
	startTimer ()
	hasTimeLimitReached ()

Переменные
const	STATUS_COMPLETED = 'COMPLETED'
const	STATUS_PROGRESS = 'PROGRESS'
trait	ProcessParams
trait	Stepper
bool	$isNewProcess = true
bool	$isProcessCompleted = false
int	$processedItems = 0
int	$totalItems = 0
Translate Controller Timer	$timer = null

Функции

clearProgressParameters()

clearProgressParameters

(

)

Removes progress parameters.

Возвращает

self

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

declareAccomplishment()

declareAccomplishment

(

bool

$flag = true

)

Switch accomplishment flag of the process.

Аргументы

bool

$flag

Accomplishment flag value.

Возвращает

void

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

getProgressParameterOptionName()

getProgressParameterOptionName

(

)

Returns progress option name

Возвращает

string

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

getProgressParameters()

getProgressParameters

(

)

Load progress parameters.

Возвращает

array

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

hasProcessCompleted()

hasProcessCompleted

(

)

Tells true if process has completed.

Возвращает

bool

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

hasTimeLimitReached()

hasTimeLimitReached

(

)

Tells true if time limit reached.

См. также

Translate\Controller\ITimeLimit

Возвращает

bool

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

instanceTimer()

instanceTimer

(

)

Gets timer.

Возвращает

Translate\Controller\Timer

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

keepField()

keepField

(

$fieldName

)

Tells if needed to keep field state as progress parameters.

Аргументы

string | string[]

$fieldName

Name of instance field to keep in progress parameters.

Возвращает

self

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

performStep()

performStep ( $action, array $params = [] )

protected

Performs action.

Аргументы

\Closure | callable | string	$action	Action to be executed.
array	$params	Parameters.

Возвращает

array|Main\Engine\Response\AjaxJson

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

restoreProgressParameters()

restoreProgressParameters

(

)

Restore progress state of the instance.

Возвращает

self

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

saveProgressParameters()

saveProgressParameters

(

)

Save progress parameters.

Возвращает

self

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

startTimer()

startTimer

(

)

Sets start up time.

См. также

Translate\Controller\ITimeLimit

Возвращает

void

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

Переменные

$isNewProcess

bool $isNewProcess = true

protected

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

$isProcessCompleted

bool $isProcessCompleted = false

protected

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

$processedItems

int $processedItems = 0

protected

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

$timer

Translate Controller Timer $timer = null

protected

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

$totalItems

int $totalItems = 0

protected

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

ProcessParams

trait ProcessParams

Инициализатор

{
    
    protected array $fieldToStoreInProcess = []

Manages process session parameters.

\Controller\IProcessParameters

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

STATUS_COMPLETED

const STATUS_COMPLETED = 'COMPLETED'

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

STATUS_PROGRESS

const STATUS_PROGRESS = 'PROGRESS'

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

Stepper

trait Stepper

Инициализатор

{
    protected ?string $processToken

Stepper

\Controller\ITimeLimit

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