ilSCTask Class Reference

Defines a system check task. More...

Inheritance diagram for ilSCTask:

Collaboration diagram for ilSCTask:

Public Member Functions
	__construct ($a_id=0)
	Constructor. More...
	getId ()
	setGroupId ($a_id)
	getGroupId ()
	setIdentifier ($a_ide)
	getIdentifier ()
	setLastUpdate (ilDateTime $a_update)
	getLastUpdate ()
	Get last update date. More...
	setStatus ($a_status)
	getStatus ()
	Get status. More...
	isActive ()
	read ()
	Read group. More...
	create ()
	Create new group. More...
	update ()
	Update task. More...

Data Fields
const	STATUS_NOT_ATTEMPTED = 0
const	STATUS_IN_PROGRESS = 1
const	STATUS_COMPLETED = 2
const	STATUS_FAILED = 3

Private Attributes
	$id = 0
	$grp_id = 0
	$last_update = null
	$status = 0
	$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 12 of file class.ilSCTask.php.

Constructor & Destructor Documentation

__construct()

ilSCTask::__construct

(

$a_id = 0

)

Constructor.

Parameters

type

$a_id

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

References read().

    {
        $this->id = $a_id;
        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

create()

ilSCTask::create

(

)

Create new group.

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

References $DIC, $ilDB, $query, getGroupId(), getId(), getIdentifier(), and getStatus().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $this->id = $ilDB->nextId('sysc_tasks');
        
        $query = 'INSERT INTO sysc_tasks (id,grp_id,status,identifier) ' .
                'VALUES ( ' .
                $ilDB->quote($this->getId(), 'integer') . ', ' .
                $ilDB->quote($this->getGroupId(), 'integer') . ', ' .
                $ilDB->quote($this->getStatus(), 'integer') . ', ' .
                $ilDB->quote($this->getIdentifier(), 'text') . ' ' .
                ')';
        $ilDB->manipulate($query);
        return $this->getId();
    }

Here is the call graph for this function:

getGroupId()

ilSCTask::getGroupId

(

)

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

References $grp_id.

Referenced by create().

    {
        return $this->grp_id;
    }

Here is the caller graph for this function:

getId()

ilSCTask::getId

(

)

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

References $id.

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

    {
        return $this->id;
    }

Here is the caller graph for this function:

getIdentifier()

ilSCTask::getIdentifier

(

)

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

References $identifier.

Referenced by create(), and update().

    {
        return $this->identifier;
    }

Here is the caller graph for this function:

getLastUpdate()

ilSCTask::getLastUpdate

(

)

Get last update date.

Returns

ilDateTime

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

References $last_update.

Referenced by update().

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

Here is the caller graph for this function:

getStatus()

ilSCTask::getStatus

(

)

Get status.

Returns

int

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

References $status.

Referenced by create(), and update().

    {
        return $this->status;
    }

Here is the caller graph for this function:

isActive()

ilSCTask::isActive

(

)

Returns

bool check if task is active

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

    {
        return true;
    }

read()

ilSCTask::read

(

)

Read group.

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

References $DIC, $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, getId(), IL_CAL_DATETIME, setGroupId(), setIdentifier(), setLastUpdate(), setStatus(), and ilTimeZone\UTC.

Referenced by __construct().

    {
        global $DIC;

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

Here is the call graph for this function:

Here is the caller graph for this function:

setGroupId()

ilSCTask::setGroupId

(

$a_id

)

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

Referenced by read().

    {
        $this->grp_id = $a_id;
    }

Here is the caller graph for this function:

setIdentifier()

ilSCTask::setIdentifier

(

$a_ide

)

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

Referenced by read().

    {
        $this->identifier = $a_ide;
    }

Here is the caller graph for this function:

setLastUpdate()

ilSCTask::setLastUpdate

(

ilDateTime

$a_update

)

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

Referenced by read().

    {
        $this->last_update = $a_update;
    }

Here is the caller graph for this function:

setStatus()

ilSCTask::setStatus

(

$a_status

)

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

Referenced by read().

    {
        $this->status = $a_status;
    }

Here is the caller graph for this function:

update()

ilSCTask::update

(

)

Update task.

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

References $DIC, $ilDB, $query, getId(), getIdentifier(), getLastUpdate(), getStatus(), IL_CAL_DATETIME, and ilTimeZone\UTC.

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = 'UPDATE sysc_tasks SET ' .
                'last_update = ' . $ilDB->quote($this->getLastUpdate()->get(IL_CAL_DATETIME, '', ilTimeZone::UTC), 'timestamp') . ', ' .
                'status = ' . $ilDB->quote($this->getStatus(), 'integer') . ', ' .
                'identifier = ' . $ilDB->quote($this->getIdentifier(), 'text') . ' ' .
                'WHERE id = ' . $ilDB->quote($this->getId(), 'integer');
        $ilDB->manipulate($query);
    }

Here is the call graph for this function:

Field Documentation

$grp_id

ilSCTask::$grp_id = 0

private

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

Referenced by getGroupId().

$id

ilSCTask::$id = 0

private

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

Referenced by getId().

$identifier

ilSCTask::$identifier = ''

private

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

Referenced by getIdentifier().

$last_update

ilSCTask::$last_update = null

private

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

Referenced by getLastUpdate().

$status

ilSCTask::$status = 0

private

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

Referenced by getStatus().

STATUS_COMPLETED

const ilSCTask::STATUS_COMPLETED = 2

Definition at line 16 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 17 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 15 of file class.ilSCTask.php.

Referenced by ilSCUtils\taskStatus2Text().

STATUS_NOT_ATTEMPTED

const ilSCTask::STATUS_NOT_ATTEMPTED = 0

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

Referenced by ilSCUtils\taskStatus2Text().

---

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

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