\FAA\ObjCronJobInventory

Summary

Methods

Properties

Constants

__construct()
ContextType()
GetPath()
Execute()
Register()
GetName()
ReUse()
SetDefinition()
GetDefinition()
Id()
GetMultiplicator()
Delete()
Setup()
Pid()
Progress()
Description()
Repository()
IsDone()
IsError()
IsRunning()
TailLogfile()
GetRegistrationTime()
GetStartTime()
Logfile()
LogLine()
RegisterConfigured()
GetCreationTime()
FormatDate()

No public properties found

No constants found

No protected methods found

$id
$dbal
$name
$path
$setup
$definition
$_progress
$config

N/A

PersistItem()
Database()
renderTemplate()

$git_repo
$folders

N/A

File: lib/cron/inventory.php
Package: Core
Class hierarchy: \FAA\Obj\CronJob

\FAA\Obj\CronJobInventory

Properties

$id

$id :

Type

$dbal

$dbal :

Type

$name

$name :

Type

$path

$path :

Type

$setup

$setup :

Type

$definition

$definition :

Type

$_progress

$_progress :

Type

$config

$config : object|null

The local configuration object

Type

object|null

$git_repo

$git_repo :

Type

$folders

$folders :

Type

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

ContextType()

ContextType() : string

Get a context type information

Returns

string

GetPath()

GetPath() : string

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

Returns

string —

The object storage path

Execute()

Execute() : \FAA\Obj\Result

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

Returns

\FAA\Obj\Result —

A system result object

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

GetName()

GetName() : string

expose the name provide an interface to extract the name

Returns

string —

the object name

ReUse()

ReUse(integer  $id)

re-use an existing object with alternative setup set the id to given and the path to null to force a reload

Parameters

integer

$id

A cronjob identification number

SetDefinition()

SetDefinition(\stdClass  $plain)

add setup object (content type defined) buffers the general plain setup object of this job

Parameters

\stdClass

$plain

A cronjob definition from object storage

GetDefinition()

GetDefinition() : \stdClass

get setup object (content type defined) load the general plain setup object of this job

Returns

\stdClass —

a cron job definition from object storage

Id()

Id() : integer|null

Returns

integer|null

GetMultiplicator()

GetMultiplicator() : float

load multiplication load the factor for weighting this job in overall count on jobs executor

Returns

float —

weighting of jobs in max buffer context

Delete()

Delete() : \FAA\Obj\Result

Delete instance from database And the folder from file system

Returns

\FAA\Obj\Result

Setup()

Setup(array  $value = null) : object

expose the current setup provide an interface to extract the current setup of this object

Parameters

array

$value

The new setup

Returns

object —

The current setup

Pid()

Pid(integer  $value = null) : string

expose the current process pid provide an interface to extract the current Pid of this object

Parameters

integer

$value

The current Pid

Returns

string —

The current Pid

Progress()

Progress(integer  $value = null) : string

Expose the current progress

Provide an interface to extract the current progress of this object. When a value is given, the progress is set and persisted in the database

Parameters

integer

$value

The current progress

Returns

string —

The current progress

Description()

Description(string  $value = null) : string

expose the current description provide an interface to extract the current progress of this object

Parameters

string

$value

The current description

Returns

string —

The current description

Repository()

Repository() : \FAA\Git

Get the git instance

It should open a git instance on demand

Returns

\FAA\Git

IsDone()

IsDone(integer  $value = null) : boolean

expose the current state provide an interface to extract whether this jo b is running

Parameters

integer

$value

The current progress

Returns

boolean —

The current progress

IsError()

IsError(integer  $value = null) : boolean

expose the current state provide an interface to extract whether this job is error

Parameters

integer

$value

The current progress

Returns

boolean —

The current progress

IsRunning()

IsRunning(integer  $value = null) : boolean

expose the current state provide an interface to extract whether this jo b is running

Parameters

integer

$value

The current progress

Returns

boolean —

The current progress

TailLogfile()

TailLogfile(integer  $index) : \FAA\Obj\Result

Do log tail Tail the local log file.

Parameters

integer

$index

The start line index

Returns

\FAA\Obj\Result —

The result object

GetRegistrationTime()

GetRegistrationTime() : boolean|integer

Get registration Get the registration timestamp.

Returns

boolean|integer —

The timestamp

GetStartTime()

GetStartTime() : integer

Get start time Get the start timestamp.

Returns

integer —

The timestamp

Logfile()

Logfile() : string

Path to the log file

Returns

string

LogLine()

LogLine(mixed  $value, string  $level = FAA_LOG_LEVEL_INFO) : boolean

log line write a line to the local system logfile

Parameters

mixed	$value	The log message
string	$level	The log level

Returns

boolean —

Write success or false on error

RegisterConfigured()

RegisterConfigured(  $setup)

Parameters

$setup

GetCreationTime()

GetCreationTime()

FormatDate()

FormatDate(  $date)

Parameters

$date

PersistItem()

PersistItem(  $field,   $value)

Store some item in the database to persist it. Like the progress.

Parameters

	$field
	$value

Database()

Database() : \FAA\Handler\Database\CronJobDBAL|null

Get the database

Returns

\FAA\Handler\Database\CronJobDBAL|null

renderTemplate()

renderTemplate(  $language,   $storage) : \FAA\Obj\Result

Parameters

	$language
	$storage	Storage

Returns

\FAA\Obj\Result