progress
in package
implements
JsonSerializable
System config Objekt
Tags
Interfaces, Classes, Traits and Enums
- JsonSerializable
Table of Contents
- $callback : callable
- Callback Function
- $current : mixed
- Current value
- $data : null|array<string|int, mixed>
- Data parameter
- $maxExec : int
- Maximum execution time in seconds, 80% of max_execution_time
- $next : int
- Next execution possible
- $stop : bool
- Stop flag
- $unique : null|array<string|int, mixed>
- Data parameter
- __construct() : void
- Controller
- getCurrent() : mixed
- Get current value
- getData() : array<string|int, mixed>|null
- Get data
- getNext() : int
- Next execution required/ possible
- getStop() : bool
- Check if progress was stopped
- process() : bool
- Process progress
- setCurrent() : $this
- Set current value
- setData() : $this
- Set data
- setNext() : $this
- Set Next execution flag
Properties
$callback
Callback Function
private
callable
$callback
= null
$current
Current value
private
mixed
$current
= null
$data
Data parameter
private
null|array<string|int, mixed>
$data
= null
$maxExec
Maximum execution time in seconds, 80% of max_execution_time
private
int
$maxExec
= 10
$next
Next execution possible
private
int
$next
= true
$stop
Stop flag
private
bool
$stop
= false
$unique
Data parameter
private
null|array<string|int, mixed>
$unique
= null
Methods
__construct()
Controller
public
__construct(callable $callback[, string $unique = '' ]) : void
Parameters
- $callback : callable
- $unique : string = ''
Return values
void —getCurrent()
Get current value
public
getCurrent() : mixed
Return values
mixed —getData()
Get data
public
getData() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null —getNext()
Next execution required/ possible
public
getNext() : int
Return values
int —getStop()
Check if progress was stopped
public
getStop() : bool
Return values
bool —process()
Process progress
public
final process() : bool
Return values
bool —setCurrent()
Set current value
public
setCurrent(mixed $current) : $this
Parameters
- $current : mixed
Return values
$this —setData()
Set data
public
setData(array<string|int, mixed> $data) : $this
Parameters
- $data : array<string|int, mixed>
Return values
$this —setNext()
Set Next execution flag
public
setNext(int|bool $next) : $this
Parameters
- $next : int|bool