ProcessParams
Manages process session parameters.
Tags
Table of Contents
Methods
- clearProgressParameters() : self
- Removes progress parameters.
- getProgressParameterOptionName() : string
- Returns progress option name
- getProgressParameters() : array<string|int, mixed>
- Load progress parameters.
- keepField() : self
- Tells if needed to keep field state as progress parameters.
- restoreProgressParameters() : self
- Restore progress state of the instance.
- saveProgressParameters() : self
- Save progress parameters.
Methods
clearProgressParameters()
Removes progress parameters.
public
clearProgressParameters() : self
Return values
selfgetProgressParameterOptionName()
Returns progress option name
public
getProgressParameterOptionName() : string
Return values
stringgetProgressParameters()
Load progress parameters.
public
getProgressParameters() : array<string|int, mixed>
Return values
array<string|int, mixed>keepField()
Tells if needed to keep field state as progress parameters.
public
keepField(string|array<string|int, string> $fieldName) : self
Parameters
- $fieldName : string|array<string|int, string>
-
Name of instance field to keep in progress parameters.
Return values
selfrestoreProgressParameters()
Restore progress state of the instance.
public
restoreProgressParameters() : self
Return values
selfsaveProgressParameters()
Save progress parameters.
public
saveProgressParameters() : self