\FAA\ObjCronJobExportStructure

Summary

Methods
Properties
Constants
__construct()
Register()
RegisterSingle()
Execute()
GetPath()
GetName()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
importFolder()
registerAsset()
No private properties found
N/A

Methods

__construct()

__construct(  $id = null,  $setup = null)

construct a new instance of the object

Parameters

$id

integer A cron job identification number

$setup

array A cron job setup data set

Register()

Register(): \FAA\Obj\Result

Register new sub jobs They are called afterwards in the Execute method

Returns

\FAA\Obj\Result —

A system result object

RegisterSingle()

RegisterSingle(array  $data): \FAA\Obj\Result

Register new sub jobs They are called afterwards in the Execute method

Parameters

array $data

The configuration array

Returns

\FAA\Obj\Result —

A system result object

Execute()

Execute(): \FAA\Obj\Result

Execute sub job, This one is called after the Register method

Returns

\FAA\Obj\Result —

A system result object

GetPath()

GetPath(): string

Expose the storage path Provides an interface to extract the current path of this object

Returns

string —

The object storage path

GetName()

GetName(): string

expose the name provide an interface to extract the name

Returns

string —

the object name

importFolder()

importFolder(\FAA\Obj\Generic\FolderTree  $root,\FAA\Obj\Result  $result,array  $folder,boolean  $replace_ids,  $archive_folder,boolean  $include_root_folder = true)

Parameters

\FAA\Obj\Generic\FolderTree $root
\FAA\Obj\Result $result
array $folder
boolean $replace_ids
$archive_folder
boolean $include_root_folder

registerAsset()

registerAsset(\FAA\Obj\Result  $result,boolean  $replace_ids,array  $val,string  $archive_folder): integer|string|null

Parameters

\FAA\Obj\Result $result
boolean $replace_ids
array $val
string $archive_folder

Returns

integer|string|null