ilTimingUser Class Reference

TableGUI class for timings administration. More...

Collaboration diagram for ilTimingUser:

Public Member Functions
	__construct ($a_ref_id, $a_usr_id)
	Constructor. More...
	getUserId ()
	get user id More...
	getRefId ()
	Get ref_id. More...
	isScheduled ()
	Check if an entry exists for user. More...
	getStart ()
	Use to set start date. More...
	getEnd ()
	Use to set date. More...
	create ()
	Create new entry. More...
	update ()
	Update type $ilDB. More...
	delete ()
	Delete entry type $ilDB. More...
	read ()
	Read from db. More...

Private Attributes
	$ref_id = 0
	$usr_id = 0
	$start = null
	$end = null
	$is_scheduled = false

Detailed Description

TableGUI class for timings administration.

Author

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

Version

$Id$

Definition at line 12 of file class.ilTimingUser.php.

Constructor & Destructor Documentation

__construct()

ilTimingUser::__construct	(		$a_ref_id,
			$a_usr_id
	)

Constructor.

Parameters

type	$a_ref_id
type	$a_usr_id

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

References IL_CAL_UNIX, and read().

    {
        $this->ref_id = $a_ref_id;
        $this->usr_id = $a_usr_id;
        
        $this->start = new ilDateTime(0, IL_CAL_UNIX);
        $this->end = new ilDateTime(0, IL_CAL_UNIX);
        
        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

create()

ilTimingUser::create

(

)

Create new entry.

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

References $DIC, $ilDB, $query, getEnd(), getRefId(), getStart(), getUserId(), IL_CAL_UNIX, isScheduled(), and update().

Referenced by update().

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        if ($this->isScheduled()) {
            return $this->update();
        }
        
        $query = 'INSERT INTO crs_timings_user (ref_id, usr_id, sstart, ssend ) VALUES ( ' .
                $ilDB->quote($this->getRefId(), 'integer') . ', ' .
                $ilDB->quote($this->getUserId(), 'integer') . ', ' .
                $ilDB->quote($this->getStart()->get(IL_CAL_UNIX, 'integer')) . ', ' .
                $ilDB->quote($this->getEnd()->get(IL_CAL_UNIX, 'integer')) . ' ' .
                ')';
        $ilDB->manipulate($query);
        
        $this->is_scheduled = true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilTimingUser::delete

(

)

Delete entry type $ilDB.

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

References $DIC, $ilDB, $query, getRefId(), and getUserId().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = 'DELETE FROM crs_timings_user ' . ' ' .
                'WHERE ref_id = ' . $ilDB->quote($this->getRefId(), 'integer') . ' ' .
                'AND usr_id = ' . $ilDB->quote($this->getUserId(), 'integer');
        $ilDB->manipulate($query);
        
        $this->is_scheduled = false;
    }

Here is the call graph for this function:

getEnd()

ilTimingUser::getEnd

(

)

Use to set date.

Returns

ilDateTime

Definition at line 76 of file class.ilTimingUser.php.

References $end.

Referenced by create(), and update().

    {
        return $this->end;
    }

Here is the caller graph for this function:

getRefId()

ilTimingUser::getRefId

(

)

Get ref_id.

Returns

type

Definition at line 50 of file class.ilTimingUser.php.

References $ref_id.

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

    {
        return $this->ref_id;
    }

Here is the caller graph for this function:

getStart()

ilTimingUser::getStart

(

)

Use to set start date.

Returns

ilDateTime

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

References $start.

Referenced by ilObjectActivation\addAdditionalSubItemInformation(), create(), and update().

    {
        return $this->start;
    }

Here is the caller graph for this function:

getUserId()

ilTimingUser::getUserId

(

)

get user id

Returns

type

Definition at line 41 of file class.ilTimingUser.php.

References $usr_id.

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

    {
        return $this->usr_id;
    }

Here is the caller graph for this function:

isScheduled()

ilTimingUser::isScheduled

(

)

Check if an entry exists for user.

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

References $is_scheduled.

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

    {
        return $this->is_scheduled;
    }

Here is the caller graph for this function:

read()

ilTimingUser::read

(

)

Read from db.

Definition at line 150 of file class.ilTimingUser.php.

References $DIC, $ilDB, $query, $res, ilDBConstants\FETCHMODE_OBJECT, getRefId(), getUserId(), IL_CAL_UNIX, and isScheduled().

Referenced by __construct().

    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = 'SELECT * FROM crs_timings_user ' .
                'WHERE ref_id = ' . $ilDB->quote($this->getRefId(), 'integer') . ' ' .
                'AND usr_id = ' . $ilDB->quote($this->getUserId(), 'integer');
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->is_scheduled = true;
            $this->start = new ilDateTime($row->sstart, IL_CAL_UNIX);
            $this->end = new ilDateTime($row->ssend, IL_CAL_UNIX);
        }
        return $this->isScheduled();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilTimingUser::update

(

)

Update type $ilDB.

Definition at line 109 of file class.ilTimingUser.php.

References $DIC, $ilDB, $query, create(), getEnd(), getRefId(), getStart(), getUserId(), IL_CAL_UNIX, and isScheduled().

Referenced by create().

    {
        global $DIC;

        $ilDB = $DIC->database();

        if (!$this->isScheduled()) {
            return $this->create();
        }
        
        $query = 'UPDATE crs_timings_user ' .
                'SET sstart = ' . $ilDB->quote($this->getStart()->get(IL_CAL_UNIX, 'integer')) . ', ' .
                'ssend = ' . $ilDB->quote($this->getEnd()->get(IL_CAL_UNIX, 'integer')) . ' ' .
                'WHERE ref_id = ' . $ilDB->quote($this->getRefId(), 'integer') . ' ' .
                'AND usr_id = ' . $ilDB->quote($this->getUserId(), 'integer');
        $ilDB->manipulate($query);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$end

ilTimingUser::$end = null

private

Definition at line 17 of file class.ilTimingUser.php.

Referenced by getEnd().

$is_scheduled

ilTimingUser::$is_scheduled = false

private

Definition at line 19 of file class.ilTimingUser.php.

Referenced by isScheduled().

$ref_id

ilTimingUser::$ref_id = 0

private

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

Referenced by getRefId().

$start

ilTimingUser::$start = null

private

Definition at line 16 of file class.ilTimingUser.php.

Referenced by getStart().

$usr_id

ilTimingUser::$usr_id = 0

private

Definition at line 15 of file class.ilTimingUser.php.

Referenced by getUserId().

---

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

• Modules/Course/classes/Timings/class.ilTimingUser.php