ilCalendarVisibility Class Reference

Stores selection of hidden calendars for a specific user. More...

Collaboration diagram for ilCalendarVisibility:

Public Member Functions
	filterHidden ($categories, $category_info)
	Filter hidden categories (and hidden subitem categories) from category array. More...
	isAppointmentVisible ($a_cal_id)
	check whether an appoinment is visible or not More...
	getHidden ()
	get hidden categories More...
	getVisible ()
	get visible categories More...
	hideSelected ($a_hidden)
	hide selected More...
	showSelected ($a_visible)
	Show selected. More...
	save ()
	save hidden selection More...
	delete ($a_cat_id=null)
	delete More...
	forceVisibility ($a_cat_id)
	Force visibility. More...

Static Public Member Functions
static	_getInstanceByUserId ($a_user_id, $a_ref_id=0)
	get instance by user id More...
static	_deleteCategories ($a_cat_id)
	delete by category More...
static	_deleteUser ($a_user_id)
	Delete by user. More...

Data Fields
const	HIDDEN = 0
const	VISIBLE = 1

Protected Member Functions
	isHidden ($a_cat_id, $info)
	Check if category is hidden. More...
	read ()
	read user selection More...

Protected Attributes
	$user_id
	$hidden = array()
	$visible = array()
	$db

Static Protected Attributes
static	$instances = array()

Private Member Functions
	__construct ($a_user_id, $a_ref_id=0)
	Constructor. More...

Detailed Description

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

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

private

Constructor.

Parameters

int	$a_user_id	user id
int	$a_ref_id	object ref id
	int	user id

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

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

    {
        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();
    }

Here is the call graph for this function:

Member Function Documentation

_deleteCategories()

static ilCalendarVisibility::_deleteCategories (   $a_cat_id )

static

delete by category

public

Parameters

int	category id

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

References $DIC, $ilDB, and $query.

Referenced by ilCalendarCategory\delete().

    {
        global $DIC;

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

Here is the caller graph for this function:

_deleteUser()

static ilCalendarVisibility::_deleteUser (   $a_user_id )

static

Delete by user.

public

Parameters

int

$a_user_id

user_id

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

References $DIC, $ilDB, and $query.

    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = "DELETE FROM cal_cat_visibility " .
            "WHERE user_id = " . $ilDB->quote($a_user_id, 'integer') . " ";
        $ilDB->manipulate($query);
    }

_getInstanceByUserId()

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

static

get instance by user id

Parameters

int	$a_user_id	user id
int	$a_ref_id	object ref id

Returns

ilCalendarVisibility

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

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

    {
        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];
    }

Here is the caller graph for this function:

delete()

ilCalendarVisibility::delete

(

$a_cat_id = null

)

delete

public

Parameters

int

$a_cat_id

cat id (if empty all categories are deleted)

Returns

bool

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

References $query.

    {
        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);
        return true;
    }

filterHidden()

ilCalendarVisibility::filterHidden	(		$categories,
			$category_info
	)

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

Parameters

object	$categories
object	$category_info

Returns

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

References $hidden, $info, array, and isHidden().

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

Here is the call graph for this function:

forceVisibility()

ilCalendarVisibility::forceVisibility

(

$a_cat_id

)

Force visibility.

Parameters

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

References $key.

    {
        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;
        }
    }

getHidden()

ilCalendarVisibility::getHidden

(

)

get hidden categories

public

Returns

array array of category ids

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

References array.

    {
        return $this->hidden ? $this->hidden : array();
    }

getVisible()

ilCalendarVisibility::getVisible

(

)

get visible categories

public

Returns

array array of category ids

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

References array.

    {
        return $this->visible ? $this->visible : array();
    }

hideSelected()

ilCalendarVisibility::hideSelected

(

$a_hidden

)

hide selected

public

Parameters

array

array of hidden categories

Returns

bool

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

    {
        $this->hidden = $a_hidden;
        return true;
    }

isAppointmentVisible()

ilCalendarVisibility::isAppointmentVisible

(

$a_cal_id

)

check whether an appoinment is visible or not

public

Parameters

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

References ilCalendarCategoryAssignments\_lookupCategories().

    {
        include_once('./Services/Calendar/classes/class.ilCalendarCategoryAssignments.php');
        
        foreach (ilCalendarCategoryAssignments::_lookupCategories($a_cal_id) as $cat_id) {
            if (in_array($cat_id, $this->hidden)) {
                return true;
            }
        }
        return false;
    }

Here is the call graph for this function:

isHidden()

ilCalendarVisibility::isHidden (   $a_cat_id,   $info  )

protected

Check if category is hidden.

Parameters

object

$a_cat_id

Returns

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

References $info, and ilCalendarCategory\TYPE_OBJ.

Referenced by filterHidden().

    {
        // 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);
    }

Here is the caller graph for this function:

read()

ilCalendarVisibility::read ( )

protected

read user selection

protected

Returns

bool

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

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

Referenced by __construct().

    {
        $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;
            }
        }
        return true;
    }

Here is the caller graph for this function:

save()

ilCalendarVisibility::save

(

)

save hidden selection

public

Returns

bool

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

References $DIC, $hidden, $ilDB, $query, and $visible.

    {
        global $DIC;

        $ilDB = $DIC->database();

        $this->delete();
        foreach ($this->hidden as $hidden) {
            $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') .
                ")";
            $ilDB->manipulate($query);
        }
        foreach ($this->visible as $visible) {
            $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') .
                ")";
            $ilDB->manipulate($query);
        }
        return true;
    }

showSelected()

ilCalendarVisibility::showSelected

(

$a_visible

)

Show selected.

public

Parameters

array

array of visible categories

Returns

bool

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

    {
        $this->visible = $a_visible;
        return true;
    }

Field Documentation

$db

ilCalendarVisibility::$db

protected

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

$hidden

ilCalendarVisibility::$hidden = array()

protected

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

Referenced by filterHidden(), and save().

$instances

ilCalendarVisibility::$instances = array()

staticprotected

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

$user_id

ilCalendarVisibility::$user_id

protected

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

$visible

ilCalendarVisibility::$visible = array()

protected

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

Referenced by save().

HIDDEN

const ilCalendarVisibility::HIDDEN = 0

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

VISIBLE

const ilCalendarVisibility::VISIBLE = 1

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

---

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

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