\FAA\ObjCronJobAssetProcessing

Summary

Methods

Properties

Constants

__construct()
RegisterSingle()
Register()
Execute()
GetPath()
GetName()

No public properties found

No constants found

No protected methods found

No protected properties found

N/A

listAssets()
fetchAsset()

No private properties found

N/A

Methods

__construct()

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

construct a new instance of the object

Parameters

integer	$id	A cron job identification number
array	$setup	A cron job setup data set

RegisterSingle()

RegisterSingle(\FAA\Obj\Generic\Asset  $asset): \FAA\Obj\Result

Register single cron job for asset rendering using the given raw asset this method will register the initial resizer and cropping job

Parameters

\FAA\Obj\Generic\Asset

$asset

A new registered asset

Returns

\FAA\Obj\Result —

A system result object

Register()

Register(): \FAA\Obj\Result

register jobs Register new sub jobs, are called afterwards in the Execute method

Returns

\FAA\Obj\Result —

a system result object

Execute()

Execute(): \FAA\Obj\Result

start single job Execute sub jobs, are called after the Register method

Returns

\FAA\Obj\Result —

a system result object

GetPath()

GetPath(): string

expose the storage path provide 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

listAssets()

listAssets(): array<mixed,\FAA\Obj\Generic\Asset>

get assets Load a list of system asset objects.

Returns

array<mixed,\FAA\Obj\Generic\Asset> —

A list of asset objects

fetchAsset()

fetchAsset(integer  $id,string  $type): \FAA\Obj\Generic\Asset

get asset Load a single system asset object.

Parameters

integer	$id	A object id
string	$type	A system object type name

Returns

\FAA\Obj\Generic\Asset —

A asset object or null if not found