ScheduledTaskManager Class Reference

Manages scheduled task registration and execution. More...

Public Member Functions
	__construct ()
	Creates a ScheduledTaskManager. More...
	getTasks ()
	Retrieves all the registered scheduled tasks. More...
	executeTask ($component, $task_name)
	Executes the specified scheduled task. More...
	runTasks ()
	Runs all the tasks that are scheduled to be run for the current period (day and hour). More...

Static Public Member Functions
static	registerScheduledTaskWorkers ()
	Registers a simple task that sends an email when triggered. More...
static	setDefaults ()
static	registerWorker ($component, $task_name, $handler, $hourly=false)
	Registers a Scheduled Task worker method. More...
static	getTabs ($key)
static	testTask ()
	Provides the implementation of the test task, that can be used to validate the scheduled task server configuration (cron job, etc) More...
static	upgradeComponent ($version)

Static Public Attributes
static	$workers = array()

Detailed Description

Manages scheduled task registration and execution.

Scheduled tasks are tasks that can be run periodically without user initiation, triggered by a cron job or Windows scheduled task. Components can register tasks by subscribing to the RegisterScheduledTaskWorkers event. Registered tasks can then be configured for scheduled execution via the admin screens.

Definition at line 16 of file scheduled_task_manager.inc.

Constructor & Destructor Documentation

__construct()

ScheduledTaskManager::__construct

(

)

Creates a ScheduledTaskManager.

Definition at line 23 of file scheduled_task_manager.inc.

     {
          ComponentManager::fireEvent("RegisterScheduledTaskWorkers");
     }

Member Function Documentation

executeTask()

ScheduledTaskManager::executeTask	(		$component,
			$task_name
	)

Executes the specified scheduled task.

Parameters

string	$component	the name of the component that owns the task
string	$task_name	the name of the task to be executed

Definition at line 93 of file scheduled_task_manager.inc.

     {
          trace("-- Executing Task '{$component}: $task_name'", 3);
          
          $task = ScheduledTask::getInstance($component, $task_name);
          
          if (!$task)
          {
               // Report an error
          }
 
          $timestamp = now();
          
          $worker = ScheduledTaskManager::$workers[$component.':'.$task_name];
          ob_start();
          $result = call_user_func($worker);
          $output = ob_get_contents();
          ob_end_clean();
          
          $log = new ScheduledTaskLogEntry();
          $log->task_id = $task->task_id;
          $log->log_date = $timestamp;
          $log->log = $output;
          $log->status = $result;
          $log->save();
     }

getTabs()

static ScheduledTaskManager::getTabs (   $key )

static

Definition at line 71 of file scheduled_task_manager.inc.

     {
          $tabs = array("Task Schedule" =>   "/admin/scheduled_task_form",
                           "Execution Logs"  =>   "/admin/scheduled_task_logs");
     
          $qs = ($key) ? "task_id=$key" : "";
          return new TabBar("tabs", $tabs, $qs);
     }

getTasks()

ScheduledTaskManager::getTasks

(

)

Retrieves all the registered scheduled tasks.

Definition at line 83 of file scheduled_task_manager.inc.

     {
          return Query::create(ScheduledTask, "ORDER BY component, task_name")->execute();
     }

registerScheduledTaskWorkers()

static ScheduledTaskManager::registerScheduledTaskWorkers ( )

static

Registers a simple task that sends an email when triggered.

This can be used to validate the configuration of the cron job / scheduled task environment.

Definition at line 32 of file scheduled_task_manager.inc.

     {
          ScheduledTaskManager::registerWorker("scheduled_task", "Validate Configuration", array(ScheduledTaskManager, testTask));
     }

registerWorker()

static ScheduledTaskManager::registerWorker (   $component,   $task_name,   $handler,   $hourly = false  )

static

Registers a Scheduled Task worker method.

This method should be called from within the component's RegisterScheduledTaskWorkers event handler. Components are free to register as many scheduled task workers as they need.

Parameters

string	$component	the name of the component that owns the worker
string	$task_name	the display name of the task
callback	$handler	the handler method to call to execute the task
boolean	$hourly	true if this task should always be executed every hour, false if the task should be explicitly scheduled by the user

Definition at line 52 of file scheduled_task_manager.inc.

     {
          ScheduledTaskManager::$workers[$component.":".$task_name] = $handler;
          
          try
          {
               $task = ScheduledTask::getInstance($component, $task_name);
          }
          catch(DataNotFoundException $e)
          {
               $task = new ScheduledTask();
               $task->component = $component;
               $task->task_name = $task_name;
               $task->active = false;
               $task->run_every_hour = $hourly;
               $task->save();
          }
     }

runTasks()

ScheduledTaskManager::runTasks

(

)

Runs all the tasks that are scheduled to be run for the current period (day and hour).

Definition at line 123 of file scheduled_task_manager.inc.

     {
          global $config;
          
          Fakoli::scheduledTaskTraceLevel();
          
          $currentPeriod = TaskScheduleHelper::calculatePeriod();
          trace("** Running tasks for period $currentPeriod", 3);
          
          $tasks = $this->getTasks();
          $count = 0;
          
          foreach($tasks as $task)
          {
               if (!$task->active) continue;
               if ($task->run_every_hour || strpos($task->schedule, $currentPeriod) !== false)
               {
                    $this->executeTask($task->component, $task->task_name);
                    ++$count;
               }
          }
          
          trace("$count ".pluralize("task", $count)." executed", 3);
 
          Fakoli::coreTraceLevel();
     }

setDefaults()

static ScheduledTaskManager::setDefaults ( )

static

Definition at line 37 of file scheduled_task_manager.inc.

     {
          Settings::setDefaultValue('scheduled_task', 'test_email', '', 'String', 'Comma-separated list of recipients for the test task');
     }

testTask()

static ScheduledTaskManager::testTask ( )

static

Provides the implementation of the test task, that can be used to validate the scheduled task server configuration (cron job, etc)

Definition at line 154 of file scheduled_task_manager.inc.

     {
          global $config;
          
          trace("Running Validation Configuration task", 3);
          
          $email = Settings::getValue('scheduled_task', 'test_email');
          if (!$email) 
          {
               $email = Settings::getValue("settings", "system_notification_email");
          }
          
          $site_email_from =  Settings::getValue('email', 'email_from');
          $site_email_name =  Settings::getValue('email', 'email_name');
          
          if (!$email) return;
          
          trace("Sending confirmation email to {$email}", 3);
          
          $mail = new EmailHandler($email, "Scheduled Task Notification from {$config['site_name']}", 
                                        "This message confirms that the Validate Configuration schedule task worker was triggered at ".now(), 
                                        $site_email_from, 
                                        $site_email_name);
          $mail->send();
               
          echo "Confirmation email sent";
          
          return "Success";
     }

upgradeComponent()

static ScheduledTaskManager::upgradeComponent (   $version )

static

Definition at line 184 of file scheduled_task_manager.inc.

     {
          $mgr = new ScheduledTaskUpgradeManager();
          $mgr->upgrade($version);
     }

Member Data Documentation

$workers

ScheduledTaskManager::$workers = array()

static

Definition at line 18 of file scheduled_task_manager.inc.

---

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

• C:/code/cms.sonjara.com/cms/components/scheduled_task/scheduled_task_manager.inc