$running
$running : integer
counter of running jobs
CreateHandler( $data) : \FAA\Obj\Result
Create a new cronjob with handler function from template
| $data |
ListHandlers(string $language = null, boolean $raw = false) : \FAA\Obj\Result
list job handlers interface to show the list of all job parent definitions from object storage
| string | $language | The target language of the job definition object |
| boolean | $raw | Add raw or, as plain list for view |
A system result object
Id2Path(integer $id, string $name, boolean $create = true) : string
id and name to path create and load a job working directory
| integer | $id | The job primary |
| string | $name | The job name |
| boolean | $create | If not existing, create the directory |
The path to the jobs working directory
GetRegisteredJobHandler( $name) : \FAA\Obj\CronJob|null
Get a cron job instance handler
| $name |
GetRegisteredJob(integer $id, string $name) : \FAA\Obj\Result
get single job load a single registered cronjob for detail operations
| integer | $id | The job primary |
| string | $name | The job name |
A default system result object containing the handler
ListQueue(string $language = null, array $filter = array()) : \FAA\Obj\Result
list queue of jobs interface to show the list of all jobs inside the queue will be returned with status of job and some additional information like the temp path or, the pid
| string | $language | The target language of the job definition object |
| array | $filter | A set of filters |
A system result object
ExecuteMaster(string $ident, integer $primary, string $name, boolean $force = false)
execute master job interface called from cron.php, will either start a single job or, the master job is secured by static token in cfg/locales.php
| string | $ident | The identification code |
| integer | $primary | The job primary or null when master called |
| string | $name | The job name or null when master called |
| boolean | $force | Force execution when job is awaited but has no runat definition |
ExecuteJob(integer $id, string $name)
Execute single job
Will load the job from temp storage queue, register a handler and call the handler Execute() method will also update the public status of the job, depending on jobs execute result This method does a redirect of the log file to the cron log
| integer | $id | Register id of the job (defined by file name) |
| string | $name | The handler name of this job |
ExecuteRegisteredJobs(boolean $force)
execute jobs execute the timely registered master jobs will execute cronjob list based on the time definition in the parent objects, when the job is ready for execution it will be added as a copy to the execution queue
| boolean | $force | Force execution when job is awaited but has no runat definition |
ExecuteWaitingJobs(string $name, \FAA\Obj\CronJob $handler)
execute waiting cron jobs load waiting cron jobs and then execute them
| string | $name | Name of the cronjob type to execute |
| \FAA\Obj\CronJob | $handler | A handler object |