ilSCTasks Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilSCTasks:

Public Member Functions
	updateFromComponentDefinition (string $a_identifier)
	getGroupId ()
	getTasks ()

Static Public Member Functions
static	getInstanceByGroupId (int $a_group_id)
static	lookupIdentifierForTask (int $a_task_id)
static	lookupGroupId (int $a_task_id)
static	lookupCompleted (int $a_grp_id)
static	lookupFailed (int $a_grp_id)
static	lookupLastUpdate (int $a_grp_id)

Protected Member Functions
	read ()

Protected Attributes
ilDBInterface	$db

Private Member Functions
	__construct (int $a_grp_id)

Private Attributes
int	$grp_id = 0
array	$tasks = array()

Static Private Attributes
static array	$instances = array()

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Description of class

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.ilSCTasks.php.

Constructor & Destructor Documentation

__construct()

ilSCTasks::__construct ( int  $a_grp_id )

private

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

References $DIC, and read().

    {
        global $DIC;

        $this->db = $DIC->database();
        $this->grp_id = $a_grp_id;
        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

getGroupId()

ilSCTasks::getGroupId

(

)

Definition at line 148 of file class.ilSCTasks.php.

References $grp_id.

Referenced by updateFromComponentDefinition().

                                : int
    {
        return $this->grp_id;
    }

Here is the caller graph for this function:

getInstanceByGroupId()

static ilSCTasks::getInstanceByGroupId ( int  $a_group_id )

static

Definition at line 42 of file class.ilSCTasks.php.

Referenced by ilSystemCheckDefinitionProcessor\beginTag(), and ilSCTaskTableGUI\parse().

                                                                : ilSCTasks
    {
        if (!array_key_exists($a_group_id, self::$instances)) {
            return self::$instances[$a_group_id] = new self($a_group_id);
        }
        return self::$instances[$a_group_id];
    }

Here is the caller graph for this function:

getTasks()

ilSCTasks::getTasks

(

)

Returns

ilSCTask[]

Definition at line 156 of file class.ilSCTasks.php.

References $tasks.

Referenced by updateFromComponentDefinition().

                              : array
    {
        return $this->tasks;
    }

Here is the caller graph for this function:

lookupCompleted()

static ilSCTasks::lookupCompleted ( int  $a_grp_id )

static

Definition at line 98 of file class.ilSCTasks.php.

References ilSCTask\STATUS_COMPLETED.

Referenced by ilSCGroupTableGUI\parse().

                                                         : int
    {
        $tasks = self::getInstanceByGroupId($a_grp_id);

        $num_completed = 0;
        foreach ($tasks->getTasks() as $task) {
            if (!$task->isActive()) {
                continue;
            }
            if ($task->getStatus() === ilSCTask::STATUS_COMPLETED) {
                $num_completed++;
            }
        }
        return $num_completed;
    }

Here is the caller graph for this function:

lookupFailed()

static ilSCTasks::lookupFailed ( int  $a_grp_id )

static

Definition at line 114 of file class.ilSCTasks.php.

References ilSCTask\STATUS_FAILED.

Referenced by ilSCGroupTableGUI\parse().

                                                      : int
    {
        $tasks = self::getInstanceByGroupId($a_grp_id);

        $num_failed = 0;
        foreach ($tasks->getTasks() as $task) {
            if (!$task->isActive()) {
                continue;
            }

            if ($task->getStatus() === ilSCTask::STATUS_FAILED) {
                $num_failed++;
            }
        }
        return $num_failed;
    }

Here is the caller graph for this function:

lookupGroupId()

static ilSCTasks::lookupGroupId ( int  $a_task_id )

static

Definition at line 83 of file class.ilSCTasks.php.

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, and ilDBConstants\T_INTEGER.

Referenced by ilSCComponentTaskFactory\getComponentTask().

                                                        : int
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = 'SELECT grp_id FROM sysc_tasks ' .
            'WHERE id = ' . $ilDB->quote($a_task_id, ilDBConstants::T_INTEGER);
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (int) $row->grp_id;
        }
        return 0;
    }

Here is the caller graph for this function:

lookupIdentifierForTask()

static ilSCTasks::lookupIdentifierForTask ( int  $a_task_id )

static

Exceptions

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

References $DIC, $res, ilDBConstants\FETCHMODE_OBJECT, ilDBInterface\query(), ilDBInterface\quote(), and ilDBConstants\T_INTEGER.

Referenced by ilSCComponentTaskFactory\getTask().

                                                                  : string
    {
        global $DIC;

        $db = $DIC->database();
        $query = 'select identifier from sysc_tasks ' .
            'where id = ' . $db->quote($a_task_id, ilDBConstants::T_INTEGER);
        $res = $db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return (string) $row->identifier;
        }
        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

lookupLastUpdate()

static ilSCTasks::lookupLastUpdate ( int  $a_grp_id )

static

Definition at line 131 of file class.ilSCTasks.php.

References $DIC, $ilDB, $res, ilDBConstants\FETCHMODE_OBJECT, IL_CAL_DATETIME, IL_CAL_UNIX, ilSCTask\STATUS_FAILED, ilDBConstants\T_INTEGER, and ilTimeZone\UTC.

Referenced by ilSCGroupTableGUI\parse().

                                                          : ilDateTime
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = 'SELECT MAX(last_update) last_update FROM sysc_tasks ' .
            'WHERE status = ' . $ilDB->quote(ilSCTask::STATUS_FAILED, ilDBConstants::T_INTEGER) . ' ' .
            'AND grp_id = ' . $ilDB->quote($a_grp_id, ilDBConstants::T_INTEGER);
        $res = $ilDB->query($query);

        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return new ilDateTime($row->last_update, IL_CAL_DATETIME, ilTimeZone::UTC);
        }
        return new ilDateTime(time(), IL_CAL_UNIX);
    }

Here is the caller graph for this function:

read()

ilSCTasks::read ( )

protected

Definition at line 161 of file class.ilSCTasks.php.

References $res, ilDBConstants\FETCHMODE_OBJECT, and ilSCComponentTaskFactory\getTask().

Referenced by __construct().

                             : void
    {
        $query = 'SELECT id, grp_id FROM sysc_tasks ' .
            'ORDER BY id ';
        $res = $this->db->query($query);

        $this->tasks = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->tasks[] = ilSCComponentTaskFactory::getTask((int) $row->grp_id, (int) $row->id);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateFromComponentDefinition()

ilSCTasks::updateFromComponentDefinition

(

string

$a_identifier

)

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

References getGroupId(), and getTasks().

                                                                       : int
    {
        foreach ($this->getTasks() as $task) {
            if ($task->getIdentifier() === $a_identifier) {
                return 1;
            }
        }

        $task = new ilSCTask();
        $task->setGroupId($this->getGroupId());
        $task->setIdentifier($a_identifier);
        $task->create();

        return $task->getId();
    }

Here is the call graph for this function:

Field Documentation

$db

ilDBInterface ilSCTasks::$db

protected

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

$grp_id

int ilSCTasks::$grp_id = 0

private

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

Referenced by getGroupId().

$instances

array ilSCTasks::$instances = array()

staticprivate

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

$tasks

array ilSCTasks::$tasks = array()

private

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

Referenced by getTasks().

---

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

• Services/SystemCheck/classes/class.ilSCTasks.php