dcCore dcCore instance
* @param p_url string Maintenance plugin url
*/
public function __construct($core, $p_url)
{
$this->core =& $core;
$this->init();
$this->p_url = $p_url;
$this->id = get_class($this);
if (!$this->name) {
$this->name = get_class($this);
}
if (!$this->error) {
$this->error = __('Failed to execute task.');
}
if (!$this->success) {
$this->success = __('Task successfully executed.');
}
$core->auth->user_prefs->addWorkspace('maintenance');
$ts = $core->auth->user_prefs->maintenance->get('ts_'.$this->id);
$this->ts = abs((integer) $ts);
}
/**
* Initialize task object.
*
* Better to set translated messages here than
* to rewrite constructor.
*/
protected function init()
{
return null;
}
/**
* Set $code for task having multiple steps.
*
* @param code integer Code used for task execution
*/
public function code($code)
{
$this->code = (integer) $code;
}
/**
* Get timestamp between maintenances.
*
* @return intetger Timestamp
*/
public function ts()
{
return $this->ts === false ? false : abs((integer) $this->ts);
}
/**
* Get task ID.
*
* @return string Task ID (class name)
*/
public function id()
{
return $this->id;
}
/**
* Get task name.
*
* @return string Task name
*/
public function name()
{
return $this->name;
}
/**
* Get task tab.
*
* @return mixed Task tab ID or null
*/
public function tab()
{
return $this->tab;
}
/**
* Get task group.
*
* If task required a full tab,
* this must be returned null.
*
* @return mixed Task group ID or null
*/
public function group()
{
return $this->group;
}
/**
* Use ajax
*
* Is task use maintenance ajax script
* for steps process.
*
* @return boolean Use ajax
*/
public function ajax()
{
return (boolean) $this->ajax;
}
/**
* Get task message.
*
* This message is used on form button.
*
* @return string Message
*/
public function task()
{
return $this->task;
}
/**
* Get step message.
*
* This message is displayed during task step execution.
*
* @return mixed Message or null
*/
public function step()
{
return $this->step;
}
/**
* Get success message.
*
* This message is displayed when task is accomplished.
*
* @return mixed Message or null
*/
public function success()
{
return $this->success;
}
/**
* Get error message.
*
* This message is displayed on error.
*
* @return mixed Message or null
*/
public function error()
{
return $this->error;
}
/**
* Get header.
*
* Headers required on maintenance page.
*
* @return mixed Message or null
*/
public function header()
{
return null;
}
/**
* Get content.
*
* Content for full tab task.
*
* @return string Tab's content
*/
public function content()
{
return null;
}
/**
* Execute task.
*
* @return mixed :
* - FALSE on error,
* - TRUE if task is finished
* - INTEGER if task required a next step
*/
public function execute()
{
return null;
}
/**
* Log task execution.
*
* Sometimes we need to log task execution
* direct from task itself.
*
*/
protected function log()
{
$maintenance = new dcMaintenance($this->core);
$maintenance->setLog($this->id);
}
}