ilBackgroundTask Class Reference

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.

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

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

Here is the call graph for this function:

Member Function Documentation

delete()

ilBackgroundTask::delete

(

)

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

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

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

Here is the call graph for this function:

doCreate()

ilBackgroundTask::doCreate ( )

protected

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

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

Referenced by save().

    {
        global $DIC;
        $ilDB = $DIC['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;
    }

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 382 of file class.ilBackgroundTask.php.

References $DIC, $ilDB, array, and getId().

Referenced by delete().

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

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 307 of file class.ilBackgroundTask.php.

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

Referenced by __construct(), and isToBeCancelled().

    {
        global $DIC;
        $ilDB = $DIC['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);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

doUpdate()

ilBackgroundTask::doUpdate ( )

protected

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

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

Referenced by save().

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

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 275 of file class.ilBackgroundTask.php.

References $exists.

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

    {
        return $this->exists;
    }

Here is the caller graph for this function:

getActiveByUserId()

static ilBackgroundTask::getActiveByUserId (   $a_user_id )

static

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

References $DIC, $ilDB, $res, $row, and array.

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

    {
        global $DIC;
        $ilDB = $DIC['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;
    }

Here is the caller graph for this function:

getCurrentStep()

ilBackgroundTask::getCurrentStep

(

)

Gets the current step.

Returns

int The value.

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

References $current_step.

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

    {
        return $this->current_step;
    }

Here is the caller graph for this function:

getHandlerId()

ilBackgroundTask::getHandlerId

(

)

Gets the handler.

Returns

string The value.

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

References $handler.

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

    {
        return $this->handler;
    }

Here is the caller graph for this function:

getHandlerInstance()

ilBackgroundTask::getHandlerInstance

(

)

Returns

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

References getHandlerId().

    {
        $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);
        }
    }

Here is the call graph for this function:

getId()

ilBackgroundTask::getId

(

)

Gets the id.

Returns

int The value.

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

References $id.

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

    {
        return $this->id;
    }

Here is the caller graph for this function:

getParams()

ilBackgroundTask::getParams

(

)

Gets the params.

Returns

int The value.

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

References $params.

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

    {
        return $this->params;
    }

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 160 of file class.ilBackgroundTask.php.

References $start_date.

Referenced by preparePropertiesForDB().

    {
        return $this->start_date;
    }

Here is the caller graph for this function:

getStatus()

ilBackgroundTask::getStatus

(

)

Gets the status.

Returns

int The value.

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

References $status.

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

    {
        return $this->status;
    }

Here is the caller graph for this function:

getSteps()

ilBackgroundTask::getSteps

(

)

Gets the steps.

Returns

int The value.

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

References $steps.

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

    {
        return $this->steps;
    }

Here is the caller graph for this function:

getUserId()

ilBackgroundTask::getUserId

(

)

Gets the user id.

Returns

int The value.

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

References $user_id.

Referenced by preparePropertiesForDB().

    {
        return $this->user_id;
    }

Here is the caller graph for this function:

getValidStatus()

ilBackgroundTask::getValidStatus ( )

protected

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

References array.

Referenced by setStatus().

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

Here is the caller graph for this function:

isToBeCancelled()

ilBackgroundTask::isToBeCancelled

(

)

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

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

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

Here is the call graph for this function:

preparePropertiesForDB()

ilBackgroundTask::preparePropertiesForDB ( )

protected

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

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

Referenced by doCreate(), and doUpdate().

    {
        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)
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilBackgroundTask::save

(

)

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

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

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

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 245 of file class.ilBackgroundTask.php.

References getSteps().

Referenced by doRead().

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

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 110 of file class.ilBackgroundTask.php.

Referenced by doRead().

    {
        $this->handler = $a_val;
    }

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 130 of file class.ilBackgroundTask.php.

Referenced by doCreate(), and doRead().

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

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 265 of file class.ilBackgroundTask.php.

Referenced by doRead().

    {
        $this->params = $a_params;
    }

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 170 of file class.ilBackgroundTask.php.

Referenced by doCreate(), and doRead().

    {
        $this->start_date = $a_val;
    }

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 203 of file class.ilBackgroundTask.php.

References getValidStatus().

Referenced by doRead().

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

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 225 of file class.ilBackgroundTask.php.

Referenced by doRead().

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

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 150 of file class.ilBackgroundTask.php.

Referenced by doRead().

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

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