ilTimingPlaned Class Reference

class ilTimingPlaned More...

Collaboration diagram for ilTimingPlaned:

Public Member Functions
	__construct ($item_id, $a_usr_id)
	Constructor. More...
	getUserId ()
	getItemId ()
	getPlanedStartingTime ()
	setPlanedStartingTime ($a_time)
	getPlanedEndingTime ()
	setPlanedEndingTime ($a_end)
	validate ()
	update ()
	create ()
	delete ()
	__read ()

Static Public Member Functions
static	_delete ($a_item_id, $a_usr_id)
static	_getPlanedTimings ($a_usr_id, $a_item_id)
static	_getPlanedTimingsByItem ($a_item_id)
static	_deleteByItem ($a_item_id)
static	_deleteByUser ($a_usr_id)

Data Fields
	$ilErr
	$ilDB
	$lng

Detailed Description

class ilTimingPlaned

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilTimingPlaned::__construct	(		$item_id,
			$a_usr_id
	)

Constructor.

Parameters

int	$item_id
int	$a_usr_id

Definition at line 45 of file class.ilTimingPlaned.php.

References $ilDB, $ilErr, $lng, and __read().

    {
        global $ilErr,$ilDB,$lng,$tree;

        $this->ilErr =&$ilErr;
        $this->db  =&$ilDB;
        $this->lng =&$lng;

        $this->item_id = $item_id;
        $this->user_id = $a_usr_id;

        $this->__read();
    }

Here is the call graph for this function:

Member Function Documentation

__read()

ilTimingPlaned::__read

(

)

Definition at line 181 of file class.ilTimingPlaned.php.

References $ilDB, $query, $res, $row, ilDBConstants\FETCHMODE_OBJECT, getItemId(), getUserId(), setPlanedEndingTime(), and setPlanedStartingTime().

Referenced by __construct().

    {
        global $ilDB;
        
        $query = "SELECT * FROM crs_timings_planed " .
            "WHERE item_id = " . $ilDB->quote($this->getItemId(), 'integer') . " " .
            "AND usr_id = " . $ilDB->quote($this->getUserId(), 'integer') . " ";
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->setPlanedStartingTime($row->planed_start);
            $this->setPlanedEndingTime($row->planed_end);
        }
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_delete()

static ilTimingPlaned::_delete (   $a_item_id,   $a_usr_id  )

static

Definition at line 122 of file class.ilTimingPlaned.php.

References $ilDB, $query, and $res.

Referenced by delete(), and update().

    {
        global $ilDB;

        $query = "DELETE FROM crs_timings_planed " .
            "WHERE item_id = " . $ilDB->quote($a_item_id, 'integer') . " " .
            "AND usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
    }

Here is the caller graph for this function:

_deleteByItem()

static ilTimingPlaned::_deleteByItem (   $a_item_id )

static

Definition at line 163 of file class.ilTimingPlaned.php.

References $ilDB, $query, and $res.

    {
        global $ilDB;

        $query = "DELETE FROM crs_timings_planed " .
            "WHERE item_id = " . $ilDB->quote($a_item_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
    }

_deleteByUser()

static ilTimingPlaned::_deleteByUser (   $a_usr_id )

static

Definition at line 172 of file class.ilTimingPlaned.php.

References $ilDB, $query, and $res.

    {
        global $ilDB;

        $query = "DELETE FROM crs_timings_planed " .
            "WHERE usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " ";
        $res = $ilDB->manipulate($query);
    }

_getPlanedTimings()

static ilTimingPlaned::_getPlanedTimings (   $a_usr_id,   $a_item_id  )

static

Definition at line 133 of file class.ilTimingPlaned.php.

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

Referenced by ilObjectActivation\addAdditionalSubItemInformation().

    {
        global $ilDB;

        $query = "SELECT * FROM crs_timings_planed " .
            "WHERE item_id = " . $ilDB->quote($a_item_id, 'integer') . " " .
            "AND usr_id = " . $ilDB->quote($a_usr_id, 'integer') . " ";
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $data['planed_start'] = $row->planed_start;
            $data['planed_end'] = $row->planed_end;
        }
        return $data ? $data : array();
    }

Here is the caller graph for this function:

_getPlanedTimingsByItem()

static ilTimingPlaned::_getPlanedTimingsByItem (   $a_item_id )

static

Definition at line 149 of file class.ilTimingPlaned.php.

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

Referenced by ilTimingCache\_getTimings(), and ilTimingCache\readObjectInformation().

    {
        global $ilDB;

        $query = "SELECT * FROM crs_timings_planed " .
            "WHERE item_id = " . $ilDB->quote($a_item_id, 'integer') . " ";
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $data[$row->usr_id]['start'] = $row->planed_start;
            $data[$row->usr_id]['end']   = $row->planed_end;
        }
        return $data ? $data : array();
    }

Here is the caller graph for this function:

create()

ilTimingPlaned::create

(

)

Definition at line 103 of file class.ilTimingPlaned.php.

References $ilDB, $query, $res, getItemId(), getPlanedEndingTime(), getPlanedStartingTime(), and getUserId().

Referenced by update().

    {
        global $ilDB;
        
        $query = "INSERT INTO crs_timings_planed (item_id,usr_id,planed_start,planed_end) " .
            "VALUES( " .
            $ilDB->quote($this->getItemId(), 'integer') . ", " .
            $ilDB->quote($this->getUserId(), 'integer') . ", " .
            $ilDB->quote($this->getPlanedStartingTime(), 'integer') . ", " .
            $ilDB->quote($this->getPlanedEndingTime(), 'integer') . " " .
            ")";
        $res = $ilDB->manipulate($query);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilTimingPlaned::delete

(

)

Definition at line 117 of file class.ilTimingPlaned.php.

References _delete(), getItemId(), and getUserId().

    {
        return ilTimingPlaned::_delete($this->getItemId(), $this->getUserId());
    }

Here is the call graph for this function:

getItemId()

ilTimingPlaned::getItemId

(

)

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

Referenced by __read(), create(), delete(), update(), and validate().

    {
        return $this->item_id;
    }

Here is the caller graph for this function:

getPlanedEndingTime()

ilTimingPlaned::getPlanedEndingTime

(

)

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

References $end.

Referenced by create(), and validate().

    {
        return $this->end;
    }

Here is the caller graph for this function:

getPlanedStartingTime()

ilTimingPlaned::getPlanedStartingTime

(

)

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

Referenced by create().

    {
        return $this->start;
    }

Here is the caller graph for this function:

getUserId()

ilTimingPlaned::getUserId

(

)

Definition at line 59 of file class.ilTimingPlaned.php.

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

    {
        return $this->user_id;
    }

Here is the caller graph for this function:

setPlanedEndingTime()

ilTimingPlaned::setPlanedEndingTime

(

$a_end

)

Definition at line 80 of file class.ilTimingPlaned.php.

Referenced by __read().

    {
        $this->end = $a_end;
    }

Here is the caller graph for this function:

setPlanedStartingTime()

ilTimingPlaned::setPlanedStartingTime

(

$a_time

)

Definition at line 72 of file class.ilTimingPlaned.php.

Referenced by __read(), and ilCourseContentGUI\updateUserTimings().

    {
        $this->start = $a_time;
    }

Here is the caller graph for this function:

update()

ilTimingPlaned::update

(

)

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

References _delete(), create(), getItemId(), and getUserId().

    {
        ilTimingPlaned::_delete($this->getItemId(), $this->getUserId());
        $this->create();
        return true;
    }

Here is the call graph for this function:

validate()

ilTimingPlaned::validate

(

)

Definition at line 85 of file class.ilTimingPlaned.php.

References ilObjectActivation\getItem(), getItemId(), and getPlanedEndingTime().

    {
        include_once './Services/Object/classes/class.ilObjectActivation.php';
        $item = ilObjectActivation::getItem($this->getItemId());
        // #9326
        if ($this->getPlanedEndingTime() > $item['latest_end']) {
            return false;
        }
        return true;
    }

Here is the call graph for this function:

Field Documentation

$ilDB

ilTimingPlaned::$ilDB

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

Referenced by __construct(), __read(), _delete(), _deleteByItem(), _deleteByUser(), _getPlanedTimings(), _getPlanedTimingsByItem(), and create().

$ilErr

ilTimingPlaned::$ilErr

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

Referenced by __construct().

$lng

ilTimingPlaned::$lng

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

Referenced by __construct().

---

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

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