Documentation

Job extends CacheModel
in package
implements JobgetJobParamatersInterface, Job

Table of Contents

Interfaces

JobgetJobParamatersInterface
Job

Properties

$end_time  : mixed
$errors  : mixed
$generate_time  : mixed
$id  : mixed
$main_action  : mixed
$message  : mixed
$next_check  : mixed
$parameters  : mixed
$progress  : mixed
$request_user_account_id  : mixed
$result  : mixed
$secondary_id  : mixed
$start_time  : mixed
$sub_action  : mixed
$user_id  : mixed
$create_time  : mixed
$update_time  : mixed

Methods

__toString()  : mixed
assignJobMergedData()  : mixed
beforeSave()  : mixed
clone()  : mixed
createJobToProceedUploadProofIfNeeded()  : bool
deleteMerged()  : mixed
exists()  : bool
export()  : mixed
fetchAsArray()  : mixed
fetchAsAssocArray()  : mixed
fetchAsMultiAssocArray()  : mixed
find()  : false|array<string|int, static>
findFirst()  : static|false
findFor()  : array<string|int, Job>
findForJob()  : array<string|int, Job>
fixParameters()  : mixed
fromArray()  : mixed
getCreateTime()  : mixed
getEndTime()  : mixed
getGenerateTime()  : mixed
getId()  : mixed
getJobParamaters()  : mixed
getMainAction()  : mixed
getMergedParametersData()  : mixed
getMergedParametersObject()  : mixed
getNextCheck()  : mixed
getParameters()  : mixed
getParametersJson()  : mixed
Wrapper for json_decode that throws when an error occurs.
getProgress()  : int
getRequestUserAccount()  : UserAccount
getRequestUserAccountId()  : mixed
Get the value of request_user_account_id
getResult()  : mixed
getSecondaryId()  : mixed
getStartTime()  : mixed
getSubAction()  : mixed
getThe()  : mixed
getUpdateTime()  : mixed
getUserId()  : mixed
hasFailed()  : bool
hasFinished()  : bool
initialize()  : mixed
initOrLoad()  : static
initOrLoadWithParameters()  : Job
insertDefaultBankingDetauls()  : mixed
isJobActionOverwrite()  : mixed
mapper()  : mixed
movementArrangeAndAfter()  : bool
planAmazon()  : mixed
planShopify()  : mixed
regenerateReports()  : mixed
reset()  : mixed
save()  : bool
{@inheritDoc}
saveData()  : mixed
set()  : mixed
setCreateTime()  : $this
If $createTime is null, default value now.
setEndTime()  : mixed
setErrors()  : mixed
setGenerateTime()  : mixed
setMainAction()  : mixed
setMessage()  : mixed
setNextCheck()  : Job
setParameters()  : static
Wrapper for JSON encoding that throws when an error occurs.
setProgress()  : mixed
setRequestUserAccountId()  : self
Set the value of request_user_account_id
setResult()  : mixed
setSecondaryId()  : mixed
setStartTime()  : mixed
setSubAction()  : mixed
setUpdateTime()  : $this
If $updateTime is null, default value now.
setUserId()  : mixed
silentMovementArrangeAndAfter()  : bool
writeAttributeIfNeeded()  : mixed
_createKey()  : mixed
findInQueueJobWithParameters()  : Job|null

Properties

$end_time

public mixed $end_time

$errors

public mixed $errors

$generate_time

public mixed $generate_time

$id

public mixed $id

$main_action

public mixed $main_action

$message

public mixed $message

$next_check

public mixed $next_check

$parameters

public mixed $parameters

$progress

public mixed $progress = \Vatjar\Jobs\Model\Job::PROGRESS_PENDING

$request_user_account_id

public mixed $request_user_account_id

$result

public mixed $result

$secondary_id

public mixed $secondary_id

$start_time

public mixed $start_time

$sub_action

public mixed $sub_action

$user_id

public mixed $user_id

Methods

__toString()

public __toString() : mixed

assignJobMergedData()

public assignJobMergedData() : mixed

beforeSave()

public beforeSave() : mixed

clone()

public clone() : mixed

createJobToProceedUploadProofIfNeeded()

public static createJobToProceedUploadProofIfNeeded(EntryReport $entryReport) : bool
Parameters
$entryReport : EntryReport
Return values
bool

deleteMerged()

public static deleteMerged(mixed $action, mixed $userId[, array<string|int, mixed> $opt = [] ]) : mixed
Parameters
$action : mixed
$userId : mixed
$opt : array<string|int, mixed> = []

exists()

public exists() : bool
Return values
bool

export()

public static export(Export $export) : mixed
Parameters
$export : Export

fetchAsArray()

public static fetchAsArray([mixed $parameter = null ]) : mixed
Parameters
$parameter : mixed = null

fetchAsAssocArray()

public static fetchAsAssocArray([mixed $parameter = null ][, mixed $key = 'id' ][, mixed $cols = null ]) : mixed
Parameters
$parameter : mixed = null
$key : mixed = 'id'
$cols : mixed = null

fetchAsMultiAssocArray()

public static fetchAsMultiAssocArray([mixed $parameter = null ][, mixed $keyname = ['id'] ][, mixed $cols = null ]) : mixed
Parameters
$parameter : mixed = null
$keyname : mixed = ['id']
$cols : mixed = null

find()

public static find([array<string|int, mixed>|null|int $parameters = null ]) : false|array<string|int, static>
Parameters
$parameters : array<string|int, mixed>|null|int = null
Return values
false|array<string|int, static>

findFirst()

public static findFirst([array<string|int, mixed>|null|int $parameters = null ]) : static|false
Parameters
$parameters : array<string|int, mixed>|null|int = null
Return values
static|false

findFor()

public static findFor(int $mainAction[, int $subAction = null ][, int $userId = null ][, int $secoundary = null ][, array<string|int, mixed> $opt = [] ]) : array<string|int, Job>
Parameters
$mainAction : int
$subAction : int = null
$userId : int = null
$secoundary : int = null
$opt : array<string|int, mixed> = []
Return values
array<string|int, Job>

findForJob()

public static findForJob(Job $job[, array<string|int, mixed> $opt = [] ]) : array<string|int, Job>
Parameters
$job : Job
$opt : array<string|int, mixed> = []
Return values
array<string|int, Job>

fixParameters()

public static fixParameters([mixed $parameters = null ]) : mixed
Parameters
$parameters : mixed = null

fromArray()

public static fromArray(mixed $array) : mixed
Parameters
$array : mixed

getEndTime()

public getEndTime() : mixed

getGenerateTime()

public getGenerateTime() : mixed

getId()

public getId() : mixed

getJobParamaters()

public getJobParamaters(mixed ...$argList) : mixed
Parameters
$argList : mixed

getMainAction()

public getMainAction() : mixed

getMergedParametersData()

public static getMergedParametersData(mixed $action, mixed $userId[, array<string|int, mixed> $opt = [] ]) : mixed
Parameters
$action : mixed
$userId : mixed
$opt : array<string|int, mixed> = []

getNextCheck()

public getNextCheck() : mixed

getParameters()

public getParameters() : mixed

getParametersJson()

Wrapper for json_decode that throws when an error occurs.

public getParametersJson([bool $assoc = false ][, int $options = 0 ][, int $depth = 512 ]) : mixed
Parameters
$assoc : bool = false

When true, returned objects will be converted into associative arrays.

$options : int = 0

Bitmask of JSON decode options.

$depth : int = 512

User specified recursion depth.

Tags
throws
InvalidArgumentException

if the JSON cannot be decoded.

link
http://www.php.net/manual/en/function.json-decode.php

getProgress()

public getProgress() : int
Return values
int

getRequestUserAccountId()

Get the value of request_user_account_id

public getRequestUserAccountId() : mixed

getResult()

public getResult() : mixed

getSecondaryId()

public getSecondaryId() : mixed

getStartTime()

public getStartTime() : mixed

getSubAction()

public getSubAction() : mixed

getThe()

public static getThe(mixed $paramater) : mixed
Parameters
$paramater : mixed

getUserId()

public getUserId() : mixed

hasFailed()

public hasFailed() : bool
Return values
bool

hasFinished()

public hasFinished() : bool
Return values
bool

initialize()

public initialize() : mixed

initOrLoad()

public static initOrLoad(int $mainAction, int $subAction, int $userId, int $secoundary) : static
Parameters
$mainAction : int
$subAction : int
$userId : int
$secoundary : int
Return values
static

initOrLoadWithParameters()

public static initOrLoadWithParameters(int $mainAction, int $subAction, int $userId, int|null $secondary, string|null $parameters) : Job
Parameters
$mainAction : int
$subAction : int
$userId : int
$secondary : int|null
$parameters : string|null
Return values
Job

insertDefaultBankingDetauls()

public static insertDefaultBankingDetauls(int $clientId[, int|null $requestUserAccountId = null ]) : mixed
Parameters
$clientId : int
$requestUserAccountId : int|null = null

isJobActionOverwrite()

public static isJobActionOverwrite(int $mainAction) : mixed
Parameters
$mainAction : int

mapper()

public static mapper(array<string|int, mixed> $map, array<string|int, mixed> $original[, bool $reverse = true ]) : mixed
Parameters
$map : array<string|int, mixed>
$original : array<string|int, mixed>
$reverse : bool = true

movementArrangeAndAfter()

public static movementArrangeAndAfter(mixed $clientId) : bool
Parameters
$clientId : mixed
Return values
bool

planAmazon()

public static planAmazon(mixed $clientId) : mixed
Parameters
$clientId : mixed

planShopify()

public static planShopify(mixed $clientId) : mixed
Parameters
$clientId : mixed

regenerateReports()

public static regenerateReports(mixed $clientId[, mixed $requestUserAccountId = null ]) : mixed
Parameters
$clientId : mixed
$requestUserAccountId : mixed = null

reset()

public reset() : mixed

save()

{@inheritDoc}

public save([mixed $data = null ][, mixed $whiteList = null ]) : bool
Parameters
$data : mixed = null
$whiteList : mixed = null
Tags
see
Model::save()
Return values
bool

saveData()

public static saveData(mixed $mainAction, mixed $subAction, mixed $userId, mixed $secoundary, array<string|int, mixed> $data) : mixed
Parameters
$mainAction : mixed
$subAction : mixed
$userId : mixed
$secoundary : mixed
$data : array<string|int, mixed>

set()

public set(mixed $property, mixed $value) : mixed
Parameters
$property : mixed
$value : mixed

setCreateTime()

If $createTime is null, default value now.

public setCreateTime([mixed $createTime = null ]) : $this
Parameters
$createTime : mixed = null
Return values
$this

setEndTime()

public setEndTime(mixed $end_time) : mixed
Parameters
$end_time : mixed

setErrors()

public setErrors(mixed $errors) : mixed
Parameters
$errors : mixed

setGenerateTime()

public setGenerateTime(mixed $generate_time) : mixed
Parameters
$generate_time : mixed

setMainAction()

public setMainAction(mixed $main_action) : mixed
Parameters
$main_action : mixed

setMessage()

public setMessage(mixed $message) : mixed
Parameters
$message : mixed

setNextCheck()

public setNextCheck(mixed $next_check) : Job
Parameters
$next_check : mixed
Return values
Job

setParameters()

Wrapper for JSON encoding that throws when an error occurs.

public setParameters(mixed $parameters[, int $options = 0 ][, int $depth = 512 ]) : static
Parameters
$parameters : mixed
$options : int = 0

JSON encode option bitmask

$depth : int = 512

Set the maximum depth. Must be greater than zero.

Tags
throws
InvalidArgumentException

if the JSON cannot be encoded.

link
http://www.php.net/manual/en/function.json-encode.php
Return values
static

setProgress()

public setProgress(int $progress) : mixed
Parameters
$progress : int

setRequestUserAccountId()

Set the value of request_user_account_id

public setRequestUserAccountId(int|null $request_user_account_id) : self
Parameters
$request_user_account_id : int|null
Return values
self

setResult()

public setResult(mixed $result) : mixed
Parameters
$result : mixed

setSecondaryId()

public setSecondaryId(mixed $secondaryId) : mixed
Parameters
$secondaryId : mixed

setStartTime()

public setStartTime(mixed $start_time) : mixed
Parameters
$start_time : mixed

setSubAction()

public setSubAction(mixed $sub_action) : mixed
Parameters
$sub_action : mixed

setUpdateTime()

If $updateTime is null, default value now.

public setUpdateTime([mixed $updateTime = null ]) : $this
Parameters
$updateTime : mixed = null
Return values
$this

setUserId()

public setUserId(int $user_id) : mixed
Parameters
$user_id : int

silentMovementArrangeAndAfter()

public static silentMovementArrangeAndAfter(mixed $clientId) : bool
Parameters
$clientId : mixed
Return values
bool

writeAttributeIfNeeded()

public writeAttributeIfNeeded(mixed $attribute, mixed $value) : mixed
Parameters
$attribute : mixed
$value : mixed

_createKey()

protected static _createKey(mixed $parameters) : mixed
Parameters
$parameters : mixed

findInQueueJobWithParameters()

private static findInQueueJobWithParameters(int $mainAction, int $subAction, int $userId, int|null $secondary, string|null $parameters) : Job|null
Parameters
$mainAction : int
$subAction : int
$userId : int
$secondary : int|null
$parameters : string|null
Return values
Job|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results