Пространство имен 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 ($flag=true)
	hasProcessCompleted ()
	instanceTimer ()
	startTimer ()
	hasTimeLimitReached ()

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

Функции

clearProgressParameters()

clearProgressParameters

(

)

Removes progress parameters.

Возвращает

self

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

declareAccomplishment()

declareAccomplishment

(

$flag = true

)

Switch accomplishment flag of the process.

Аргументы

boolean

$flag

Accomplishment flag value.

Возвращает

void

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

getProgressParameterOptionName()

getProgressParameterOptionName

(

)

Returns progress option name

Возвращает

string

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

getProgressParameters()

getProgressParameters

(

)

Load progress parameters.

Возвращает

array

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

hasProcessCompleted()

hasProcessCompleted

(

)

Tells true if process has completed.

Возвращает

boolean

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

hasTimeLimitReached()

hasTimeLimitReached

(

)

Tells true if time limit reached.

См. также

Translate\Controller\ITimeLimit

Возвращает

boolean

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

instanceTimer()

instanceTimer

(

)

Gets timer.

Возвращает

Translate\Controller\Timer

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

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

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

restoreProgressParameters()

restoreProgressParameters

(

)

Restore progress state of the instance.

Возвращает

self

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

saveProgressParameters()

saveProgressParameters

(

)

Save progress parameters.

Возвращает

self

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

startTimer()

startTimer

(

)

Sets start up time.

См. также

Translate\Controller\ITimeLimit

Возвращает

void

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

Переменные

$isNewProcess

$isNewProcess = true

protected

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

$isProcessCompleted

$isProcessCompleted = false

protected

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

$processedItems

$processedItems = 0

protected

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

$timer

$timer

protected

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

$totalItems

$totalItems = 0

protected

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

ProcessParams

trait ProcessParams

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

{
    
    protected $fieldToStoreInProcess = []

Manages process session parameters.

\Controller\IProcessParameters

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

STATUS_COMPLETED

const STATUS_COMPLETED = 'COMPLETED'

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

STATUS_PROGRESS

const STATUS_PROGRESS = 'PROGRESS'

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

Stepper

trait Stepper

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

{
    
    protected $processToken

Stepper

\Controller\ITimeLimit

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