\FAA\ObjCronJobImportContents

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
importLinkedContent()
detectSplitArchive()
preProcessZip()
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

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

importLinkedContent()

importLinkedContent(\FAA\Obj\Result  $result,  $row,  $index,  $mapping,  $is_zip_root,  $media,  $media_folder): array

Handle linked file uploads either from url or from zip file

Parameters

\FAA\Obj\Result $result
$row
$index
$mapping
$is_zip_root
$media
$media_folder

Returns

array —

The written attribute

detectSplitArchive()

detectSplitArchive(  $payload): \FAA\Obj\Result

Detect and map split archive on demand

Parameters

$payload

Returns

\FAA\Obj\Result

preProcessZip()

preProcessZip(  $file,  $path): \FAA\Obj\Result

Pre process potentially uploaded archive

Parameters

$file
$path

Returns

\FAA\Obj\Result