ilCalendarVisibility 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 ilCalendarVisibility:

Public Member Functions
	filterHidden (array $categories, array $category_info)
	Filter hidden categories (and hidden subitem categories) from category array. More...
	isAppointmentVisible (int $a_cal_id)
	getHidden ()
	getVisible ()
	hideSelected (array $a_hidden)
	showSelected (array $a_visible)
	save ()
	delete (int $a_cat_id=null)
	forceVisibility (int $a_cat_id)

Static Public Member Functions
static	_getInstanceByUserId (int $a_user_id, int $a_ref_id=0)
static	_deleteCategories (int $a_cat_id)
static	_deleteUser (int $a_user_id)

Data Fields
const	HIDDEN = 0
const	VISIBLE = 1

Protected Member Functions
	isHidden (int $a_cat_id, array $info)
	read ()

Protected Attributes
int	$user_id = 0
int	$ref_id = 0
int	$obj_id = 0
array	$hidden = array()
array	$visible = array()
int	$forced_visible = 0
ilDBInterface	$db

Static Protected Attributes
static array	$instances = array()

Private Member Functions
	__construct (int $a_user_id, int $a_ref_id=0)

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 Stores selection of hidden calendars for a specific user

Author

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

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

Constructor & Destructor Documentation

__construct()

ilCalendarVisibility::__construct ( int  $a_user_id, int  $a_ref_id = 0  )

private

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

    {
        global $DIC;
        $this->db = $DIC->database();
        $this->user_id = $a_user_id;
        $this->ref_id = $a_ref_id;
        $this->obj_id = ilObject::_lookupObjId($a_ref_id);
        $this->read();
    }

References $DIC, ilObject\_lookupObjId(), and read().

Here is the call graph for this function:

Member Function Documentation

_deleteCategories()

static ilCalendarVisibility::_deleteCategories ( int  $a_cat_id )

static

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

                                                           : void
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $query = "DELETE FROM cal_cat_visibility " .
            "WHERE cat_id = " . $ilDB->quote($a_cat_id, 'integer') . " ";
        $ilDB->manipulate($query);
    }

References $DIC, $ilDB, and $query.

Referenced by ilCalendarCategory\delete().

Here is the caller graph for this function:

_deleteUser()

static ilCalendarVisibility::_deleteUser ( int  $a_user_id )

static

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

                                                      : void
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $query = "DELETE FROM cal_cat_visibility " .
            "WHERE user_id = " . $ilDB->quote($a_user_id, 'integer') . " ";
        $ilDB->manipulate($query);
    }

References $DIC, $ilDB, and $query.

_getInstanceByUserId()

static ilCalendarVisibility::_getInstanceByUserId ( int  $a_user_id, int  $a_ref_id = 0  )

static

Definition at line 51 of file class.ilCalendarVisibility.php.

                                                                                  : ilCalendarVisibility
    {
        if (!isset(self::$instances[$a_user_id][$a_ref_id])) {
            self::$instances[$a_user_id][$a_ref_id] = new ilCalendarVisibility($a_user_id, $a_ref_id);
        }
        return self::$instances[$a_user_id][$a_ref_id];
    }

Referenced by ilCalendarPresentationGUI\__construct(), ilCalendarScheduleFilterHidden\__construct(), ilCalendarSelectionBlockGUI\getCalendars(), ilCalendarPresentationGUI\initAndRedirectToConsultationHours(), and ilCalendarCategoryGUI\saveSelection().

Here is the caller graph for this function:

delete()

ilCalendarVisibility::delete

(

int

$a_cat_id = null

)

Definition at line 178 of file class.ilCalendarVisibility.php.

                                                : void
    {
        if ($a_cat_id) {
            $query = "DELETE FROM cal_cat_visibility " .
                "WHERE user_id = " . $this->db->quote($this->user_id, 'integer') . " " .
                "AND obj_id = " . $this->db->quote($this->obj_id, 'integer') . " " .
                "AND cat_id = " . $this->db->quote($a_cat_id, 'integer') . " ";
        } else {
            $query = "DELETE FROM cal_cat_visibility " .
                "WHERE user_id = " . $this->db->quote($this->user_id, 'integer') . " " .
                "AND obj_id = " . $this->db->quote($this->obj_id, 'integer');
        }
        $this->db->manipulate($query);
    }

References $query.

filterHidden()

ilCalendarVisibility::filterHidden	(	array	$categories,
		array	$category_info
	)

Filter hidden categories (and hidden subitem categories) from category array.

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

                                                                         : array
    {
        $hidden = array();
        foreach ($category_info as $cat_id => $info) {
            $subitem_ids = [];
            if (array_key_exists('subitem_ids', $info) && is_array($info['subitem_ids'])) {
                $subitem_ids = $info['subitem_ids'];
            }
 
            if ($this->isHidden($cat_id, $info)) {
                $hidden = array_merge((array) $hidden, $subitem_ids, array($cat_id));
            }
        }
        return array_diff($categories, $hidden);
    }

References $hidden, and isHidden().

Here is the call graph for this function:

forceVisibility()

ilCalendarVisibility::forceVisibility

(

int

$a_cat_id

)

Definition at line 209 of file class.ilCalendarVisibility.php.

                                                  : void
    {
        $this->forced_visible = $a_cat_id;
        if (($key = array_search($a_cat_id, $this->hidden)) !== false) {
            unset($this->hidden[$key]);
        }
        if (!in_array($a_cat_id, $this->visible)) {
            $this->visible[] = $a_cat_id;
        }
    }

References ILIAS\LTI\ToolProvider\$key.

getHidden()

ilCalendarVisibility::getHidden

(

)

Definition at line 127 of file class.ilCalendarVisibility.php.

                               : array
    {
        return $this->hidden;
    }

References $hidden.

getVisible()

ilCalendarVisibility::getVisible

(

)

Definition at line 132 of file class.ilCalendarVisibility.php.

                                : array
    {
        return $this->visible;
    }

References $visible.

hideSelected()

ilCalendarVisibility::hideSelected

(

array

$a_hidden

)

Definition at line 137 of file class.ilCalendarVisibility.php.

                                                 : void
    {
        $this->hidden = $a_hidden;
    }

isAppointmentVisible()

ilCalendarVisibility::isAppointmentVisible

(

int

$a_cal_id

)

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

                                                       : bool
    {
        foreach (ilCalendarCategoryAssignments::_lookupCategories($a_cal_id) as $cat_id) {
            if (in_array($cat_id, $this->hidden)) {
                return true;
            }
        }
        return false;
    }

References ilCalendarCategoryAssignments\_lookupCategories().

Here is the call graph for this function:

isHidden()

ilCalendarVisibility::isHidden ( int  $a_cat_id, array  $info  )

protected

Definition at line 99 of file class.ilCalendarVisibility.php.

                                                           : bool
    {
        // personal desktop
        if ($this->obj_id == 0) {
            return in_array($a_cat_id, $this->hidden);
        }
 
        // crs/grp, always show current object and objects that have been selected due to
        // current container ref id
        if (
            $info["type"] == ilCalendarCategory::TYPE_OBJ &&
            ($info["obj_id"] == $this->obj_id || $info["source_ref_id"] == $this->ref_id)
        ) {
            return false;
        }
        return !in_array($a_cat_id, $this->visible);
    }

References ilCalendarCategory\TYPE_OBJ.

Referenced by filterHidden().

Here is the caller graph for this function:

read()

ilCalendarVisibility::read ( )

protected

Definition at line 193 of file class.ilCalendarVisibility.php.

                             : void
    {
        $query = "SELECT * FROM cal_cat_visibility " .
            "WHERE user_id = " . $this->db->quote($this->user_id, 'integer') . " " .
            " AND obj_id = " . $this->db->quote($this->obj_id, 'integer');
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            if ($row->visible == self::HIDDEN) {
                $this->hidden[] = $row->cat_id;
            }
            if ($row->visible == self::VISIBLE) {
                $this->visible[] = $row->cat_id;
            }
        }
    }

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

Referenced by __construct().

Here is the caller graph for this function:

save()

ilCalendarVisibility::save

(

)

Definition at line 147 of file class.ilCalendarVisibility.php.

                          : void
    {
        $this->delete();
        foreach ($this->hidden as $hidden) {
            if ($hidden === $this->forced_visible) {
                continue;
            }
            $query = "INSERT INTO cal_cat_visibility (user_id, cat_id, obj_id, visible) " .
                "VALUES ( " .
                $this->db->quote($this->user_id, 'integer') . ", " .
                $this->db->quote($hidden, 'integer') . ", " .
                $this->db->quote($this->obj_id, 'integer') . ", " .
                $this->db->quote(self::HIDDEN, 'integer') .
                ")";
            $this->db->manipulate($query);
        }
        foreach ($this->visible as $visible) {
            if ($visible === $this->forced_visible) {
                continue;
            }
            $query = "INSERT INTO cal_cat_visibility (user_id, cat_id, obj_id, visible) " .
                "VALUES ( " .
                $this->db->quote($this->user_id, 'integer') . ", " .
                $this->db->quote($visible, 'integer') . ", " .
                $this->db->quote($this->obj_id, 'integer') . ", " .
                $this->db->quote(self::VISIBLE, 'integer') .
                ")";
            $this->db->manipulate($query);
        }
    }

References $hidden, $query, and $visible.

showSelected()

ilCalendarVisibility::showSelected

(

array

$a_visible

)

Definition at line 142 of file class.ilCalendarVisibility.php.

                                                  : void
    {
        $this->visible = $a_visible;
    }

Field Documentation

$db

ilDBInterface ilCalendarVisibility::$db

protected

Definition at line 39 of file class.ilCalendarVisibility.php.

$forced_visible

int ilCalendarVisibility::$forced_visible = 0

protected

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

$hidden

array ilCalendarVisibility::$hidden = array()

protected

Definition at line 35 of file class.ilCalendarVisibility.php.

Referenced by filterHidden(), getHidden(), and save().

$instances

array ilCalendarVisibility::$instances = array()

staticprotected

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

$obj_id

int ilCalendarVisibility::$obj_id = 0

protected

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

$ref_id

int ilCalendarVisibility::$ref_id = 0

protected

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

$user_id

int ilCalendarVisibility::$user_id = 0

protected

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

$visible

array ilCalendarVisibility::$visible = array()

protected

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

Referenced by getVisible(), and save().

HIDDEN

const ilCalendarVisibility::HIDDEN = 0

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

VISIBLE

const ilCalendarVisibility::VISIBLE = 1

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

---

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

• Services/Calendar/classes/class.ilCalendarVisibility.php