ProcessSchedulerBaseCommand Class Reference

Run the next job in scheduler list. More...

Inheritance diagram for ProcessSchedulerBaseCommand:

List of all members.

Public Member Functions
	get_description ()
	Returns a description of this command.
	get_name ()
	Returns title of command.
Protected Member Functions
	do_execute ()
	Does processing.
	on_error ($task, $err)
	Handle errors.
	on_success ($task, $err)
	Handle success.
	run_task ($task)
	Run a task.

---

Detailed Description

Run the next job in scheduler list.

Definition at line 5 of file processscheduler.cmd.php.

---

Member Function Documentation

ProcessSchedulerBaseCommand::do_execute

(

)

[protected]

Does processing.

Reimplemented from CommandChain.

Reimplemented in CleanupSchedulerBaseCommand.

Definition at line 9 of file processscheduler.cmd.php.

                                        {
                $ret = new Status();
                $task = $this->get_params();
                $err_task = $this->run_task($task);
                $this->append(CommandsFactory::create_command($task, 'reschedule', $err_task));
                if ($err_task->is_error()) {
                        $ret->merge($this->on_error($task, $err_task));
                }
                else {
                        $ret->merge($this->on_success($task, $err_task));
                }
                return $ret;
        } 

ProcessSchedulerBaseCommand::get_description

(

)

Returns a description of this command.

Reimplemented from CommandBase.

Reimplemented in CleanupSchedulerBaseCommand.

Definition at line 33 of file processscheduler.cmd.php.

                                          {
                return tr('Process', 'scheduler');      
        }       

ProcessSchedulerBaseCommand::get_name

(

)

Returns title of command.

Reimplemented from CommandBase.

Reimplemented in CleanupSchedulerBaseCommand.

Definition at line 26 of file processscheduler.cmd.php.

                                   {
                return 'process';
        }

ProcessSchedulerBaseCommand::on_error	(	$	task,
		$	err
	)			[protected]

Handle errors.

Parameters:

	DAOScheduler	$task
	Status	$err

Returns:

Status

Definition at line 61 of file processscheduler.cmd.php.

                                                 {
                $ret = new Status();

                if (Config::has_feature(ConfigScheduler::SEND_ERROR_MAIL)) {
                        Load::commands('generics/mail');
                        $cmd_admin = new MailCommand(
                                tr('Task "%t" failed', 'scheduler', array('%t' => $task->name)),
                                Config::get_value(Config::MAIL_ADMIN),
                                'scheduler/mail/error_admin',
                                array(
                                        'error' => $err,
                                        'task' => $task                 
                                )
                        );
                        $this->append($cmd_admin);
                }
                
                return $ret;
        }

ProcessSchedulerBaseCommand::on_success	(	$	task,
		$	err
	)			[protected]

Handle success.

Parameters:

	DAOScheduler	$task
	Status	$err

Returns:

Status

Definition at line 88 of file processscheduler.cmd.php.

                                                   {
                $ret = new Status();
                return $ret;
        }

ProcessSchedulerBaseCommand::run_task

(

$

task

)

[protected]

Run a task.

Parameters:

DAOScheduler

$task

Returns:

Status

Definition at line 43 of file processscheduler.cmd.php.

                                           {
                $ret = new Status();
                if (empty($task)) {
                        return $ret;            
                }
                
                Load::components('console');
                $ret->merge(Console::invoke($task->action));
                return $ret;
        }

---

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

• contributions/scheduler/behaviour/commands/base/processscheduler.cmd.php