\FAA\ObjCronJobBotOpt

Summary

Methods
Properties
Constants
__construct()
Register()
Execute()
BuildEntry()
GetPath()
GetName()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
_iterateFolderTree()
$links
N/A

Properties

$links

$links :array

a local existing links buffer

Type

array

Methods

__construct()

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

construct a new instance of the object

Parameters

$id

(integer) a cron job identification number

$setup

(assoc) a cron job setup data set

Register()

Register()

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

Execute()

Execute()

Execute sub jobs, are called after the Register method

BuildEntry()

BuildEntry(\stdClass  $doc,string  $language,null  $extra = null): \stdClass

Build entry Convert the search result to frontend object row

Parameters

\stdClass $doc

The search response

string $language

The request language

null $extra

Returns

\stdClass —

A 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

_iterateFolderTree()

_iterateFolderTree(string  $path,string  $url,string  $language,Object  $folder)

build the links this function is used to create the folder specific links

Parameters

string $path

The real path in the file system

string $url

The optimized url

string $language

The currently processed language

Object $folder

A plain representation of a system folder tree element