Inherits DataItem.

Public Member Functions
	LogEntries ($constraint="")

	LastRun ()

	run ()

Static Public Member Functions
static	getInstance ($component, $task_name)

Public Attributes
	$table = "scheduled_task"

	$primary_key = "task_id"

	$fields

	$relations

Detailed Description

Definition at line 7 of file scheduled_task.inc.

Member Function Documentation

◆ getInstance()

static ScheduledTask::getInstance	(	$component,
		$task_name
	)

static

Definition at line 27 of file scheduled_task.inc.

      {
           return Query::create(ScheduledTask, "WHERE component=:c AND task_name=:t")
                         ->bind(":c", $component, ":t", $task_name)
                         ->executeSingle();
      }

◆ LastRun()

ScheduledTask::LastRun ( )

Definition at line 34 of file scheduled_task.inc.

      {
           if ($this->_lastRun) return $this->_lastRun;
           $lastRun = $this->LogEntries("ORDER BY log_date DESC limit 1");
           $this->_lastRun = $lastRun;
           return $lastRun;
      }

◆ LogEntries()

ScheduledTask::LogEntries ( $constraint = "" )

Definition at line 22 of file scheduled_task.inc.

      {
           return $this->getRelatedList(ScheduledTaskLogEntry, "", $constraint);
      }

◆ run()

ScheduledTask::run ( )

Definition at line 42 of file scheduled_task.inc.

      {
           $mgr = new ScheduledTaskManager();
           $mgr->executeTask($this->component, $this->task_name);
      }

Member Data Documentation

◆ $fields

ScheduledTask::$fields

Initial value:

= array("task_id"             =>   Number,
                              "component"              =>   String,
                              "task_name"              =>   String,
                              "run_every_hour"    =>   Boolean,
                              "schedule"               =>   TaskSchedule,
                              "active"            =>   Boolean)

Definition at line 12 of file scheduled_task.inc.

◆ $primary_key

ScheduledTask::$primary_key = "task_id"

Definition at line 10 of file scheduled_task.inc.

◆ $relations

ScheduledTask::$relations

Initial value:

= array("LogEntries" => ScheduledTaskLogEntry,

"LastRun" => ScheduledTaskLogEntry)

Definition at line 19 of file scheduled_task.inc.

◆ $table

ScheduledTask::$table = "scheduled_task"

Definition at line 9 of file scheduled_task.inc.

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

C:/code/cms.sonjara.com/cms/components/scheduled_task/datamodel/scheduled_task.inc

Public Member Functions

Static Public Member Functions

Public Attributes