Static Public Member Functions

CronTab Class Reference

List of all members.

Static Public Member Functions

static get_cronjob ($name)
static delete_cronjob ($name)
static add_cron ($paramarray)
static add_single_cron ($name, $callback, $run_time, $description= '')
static add_hourly_cron ($name, $callback, $description= '')
static add_daily_cron ($name, $callback, $description= '')
static add_weekly_cron ($name, $callback, $description= '')
static add_monthly_cron ($name, $callback, $description= '')

Detailed Description

Static class to build and read cron entries

Definition at line 12 of file crontab.php.


Member Function Documentation

static CronTab::add_cron ( paramarray  )  [static]

Add a new cron job to the DB.

See also:
CronJob
Parameters:
array $paramarray A paramarray of cron job feilds.
Returns:

Definition at line 53 of file crontab.php.

Referenced by add_daily_cron(), add_hourly_cron(), add_monthly_cron(), add_single_cron(), and add_weekly_cron().

static CronTab::add_daily_cron ( name,
callback,
description = '' 
) [static]

Add a new cron job to the DB, that runs daily.

Parameters:
string $name The name of the cron job.
mixed $callback The callback function or plugin action for the cron job to execute.
string $description The description of the cron job.
Returns:

Definition at line 119 of file crontab.php.

static CronTab::add_hourly_cron ( name,
callback,
description = '' 
) [static]

Add a new cron job to the DB, that runs hourly.

Parameters:
string $name The name of the cron job.
mixed $callback The callback function or plugin action for the cron job to execute.
string $description The description of the cron job.
Returns:

Definition at line 100 of file crontab.php.

static CronTab::add_monthly_cron ( name,
callback,
description = '' 
) [static]

Add a new cron job to the DB, that runs monthly.

Parameters:
string $name The name of the cron job.
mixed $callback The callback function or plugin action for the cron job to execute.
string $description The description of the cron job.
Returns:

Definition at line 157 of file crontab.php.

static CronTab::add_single_cron ( name,
callback,
run_time,
description = '' 
) [static]

Add a new cron job to the DB, that runs only once.

Parameters:
string $name The name of the cron job.
mixed $callback The callback function or plugin action for the cron job to execute.
DateTime $run_time The time to execute the cron.
string $description The description of the cron job.
Returns:

Definition at line 80 of file crontab.php.

Referenced by Update::check_plugins(), and Posts::update_scheduled_posts_cronjob().

static CronTab::add_weekly_cron ( name,
callback,
description = '' 
) [static]

Add a new cron job to the DB, that runs weekly.

Parameters:
string $name The name of the cron job.
mixed $callback The callback function or plugin action for the cron job to execute.
string $description The description of the cron job.
Returns:

Definition at line 138 of file crontab.php.

static CronTab::delete_cronjob ( name  )  [static]

Delete a Cron Job by name or id from the Database.

Parameters:
mixed $name The name or id of the cron job to delete.
Returns:
bool Wheather or not the delete was successfull

Definition at line 37 of file crontab.php.

Referenced by Posts::update_scheduled_posts_cronjob().

static CronTab::get_cronjob ( name  )  [static]

Get a Cron Job by name or id from the Database.

Parameters:
mixed $name The name or id of the cron job to retreive.
Returns:
The cron job retreived from the DB

Definition at line 20 of file crontab.php.

Referenced by add_cron(), and delete_cronjob().


The documentation for this class was generated from the following file: