Background task. More...

Collaboration diagram for ilBackgroundTask:

Public Member Functions
	__construct ($a_id=0)
	Constructor. More...

	getHandlerInstance ()

	isToBeCancelled ()

	getHandlerId ()
	Gets the handler. More...

	setHandlerId ($a_val)
	Sets the handler id. More...

	getId ()
	Gets the id. More...

	getUserId ()
	Gets the user id. More...

	setUserId ($a_val)
	Sets the user id. More...

	getStartDate ()
	Gets the date when the download was started. More...

	getStatus ()
	Gets the status. More...

	setStatus ($a_val)
	Sets the status. More...

	getSteps ()
	Gets the steps. More...

	setSteps ($a_val)
	Sets the steps. More...

	getCurrentStep ()
	Gets the current step. More...

	setCurrentStep ($a_val)
	Sets the current step. More...

	getParams ()
	Gets the params. More...

	setParams (array $a_params=null)
	Sets the params. More...

	exists ()
	Gets whether the download object exists. More...

	save ()

	delete ()

Static Public Member Functions
static	getActiveByUserId ($a_user_id)

Data Fields
const	STATUS_INITIALIZED = "initialized"

const	STATUS_PROCESSING = "processing"

const	STATUS_PROCESSED = "processed"

const	STATUS_CANCELLING = "cancelling"

const	STATUS_CANCELLED = "cancelled"

const	STATUS_FINISHED = "finished"

const	STATUS_FAILED = "failed"

const	DB_NAME = "background_task"

Protected Member Functions
	setId ($a_val)
	Sets the id. More...

	setStartDate (ilDateTime $a_val)
	Sets the date when the download was started. More...

	getValidStatus ()

	doRead ($a_id)

	preparePropertiesForDB ()

	doCreate ()

	doUpdate ()

	doDelete ()
	Deletes the object from the database. More...

Protected Attributes
	$id

	$user_id

	$start_date

	$status

	$steps

	$current_step

	$handler

	$params

	$exists

	$log

Detailed Description

Background task.

Author: Stefan Born stefa.nosp@m.n.bo.nosp@m.rn@ph.nosp@m.zh.c.nosp@m.h; Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Definition at line 11 of file class.ilBackgroundTask.php.

Constructor & Destructor Documentation

◆ __construct()

ilBackgroundTask::__construct ( $a_id = 0 )

Constructor.

Parameters

int $a_id

Returns: self

Definition at line 45 of file class.ilBackgroundTask.php.

        {
                $this->log = ilLoggerFactory::getLogger('btsk');
                if ($a_id != 0)
                {
                        $this->doRead($a_id);
                }
        }       

References doRead(), and ilLoggerFactory\getLogger().

Here is the call graph for this function:

Member Function Documentation

◆ delete()

ilBackgroundTask::delete ( )

Definition at line 302 of file class.ilBackgroundTask.php.

        {
                $this->log->debug($this->getHandlerId());
                if(!$this->exists)
                {
                        return;
                }
                
                return $this->doDelete();                       
        }

References doDelete(), exists(), and getHandlerId().

Here is the call graph for this function:

◆ doCreate()

ilBackgroundTask::doCreate ( )

protected

Definition at line 357 of file class.ilBackgroundTask.php.

        {
                global $ilDB;
                                                
                $this->setId($ilDB->nextId(self::DB_NAME));             
                $this->setStartDate(new ilDateTime(time(), IL_CAL_UNIX));
                
                $fields = $this->preparePropertiesForDB();
                $fields["id"] = array("integer", $this->getId());
                
                $ilDB->insert(self::DB_NAME, $fields);
                
                $this->exists = true;
        }

References $ilDB, exists(), getId(), IL_CAL_UNIX, preparePropertiesForDB(), setId(), and setStartDate().

Referenced by save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doDelete()

ilBackgroundTask::doDelete ( )

protected

Deletes the object from the database.

Definition at line 386 of file class.ilBackgroundTask.php.

        {
                global $ilDB;
                
                return $ilDB->manipulateF(
                    "DELETE FROM " . self::DB_NAME . " WHERE id=%s",
                        array("integer"), 
                        array($this->getId()));
        }

References $ilDB, and getId().

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doRead()

ilBackgroundTask::doRead ( $a_id )

protected

Definition at line 314 of file class.ilBackgroundTask.php.

        {
                global $ilDB;
 
                $this->log->debug($this->getHandlerId()."/".$a_id);
                
                $set = $ilDB->queryF(
                        "SELECT * FROM " . self::DB_NAME . " WHERE id=%s", 
                        array("integer"), 
                        array($a_id));
                
                while ($rec = $ilDB->fetchAssoc($set))
                {
                        $this->setId($a_id);            
                        $this->exists = true;
                        
                        $this->setUserId($rec["user_id"]);                      
                        $this->setStartDate(new ilDateTime($rec["start_date"], IL_CAL_DATETIME));               
                        $this->setStatus($rec["status"]);               
                        $this->setSteps($rec["steps"]);
                        $this->setCurrentStep($rec["cstep"]);
                        $this->setHandlerId($rec["handler"]);
                        $this->setParams($rec["params"] 
                                ? unserialize($rec["params"])
                                : null);
                }
        }

References $ilDB, exists(), getHandlerId(), IL_CAL_DATETIME, setCurrentStep(), setHandlerId(), setId(), setParams(), setStartDate(), setStatus(), setSteps(), and setUserId().

Referenced by __construct(), and isToBeCancelled().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doUpdate()

ilBackgroundTask::doUpdate ( )

protected

Definition at line 372 of file class.ilBackgroundTask.php.

        {
                global $ilDB;
                
                $ilDB->update(
                        self::DB_NAME, 
                        $this->preparePropertiesForDB(),
                        array("id" => array("integer", $this->getId()))
                );
        }

References $ilDB, getId(), and preparePropertiesForDB().

Referenced by save().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exists()

ilBackgroundTask::exists ( )

Gets whether the download object exists.

Returns: boolean The value.

Definition at line 278 of file class.ilBackgroundTask.php.

        {
                return $this->exists;
        }       

References $exists.

Referenced by delete(), doCreate(), doRead(), and save().

Here is the caller graph for this function:

◆ getActiveByUserId()

static ilBackgroundTask::getActiveByUserId ( $a_user_id )

static

Definition at line 69 of file class.ilBackgroundTask.php.

        {
                global $ilDB;
                
                $res = array();
                
                $set = $ilDB->query("SELECT id FROM ".self::DB_NAME.
                        " WHERE user_id = ".$ilDB->quote($a_user_id, "integer").
                        " AND status = ".$ilDB->quote(self::STATUS_PROCESSING, "text"));
                while($row = $ilDB->fetchAssoc($set))
                {
                        $res[] = $row["id"];
                }
                
                return $res;
        }

References $ilDB, $res, and $row.

Referenced by ilFolderDownloadBackgroundTaskHandler\init(), and ilBackgroundTaskHub\unblock().

Here is the caller graph for this function:

◆ getCurrentStep()

ilBackgroundTask::getCurrentStep ( )

Gets the current step.

Returns: int The value.

Definition at line 238 of file class.ilBackgroundTask.php.

        {
                return $this->current_step;
        }

References $current_step.

Referenced by ilBackgroundTaskJson\getProgressJson(), and preparePropertiesForDB().

Here is the caller graph for this function:

◆ getHandlerId()

ilBackgroundTask::getHandlerId ( )

Gets the handler.

Returns: string The value.

Definition at line 102 of file class.ilBackgroundTask.php.

        {
                return $this->handler;
        }

References $handler.

Referenced by delete(), doRead(), getHandlerInstance(), preparePropertiesForDB(), and save().

Here is the caller graph for this function:

◆ getHandlerInstance()

ilBackgroundTask::getHandlerInstance ( )

Returns: \ilBackgroundTaskHandler

Definition at line 58 of file class.ilBackgroundTask.php.

        {
                $handler_id = $this->getHandlerId();
                $this->log->debug("Handler ID: ".$handler_id);
                if($handler_id)
                {
                        include_once "Services/BackgroundTask/classes/class.".$handler_id.".php";
                        return $handler_id::getInstanceFromTask($this);
                }
        }

References getHandlerId().

Here is the call graph for this function:

◆ getId()

ilBackgroundTask::getId ( )

Gets the id.

Returns: int The value.

Definition at line 122 of file class.ilBackgroundTask.php.

        {
                return $this->id;
        }

References $id.

Referenced by doCreate(), doDelete(), doUpdate(), and isToBeCancelled().

Here is the caller graph for this function:

◆ getParams()

ilBackgroundTask::getParams ( )

Gets the params.

Returns: int The value.

Definition at line 258 of file class.ilBackgroundTask.php.

        {
                return $this->params;
        }

References $params.

Referenced by ilFolderDownloadBackgroundTaskHandler\getInstanceFromTask(), and preparePropertiesForDB().

Here is the caller graph for this function:

◆ getStartDate()

ilBackgroundTask::getStartDate ( )

Gets the date when the download was started.

Returns: ilDateTime The value.

Definition at line 162 of file class.ilBackgroundTask.php.

        {
                return $this->start_date;
        }

References $start_date.

Referenced by preparePropertiesForDB().

Here is the caller graph for this function:

◆ getStatus()

ilBackgroundTask::getStatus ( )

Gets the status.

Returns: int The value.

Definition at line 182 of file class.ilBackgroundTask.php.

        {
                return $this->status;
        }

References $status.

Referenced by ilBackgroundTaskJson\getProgressJson(), isToBeCancelled(), and preparePropertiesForDB().

Here is the caller graph for this function:

◆ getSteps()

ilBackgroundTask::getSteps ( )

Gets the steps.

Returns: int The value.

Definition at line 218 of file class.ilBackgroundTask.php.

        {
                return $this->steps;
        }

References $steps.

Referenced by ilBackgroundTaskJson\getProgressJson(), preparePropertiesForDB(), and setCurrentStep().

Here is the caller graph for this function:

◆ getUserId()

ilBackgroundTask::getUserId ( )

Gets the user id.

Returns: int The value.

Definition at line 142 of file class.ilBackgroundTask.php.

        {
                return $this->user_id;
        }

References $user_id.

Referenced by preparePropertiesForDB().

Here is the caller graph for this function:

◆ getValidStatus()

ilBackgroundTask::getValidStatus ( )

protected

Definition at line 187 of file class.ilBackgroundTask.php.

        {
                return array(
                        self::STATUS_INITIALIZED,
                        self::STATUS_PROCESSING,
                        self::STATUS_CANCELLING,
                        self::STATUS_CANCELLED,                 
                        self::STATUS_PROCESSED,
                        self::STATUS_FINISHED,
                        self::STATUS_FAILED,
                );
        }

Referenced by setStatus().

Here is the caller graph for this function:

◆ isToBeCancelled()

ilBackgroundTask::isToBeCancelled ( )

Definition at line 86 of file class.ilBackgroundTask.php.

        {
                $this->doRead($this->getId());
                return ($this->getStatus() == self::STATUS_CANCELLING);
        }

References doRead(), getId(), and getStatus().

Here is the call graph for this function:

◆ preparePropertiesForDB()

ilBackgroundTask::preparePropertiesForDB ( )

protected

Definition at line 342 of file class.ilBackgroundTask.php.

        {
                return array(
                        "user_id" => array("integer", $this->getUserId()),                      
                        "start_date" => array("timestamp", $this->getStartDate()->get(IL_CAL_DATETIME)),                                
                        "status" => array("text", $this->getStatus()),
                        "steps" => array("integer", $this->getSteps()),
                        "cstep" => array("integer", $this->getCurrentStep()),
                        "handler" => array("string", $this->getHandlerId()),
                        "params" => array("string", is_array($this->getParams())
                                ? serialize($this->getParams())
                                : null)
                );
        }

References getCurrentStep(), getHandlerId(), getParams(), getStartDate(), getStatus(), getSteps(), getUserId(), and IL_CAL_DATETIME.

Referenced by doCreate(), and doUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilBackgroundTask::save ( )

Definition at line 288 of file class.ilBackgroundTask.php.

        {
                $this->log->debug($this->getHandlerId());
                // does not exist yet?
                if (!$this->exists)
                {
                        $this->doCreate();
                }
                else
                {
                        $this->doUpdate();
                }
        }

References doCreate(), doUpdate(), exists(), and getHandlerId().

Here is the call graph for this function:

◆ setCurrentStep()

ilBackgroundTask::setCurrentStep ( $a_val )

Sets the current step.

Parameters

int $a_val The new value.

Definition at line 248 of file class.ilBackgroundTask.php.

        {               
                $this->current_step = min(abs($a_val), $this->getSteps());
        }

References getSteps().

Referenced by doRead().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHandlerId()

ilBackgroundTask::setHandlerId ( $a_val )

Sets the handler id.

Parameters

$a_val The new value.

Definition at line 112 of file class.ilBackgroundTask.php.

        {
                $this->handler = $a_val;
        }

Referenced by doRead().

Here is the caller graph for this function:

◆ setId()

ilBackgroundTask::setId ( $a_val )

protected

Sets the id.

Parameters

int $a_val The new value.

Definition at line 132 of file class.ilBackgroundTask.php.

        {
                $this->id = (int)$a_val;
        }

Referenced by doCreate(), and doRead().

Here is the caller graph for this function:

◆ setParams()

ilBackgroundTask::setParams ( array $a_params = null )

Sets the params.

Parameters

array $a_val The new value.

Definition at line 268 of file class.ilBackgroundTask.php.

        {
                $this->params = $a_params;
        }

Referenced by doRead().

Here is the caller graph for this function:

◆ setStartDate()

ilBackgroundTask::setStartDate ( ilDateTime $a_val )

protected

Sets the date when the download was started.

Parameters

ilDateTime $a_val The new value.

Definition at line 172 of file class.ilBackgroundTask.php.

        {
                $this->start_date = $a_val;
        }

Referenced by doCreate(), and doRead().

Here is the caller graph for this function:

◆ setStatus()

ilBackgroundTask::setStatus ( $a_val )

Sets the status.

Parameters

int $a_val The new value.

Definition at line 205 of file class.ilBackgroundTask.php.

        {
                if(in_array($a_val, $this->getValidStatus()))
                {
                        $this->status = $a_val;
                }
        }

References getValidStatus().

Referenced by doRead().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSteps()

ilBackgroundTask::setSteps ( $a_val )

Sets the steps.

Parameters

int $a_val The new value.

Definition at line 228 of file class.ilBackgroundTask.php.

        {
                $this->steps = abs($a_val);
        }

Referenced by doRead().

Here is the caller graph for this function:

◆ setUserId()

ilBackgroundTask::setUserId ( $a_val )

Sets the user id.

Parameters

int $a_val The new value.

Definition at line 152 of file class.ilBackgroundTask.php.

        {
                $this->user_id = (int)$a_val;
        }

Referenced by doRead().

Here is the caller graph for this function:

Field Documentation

◆ $current_step

ilBackgroundTask::$current_step

protected

Definition at line 18 of file class.ilBackgroundTask.php.

Referenced by getCurrentStep().

◆ $exists

ilBackgroundTask::$exists

protected

Definition at line 21 of file class.ilBackgroundTask.php.

Referenced by exists().

◆ $handler

ilBackgroundTask::$handler

protected

Definition at line 19 of file class.ilBackgroundTask.php.

Referenced by getHandlerId().

◆ $id

ilBackgroundTask::$id

protected

Definition at line 13 of file class.ilBackgroundTask.php.

Referenced by getId().

◆ $log

ilBackgroundTask::$log

protected

Definition at line 26 of file class.ilBackgroundTask.php.

◆ $params

ilBackgroundTask::$params

protected

Definition at line 20 of file class.ilBackgroundTask.php.

Referenced by getParams().

◆ $start_date

ilBackgroundTask::$start_date

protected

Definition at line 15 of file class.ilBackgroundTask.php.

Referenced by getStartDate().

◆ $status

ilBackgroundTask::$status

protected

Definition at line 16 of file class.ilBackgroundTask.php.

Referenced by getStatus().

◆ $steps

ilBackgroundTask::$steps

protected

Definition at line 17 of file class.ilBackgroundTask.php.

Referenced by getSteps().

◆ $user_id

ilBackgroundTask::$user_id

protected

Definition at line 14 of file class.ilBackgroundTask.php.

Referenced by getUserId().

◆ DB_NAME

const ilBackgroundTask::DB_NAME = "background_task"

Definition at line 37 of file class.ilBackgroundTask.php.

Referenced by ilBackgroundTaskCronGarbageCollection\run().

◆ STATUS_CANCELLED

const ilBackgroundTask::STATUS_CANCELLED = "cancelled"

Definition at line 33 of file class.ilBackgroundTask.php.

Referenced by ilZipBackgroundTaskHandler\cancel().

◆ STATUS_CANCELLING

const ilBackgroundTask::STATUS_CANCELLING = "cancelling"

Definition at line 32 of file class.ilBackgroundTask.php.

Referenced by ilBackgroundTaskHub\cancel(), and ilBackgroundTaskHub\unblock().

◆ STATUS_FAILED

const ilBackgroundTask::STATUS_FAILED = "failed"

Definition at line 35 of file class.ilBackgroundTask.php.

◆ STATUS_FINISHED

const ilBackgroundTask::STATUS_FINISHED = "finished"

Definition at line 34 of file class.ilBackgroundTask.php.

Referenced by ilFolderDownloadBackgroundTaskHandler\init(), ilZipBackgroundTaskHandler\process(), and ilBackgroundTaskHub\progress().

◆ STATUS_INITIALIZED

const ilBackgroundTask::STATUS_INITIALIZED = "initialized"

Definition at line 29 of file class.ilBackgroundTask.php.

Referenced by ilFolderDownloadBackgroundTaskHandler\init().

◆ STATUS_PROCESSED

const ilBackgroundTask::STATUS_PROCESSED = "processed"

Definition at line 31 of file class.ilBackgroundTask.php.

◆ STATUS_PROCESSING

const ilBackgroundTask::STATUS_PROCESSING = "processing"

Definition at line 30 of file class.ilBackgroundTask.php.

Referenced by ilBackgroundTaskHub\process().

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

Services/BackgroundTask/classes/class.ilBackgroundTask.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ delete()

◆ doCreate()

◆ doDelete()

◆ doRead()

◆ doUpdate()

◆ exists()

◆ getActiveByUserId()

◆ getCurrentStep()

◆ getHandlerId()

◆ getHandlerInstance()

◆ getId()

◆ getParams()

◆ getStartDate()

◆ getStatus()

◆ getSteps()

◆ getUserId()

◆ getValidStatus()

◆ isToBeCancelled()

◆ preparePropertiesForDB()

◆ save()

◆ setCurrentStep()

◆ setHandlerId()

◆ setId()

◆ setParams()

◆ setStartDate()

◆ setStatus()

◆ setSteps()

◆ setUserId()

Field Documentation

◆ $current_step

◆ $exists

◆ $handler

◆ $id

◆ $log

◆ $params

◆ $start_date

◆ $status

◆ $steps

◆ $user_id

◆ DB_NAME

◆ STATUS_CANCELLED

◆ STATUS_CANCELLING

◆ STATUS_FAILED

◆ STATUS_FINISHED

◆ STATUS_INITIALIZED

◆ STATUS_PROCESSED

◆ STATUS_PROCESSING