Job
in package
implements
JsonSerializable, Job
Class Job
Tags
Table of Contents
Interfaces
- JsonSerializable
- Job
Properties
- $endTime : DateTime|null
- $errors : string|null
- $generateTime : DateTime|null
- $id : int|null
- $mainActionCode : int|null
- $message : string|null
- $nextCheckDate : DateTime|null
- $parameters : string|null
- $progressStatusCode : int|null
- $requestUserAccount : UserAccount
- $result : string|null
- $secondaryId : int|null
- $startTime : DateTime|null
- $subActionCode : int|null
- $updateTime : DateTime|null
- $userAccount : UserAccount|null
- $userId : int
Methods
- __construct() : mixed
- getEndTime() : DateTime|null
- getErrors() : string|null
- getGenerateTime() : DateTime|null
- getId() : int|null
- getMainAction() : int|null
- getMainActionCode() : int|null
- getMessage() : string|null
- getNextCheckDate() : DateTime|null
- getParameters() : string|null
- getProgressStatusCode() : int|null
- getRequestUserAccount() : UserAccount
- Get the value of requestUserAccount
- getResult() : string|null
- getSecondaryId() : int|null
- getStartTime() : DateTime|null
- getSubAction() : int|null
- getSubActionCode() : int|null
- getUpdateTime() : DateTime|null
- getUserAccount() : UserAccount|null
- Get $client
- getUserId() : int
- Get the value of userId
- jsonSerialize() : mixed
- Specify data which should be serialized to JSON
- setEndTime() : void
- setErrors() : void
- setGenerateTime() : void
- setId() : void
- setMainAction() : void
- setMainActionCode() : void
- setMessage() : void
- setNextCheckDate() : void
- setParameters() : void
- setProgressStatusCode() : void
- setRequestUserAccount() : self
- Set the value of requestUserAccount
- setResult() : void
- setSecondaryId() : void
- setStartTime() : void
- setSubAction() : void
- setSubActionCode() : void
- setUpdateTime() : void
- setUserAccount() : self
- Set $client
- setUserId() : self
- Set the value of userId
Properties
$endTime
private
DateTime|null
$endTime
Tags
$errors
private
string|null
$errors
Tags
$generateTime
private
DateTime|null
$generateTime
Tags
$id
private
int|null
$id
Tags
$mainActionCode
private
int|null
$mainActionCode
Tags
$message
private
string|null
$message
Tags
$nextCheckDate
private
DateTime|null
$nextCheckDate
Tags
$parameters
private
string|null
$parameters
Tags
$progressStatusCode
private
int|null
$progressStatusCode
= \Vatjar\Data\Entity\Job::PROGRESS_PENDING
Tags
$requestUserAccount
private
UserAccount
$requestUserAccount
Tags
$result
private
string|null
$result
Tags
$secondaryId
private
int|null
$secondaryId
Tags
$startTime
private
DateTime|null
$startTime
Tags
$subActionCode
private
int|null
$subActionCode
Tags
$updateTime
private
DateTime|null
$updateTime
Tags
$userAccount
private
UserAccount|null
$userAccount
Tags
$userId
private
int
$userId
Tags
Methods
__construct()
public
__construct() : mixed
getEndTime()
public
getEndTime() : DateTime|null
Return values
DateTime|nullgetErrors()
public
getErrors() : string|null
Return values
string|nullgetGenerateTime()
public
getGenerateTime() : DateTime|null
Return values
DateTime|nullgetId()
public
getId() : int|null
Return values
int|nullgetMainAction()
public
getMainAction() : int|null
Return values
int|nullgetMainActionCode()
public
getMainActionCode() : int|null
Return values
int|nullgetMessage()
public
getMessage() : string|null
Return values
string|nullgetNextCheckDate()
public
getNextCheckDate() : DateTime|null
Return values
DateTime|nullgetParameters()
public
getParameters() : string|null
Return values
string|nullgetProgressStatusCode()
public
getProgressStatusCode() : int|null
Return values
int|nullgetRequestUserAccount()
Get the value of requestUserAccount
public
getRequestUserAccount() : UserAccount
Return values
UserAccountgetResult()
public
getResult() : string|null
Return values
string|nullgetSecondaryId()
public
getSecondaryId() : int|null
Return values
int|nullgetStartTime()
public
getStartTime() : DateTime|null
Return values
DateTime|nullgetSubAction()
public
getSubAction() : int|null
Return values
int|nullgetSubActionCode()
public
getSubActionCode() : int|null
Return values
int|nullgetUpdateTime()
public
getUpdateTime() : DateTime|null
Return values
DateTime|nullgetUserAccount()
Get $client
public
getUserAccount() : UserAccount|null
Return values
UserAccount|nullgetUserId()
Get the value of userId
public
getUserId() : int
Return values
intjsonSerialize()
Specify data which should be serialized to JSON
public
jsonSerialize() : mixed
Tags
Return values
mixed —data which can be serialized by json_encode, which is a value of any type other than a resource.
setEndTime()
public
setEndTime(DateTime|null $endTime) : void
Parameters
- $endTime : DateTime|null
setErrors()
public
setErrors(string|null $errors) : void
Parameters
- $errors : string|null
setGenerateTime()
public
setGenerateTime(DateTime|null $generateTime) : void
Parameters
- $generateTime : DateTime|null
setId()
public
setId(int|null $id) : void
Parameters
- $id : int|null
setMainAction()
public
setMainAction(int|null $mainActionCode) : void
Parameters
- $mainActionCode : int|null
setMainActionCode()
public
setMainActionCode(int|null $mainActionCode) : void
Parameters
- $mainActionCode : int|null
setMessage()
public
setMessage(string|null $message) : void
Parameters
- $message : string|null
setNextCheckDate()
public
setNextCheckDate(DateTime|null $nextCheckDate) : void
Parameters
- $nextCheckDate : DateTime|null
setParameters()
public
setParameters(string|null $parameters) : void
Parameters
- $parameters : string|null
setProgressStatusCode()
public
setProgressStatusCode(int|null $progressStatusCode) : void
Parameters
- $progressStatusCode : int|null
setRequestUserAccount()
Set the value of requestUserAccount
public
setRequestUserAccount(UserAccount $requestUserAccount) : self
Parameters
- $requestUserAccount : UserAccount
Return values
selfsetResult()
public
setResult(string|null $result) : void
Parameters
- $result : string|null
setSecondaryId()
public
setSecondaryId(int|null $secondaryId) : void
Parameters
- $secondaryId : int|null
setStartTime()
public
setStartTime(DateTime|null $startTime) : void
Parameters
- $startTime : DateTime|null
setSubAction()
public
setSubAction(int|null $subActionCode) : void
Parameters
- $subActionCode : int|null
setSubActionCode()
public
setSubActionCode(int|null $subActionCode) : void
Parameters
- $subActionCode : int|null
setUpdateTime()
public
setUpdateTime(DateTime|null $updateTime) : void
Parameters
- $updateTime : DateTime|null
setUserAccount()
Set $client
public
setUserAccount(UserAccount|null $userAccount) : self
Parameters
- $userAccount : UserAccount|null
-
$client
Return values
selfsetUserId()
Set the value of userId
public
setUserId(int $userId) : self
Parameters
- $userId : int