JobError extends Model
Table of Contents
- TYPE_ENTITY = 0
- ENTITY
- TYPE_SYSTEM = 1
- SYSTEM
- $entity : string|null
- the hex id of the entity that has an error
- $message : string|null
- the message of the error
- $type : int|null
- Error type
- from() : static
- Initializing a model from an array
- getEntity() : string
- Getter for entity
- getMessage() : string
- Getter for message
- getType() : int
- Getter for type
- jsonSerialize() : array<string|int, mixed>
- setEntity() : static
- Setter for entity
- setMessage() : static
- Setter for message
- setType() : static
- Setter for type
Constants
TYPE_ENTITY
ENTITY
public
mixed
TYPE_ENTITY
= 0
TYPE_SYSTEM
SYSTEM
public
mixed
TYPE_SYSTEM
= 1
Properties
$entity
the hex id of the entity that has an error
protected
string|null
$entity
= null
$message
the message of the error
protected
string|null
$message
= null
$type
Error type
protected
int|null
$type
= null
Methods
from()
Initializing a model from an array
public
static from(array<string|int, mixed> $params) : static
Parameters
- $params : array<string|int, mixed>
-
Pass this parameter if you want to initial property value from an array. See API reference for all property names and types
Tags
Return values
static —getEntity()
Getter for entity
public
getEntity() : string
Return values
string —the hex id of the entity that has an error
getMessage()
Getter for message
public
getMessage() : string
Return values
string —the message of the error
getType()
Getter for type
public
getType() : int
Return values
int —Error type
jsonSerialize()
public
jsonSerialize() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —setEntity()
Setter for entity
public
setEntity(string $entity) : static
Parameters
- $entity : string
-
the hex id of the entity that has an error
Return values
static —To use in method chains
setMessage()
Setter for message
public
setMessage(string $message) : static
Parameters
- $message : string
-
the message of the error
Return values
static —To use in method chains
setType()
Setter for type
public
setType(int $type) : static
Parameters
- $type : int
-
Error type
Return values
static —To use in method chains