progress
in
implements
JsonSerializable
System config Objekt
Table of Contents
| $current | Current value | mixed |
|---|---|---|
| $next | Next execution possible | int |
| $stop | Stop flag | bool |
| $data | Data parameter | null|array |
| $callback | Callback Function | callable |
| $maxExec | Maximum execution time in seconds, 80% of max_execution_time | int |
| __construct() | Controller | void |
| getCurrent() | Get current value | mixed |
| getNext() | Next execution required/ possible | int |
| getData() | Get data | array|null |
| getStop() | Check if progress was stopped | bool |
| setCurrent() | Set current value | $this |
| setNext() | Set Next execution flag | $this |
| setData() | Set data | $this |
| process() | Process progress | bool |
Properties
$current
Current value
private
mixed
$current
= null
$next
Next execution possible
private
int
$next
= true
$stop
Stop flag
private
bool
$stop
= false
$data
Data parameter
private
null|array
$data
= null
$callback
Callback Function
private
callable
$callback
= null
$maxExec
Maximum execution time in seconds, 80% of max_execution_time
private
int
$maxExec
= 10
Methods
__construct()
Controller
public
__construct(
$callback :
callable
)
: void
Parameters
- $callback : callable
getCurrent()
Get current value
public
getCurrent(
)
: mixed
Return values
mixedgetNext()
Next execution required/ possible
public
getNext(
)
: int
Return values
intgetData()
Get data
public
getData(
)
: array|null
Return values
array|nullgetStop()
Check if progress was stopped
public
getStop(
)
: bool
Return values
boolsetCurrent()
Set current value
public
setCurrent(
$current :
mixed
)
: $this
Parameters
- $current : mixed
Return values
$thissetNext()
Set Next execution flag
public
setNext(
$next :
int|bool
)
: $this
Parameters
- $next : int|bool
Return values
$thissetData()
Set data
public
setData(
$data :
array
)
: $this
Parameters
- $data : array
Return values
$thisprocess()
Process progress
public
final process(
)
: bool