ilSCTasks Class Reference

Description of class. More...

Collaboration diagram for ilSCTasks:

Public Member Functions
	updateFromComponentDefinition ($a_identifier)
	Update from module/service reader. More...
	getGroupId ()
	getTasks ()
	Get groups. More...

Static Public Member Functions
static	getInstanceByGroupId ($a_group_id)
	Get singleton instance. More...
static	lookupIdentifierForTask ($a_task_id)
static	lookupGroupId ($a_task_id)
	Lookup group id by task id type $ilDB. More...
static	lookupCompleted ($a_grp_id)
static	lookupFailed ($a_grp_id)
static	lookupLastUpdate ($a_grp_id)
	Lookup last update of group tasks type $ilDB. More...

Protected Member Functions
	read ()
	read groups More...

Private Member Functions
	__construct ($a_grp_id)
	Singleton constructor. More...

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

Static Private Attributes
static	$instances = array()

Detailed Description

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 12 of file class.ilSCTasks.php.

Constructor & Destructor Documentation

__construct()

ilSCTasks::__construct (   $a_grp_id )

private

Singleton constructor.

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

References read().

    {
        $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 168 of file class.ilSCTasks.php.

References $grp_id.

Referenced by updateFromComponentDefinition().

    {
        return $this->grp_id;
    }

Here is the caller graph for this function:

getInstanceByGroupId()

static ilSCTasks::getInstanceByGroupId (   $a_group_id )

static

Get singleton instance.

Returns

ilSCTasks

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

Referenced by ilObjDefReader\handlerBeginTag(), and ilSCTaskTableGUI\parse().

    {
        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

(

)

Get groups.

Returns

ilSCTask[]

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

References $tasks.

Referenced by updateFromComponentDefinition().

    {
        return (array) $this->tasks;
    }

Here is the caller graph for this function:

lookupCompleted()

static ilSCTasks::lookupCompleted (   $a_grp_id )

static

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

References $tasks, and ilSCTask\STATUS_COMPLETED.

Referenced by ilSCGroupTableGUI\parse().

    {
        $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 (   $a_grp_id )

static

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

References $tasks, and ilSCTask\STATUS_FAILED.

Referenced by ilSCGroupTableGUI\parse().

    {
        $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 (   $a_task_id )

static

Lookup group id by task id type $ilDB.

Parameters

type

$a_task_id

Returns

int

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

References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilSCComponentTaskFactory\getComponentTask().

    {
        global $DIC;

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

Here is the caller graph for this function:

lookupIdentifierForTask()

static ilSCTasks::lookupIdentifierForTask (   $a_task_id )

static

Parameters

int

$a_task_id

Returns

string

Exceptions

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

References $DIC, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilSCComponentTaskFactory\getTask().

    {
        global $DIC;

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

Here is the caller graph for this function:

lookupLastUpdate()

static ilSCTasks::lookupLastUpdate (   $a_grp_id )

static

Lookup last update of group tasks type $ilDB.

Parameters

type

$a_grp_id

Returns

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

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

Referenced by ilSCGroupTableGUI\parse().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = 'SELECT MAX(last_update) last_update FROM sysc_tasks ' .
                'WHERE status = ' . $ilDB->quote(ilSCTask::STATUS_FAILED, 'integer') . ' ' .
                'AND grp_id = ' . $ilDB->quote($a_grp_id, '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

read groups

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

References $DIC, $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, and ilSCComponentTaskFactory\getTask().

Referenced by __construct().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = 'SELECT id, grp_id FROM sysc_tasks ' .
                'ORDER BY id ';
        $res = $ilDB->query($query);
        
        $this->tasks = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->tasks[] = ilSCComponentTaskFactory::getTask($row->grp_id, $row->id);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateFromComponentDefinition()

ilSCTasks::updateFromComponentDefinition

(

$a_identifier

)

Update from module/service reader.

Parameters

type

$a_identifier

Returns

boolean

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

References getGroupId(), and getTasks().

    {
        foreach ($this->getTasks() as $task) {
            if ($task->getIdentifier() == $a_identifier) {
                return true;
            }
        }
        
        $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

$grp_id

ilSCTasks::$grp_id = 0

private

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

Referenced by getGroupId().

$instances

ilSCTasks::$instances = array()

staticprivate

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

$tasks

ilSCTasks::$tasks = array()

private

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

Referenced by getTasks(), lookupCompleted(), and lookupFailed().

---

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

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