\FAA\Obj\GenericCronjob

Summary

Methods
Properties
Constants
__construct()
Delete()
GetPath()
IsActive()
IsAwaited()
Name()
Executable()
UpdateAttributeName()
Copy()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
$keyregex
N/A

Properties

$keyregex

$keyregex :

Type

Methods

__construct()

__construct(string  $id = null,string  $language = null)

Construct a new cron job object

Construct a name based element object

Parameters

string $id

The object name/id or null for new one

string $language

The object language or null for raw one

Delete()

Delete(boolean  $skip = false): \FAA\Obj\Result

delete entity from file system and git repository this method can delete this content object from our local storage system

Parameters

boolean $skip

Skip hooks on demand

Returns

\FAA\Obj\Result —

A default system result set

GetPath()

GetPath(): string

expose the storage path provide an interface to extract the current path of this object

Returns

string —

the object storage path

IsActive()

IsActive(): boolean

Is active Return the value of the active state property

Returns

boolean —

The status of the cronjob

IsAwaited()

IsAwaited(): boolean

check if run at is in range test if the provided run at set is inside the current time

Returns

boolean —

indicator if this job is active now

Name()

Name()

Executable()

Executable(): null|\FAA\Obj\CronJob

Get the executable This method moves the executable to the executable folder and provides an instance of it.

The executable is loaded from the source code property

Returns

null|\FAA\Obj\CronJob

UpdateAttributeName()

UpdateAttributeName(\stdClass  $attr,string  $data): \FAA\Obj\Result

Callback on update validate name This function is called when the primary identifier is changed

Parameters

\stdClass $attr

The changed attribute

string $data

The new attribute value

Returns

\FAA\Obj\Result —

A system result object

Copy()

Copy(string  $target = null): \FAA\Obj\Result

copy entity in file system and git repository this method can copy this content object in our local storage system to a new one

Parameters

string $target

The target name

Returns

\FAA\Obj\Result —

A default system result set