Defines a system check task. More...

Inheritance diagram for ilSCTask:

Collaboration diagram for ilSCTask:

Public Member Functions
	__construct (int $a_id=0)

	getId ()

	setGroupId (int $a_id)

	getGroupId ()

	setIdentifier (string $a_ide)

	getIdentifier ()

	setLastUpdate (ilDateTime $a_update)

	getLastUpdate ()

	setStatus (int $a_status)

	getStatus ()

	isActive ()

	read ()

	create ()

	update ()

Data Fields
const	STATUS_NOT_ATTEMPTED = 0

const	STATUS_IN_PROGRESS = 1

const	STATUS_COMPLETED = 2

const	STATUS_FAILED = 3

Protected Attributes
ilDBInterface	$db

Private Attributes
int	$id = 0

int	$grp_id = 0

ilDateTime	$last_update = null

int	$status = 0

string	$identifier = ''

Detailed Description

Defines a system check task.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Definition at line 24 of file class.ilSCTask.php.

Constructor & Destructor Documentation

◆ __construct()

ilSCTask::__construct ( int $a_id = 0 )

Definition at line 39 of file class.ilSCTask.php.

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->id = $a_id;
        $this->read();
    }

References $DIC, and read().

Here is the call graph for this function:

Member Function Documentation

◆ create()

ilSCTask::create ( )

Definition at line 119 of file class.ilSCTask.php.

                            : int
    {
        $this->id = $this->db->nextId('sysc_tasks');
 
        $query = 'INSERT INTO sysc_tasks (id,grp_id,status,identifier) ' .
            'VALUES ( ' .
            $this->db->quote($this->getId(), ilDBConstants::T_INTEGER) . ', ' .
            $this->db->quote($this->getGroupId(), ilDBConstants::T_INTEGER) . ', ' .
            $this->db->quote($this->getStatus(), ilDBConstants::T_INTEGER) . ', ' .
            $this->db->quote($this->getIdentifier(), ilDBConstants::T_TEXT) . ' ' .
            ')';
        $this->db->manipulate($query);
        return $this->getId();
    }

References getGroupId(), getId(), getIdentifier(), getStatus(), ilDBConstants\T_INTEGER, and ilDBConstants\T_TEXT.

Here is the call graph for this function:

◆ getGroupId()

ilSCTask::getGroupId ( )

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

                                : int
    {
        return $this->grp_id;
    }

References $grp_id.

Referenced by create().

Here is the caller graph for this function:

◆ getId()

ilSCTask::getId ( )

Definition at line 48 of file class.ilSCTask.php.

                           : int
    {
        return $this->id;
    }

References $id.

Referenced by create(), read(), and update().

Here is the caller graph for this function:

◆ getIdentifier()

ilSCTask::getIdentifier ( )

Definition at line 68 of file class.ilSCTask.php.

                                   : string
    {
        return $this->identifier;
    }

References $identifier.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getLastUpdate()

ilSCTask::getLastUpdate ( )

Definition at line 78 of file class.ilSCTask.php.

                                   : ilDateTime
    {
        if (!$this->last_update) {
            return $this->last_update = new ilDateTime();
        }
        return $this->last_update;
    }

References $last_update.

Referenced by update().

Here is the caller graph for this function:

◆ getStatus()

ilSCTask::getStatus ( )

Definition at line 91 of file class.ilSCTask.php.

                               : int
    {
        return $this->status;
    }

References $status.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ isActive()

ilSCTask::isActive ( )

Reimplemented in ilSCTreeDumpTask.

Definition at line 96 of file class.ilSCTask.php.

                              : bool
    {
        return true;
    }

◆ read()

ilSCTask::read ( )

Definition at line 101 of file class.ilSCTask.php.

                          : bool
    {
        if (!$this->getId()) {
            return false;
        }
 
        $query = 'SELECT * FROM sysc_tasks ' .
            'WHERE id = ' . $this->db->quote($this->getId(), ilDBConstants::T_INTEGER);
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setGroupId((int) $row->grp_id);
            $this->setLastUpdate(new ilDateTime($row->last_update, IL_CAL_DATETIME, ilTimeZone::UTC));
            $this->setStatus((int) $row->status);
            $this->setIdentifier((string) $row->identifier);
        }
        return true;
    }

References $res, ilDBConstants\FETCHMODE_OBJECT, getId(), IL_CAL_DATETIME, setGroupId(), setIdentifier(), setLastUpdate(), setStatus(), ilDBConstants\T_INTEGER, and ilTimeZone\UTC.

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setGroupId()

ilSCTask::setGroupId ( int $a_id )

Definition at line 53 of file class.ilSCTask.php.

                                         : void
    {
        $this->grp_id = $a_id;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setIdentifier()

ilSCTask::setIdentifier ( string $a_ide )

Definition at line 63 of file class.ilSCTask.php.

                                                : void
    {
        $this->identifier = $a_ide;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setLastUpdate()

ilSCTask::setLastUpdate ( ilDateTime $a_update )

Definition at line 73 of file class.ilSCTask.php.

                                                       : void
    {
        $this->last_update = $a_update;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setStatus()

ilSCTask::setStatus ( int $a_status )

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

                                            : void
    {
        $this->status = $a_status;
    }

Referenced by read().

Here is the caller graph for this function:

◆ update()

ilSCTask::update ( )

Definition at line 134 of file class.ilSCTask.php.

                            : void
    {
        $query = 'UPDATE sysc_tasks SET ' .
            'last_update = ' . $this->db->quote($this->getLastUpdate()->get(IL_CAL_DATETIME, '', ilTimeZone::UTC), ilDBConstants::T_TIMESTAMP) . ', ' .
            'status = ' . $this->db->quote($this->getStatus(), ilDBConstants::T_INTEGER) . ', ' .
            'identifier = ' . $this->db->quote($this->getIdentifier(), ilDBConstants::T_TEXT) . ' ' .
            'WHERE id = ' . $this->db->quote($this->getId(), ilDBConstants::T_INTEGER);
        $this->db->manipulate($query);
    }

References getId(), getIdentifier(), getLastUpdate(), getStatus(), IL_CAL_DATETIME, ilDBConstants\T_INTEGER, ilDBConstants\T_TEXT, ilDBConstants\T_TIMESTAMP, and ilTimeZone\UTC.

Here is the call graph for this function:

Field Documentation

◆ $db

ilDBInterface ilSCTask::$db

protected

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

◆ $grp_id

int ilSCTask::$grp_id = 0

private

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

Referenced by getGroupId().

◆ $id

int ilSCTask::$id = 0

private

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

Referenced by getId().

◆ $identifier

string ilSCTask::$identifier = ''

private

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

Referenced by getIdentifier().

◆ $last_update

ilDateTime ilSCTask::$last_update = null

private

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

Referenced by getLastUpdate().

◆ $status

int ilSCTask::$status = 0

private

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

Referenced by getStatus().

◆ STATUS_COMPLETED

const ilSCTask::STATUS_COMPLETED = 2

Definition at line 28 of file class.ilSCTask.php.

Referenced by ilSCGroupTableGUI\fillRow(), ilSCTaskTableGUI\fillRow(), ilSCTreeTasks\findMissing(), ilSCTreeTasks\findMissingTreeEntries(), ilSCTreeTasksGUI\listTree(), ilSCTasks\lookupCompleted(), ilSCTreeTasksGUI\repairMissing(), ilSCTreeTasksGUI\repairMissingTreeEntries(), ilSCTreeTasksGUI\repairStructure(), ilSCUtils\taskStatus2Text(), ilSCTreeTasks\validateDuplicates(), and ilSCTreeTasks\validateStructure().

◆ STATUS_FAILED

const ilSCTask::STATUS_FAILED = 3

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

Referenced by ilSCTreeTasksGUI\analyzeStructure(), ilSCGroupTableGUI\fillRow(), ilSCTaskTableGUI\fillRow(), ilSCTreeTasks\findMissing(), ilSCTreeTasksGUI\findMissing(), ilSCTreeTasks\findMissingTreeEntries(), ilSCTreeTasksGUI\findMissingTreeEntries(), ilSCTreeTasksGUI\getActions(), ilSCTreeTasksGUI\listTree(), ilSCTasks\lookupFailed(), ilSCTasks\lookupLastUpdate(), ilSCUtils\taskStatus2Text(), ilSCTreeTasks\validateDuplicates(), ilSCTreeTasksGUI\validateDuplicates(), and ilSCTreeTasks\validateStructure().

◆ STATUS_IN_PROGRESS

const ilSCTask::STATUS_IN_PROGRESS = 1

Definition at line 27 of file class.ilSCTask.php.

Referenced by ilSCUtils\taskStatus2Text().

◆ STATUS_NOT_ATTEMPTED

const ilSCTask::STATUS_NOT_ATTEMPTED = 0

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

Referenced by ilSCUtils\taskStatus2Text().

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

components/ILIAS/SystemCheck/classes/class.ilSCTask.php

Public Member Functions

Data Fields

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ create()

◆ getGroupId()

◆ getId()

◆ getIdentifier()

◆ getLastUpdate()

◆ getStatus()

◆ isActive()

◆ read()

◆ setGroupId()

◆ setIdentifier()

◆ setLastUpdate()

◆ setStatus()

◆ update()

Field Documentation

◆ $db

◆ $grp_id

◆ $id

◆ $identifier

◆ $last_update

◆ $status

◆ STATUS_COMPLETED

◆ STATUS_FAILED

◆ STATUS_IN_PROGRESS

◆ STATUS_NOT_ATTEMPTED