ILIAS  release_8 Revision v8.24
ilCalendarScheduleFilterHidden Class Reference

Calendar schedule filter for hidden categories. More...

+ Inheritance diagram for ilCalendarScheduleFilterHidden:
+ Collaboration diagram for ilCalendarScheduleFilterHidden:

Public Member Functions

 __construct (int $a_user_id)
 
 filterCategories (array $a_cats)
 @ineritDoc More...
 
 modifyEvent (ilCalendarEntry $a_event)
 @inheritDoc More...
 
 addCustomEvents (ilDate $start, ilDate $end, array $a_categories)
 @inheritDoc More...
 
 filterCategories (array $a_cats)
 
 modifyEvent (ilCalendarEntry $a_event)
 Modifies event properties. More...
 
 addCustomEvents (ilDate $start, ilDate $end, array $a_categories)
 Add (return) an array of custom ilCalendarEntry's. More...
 

Protected Attributes

int $user_id
 
ilCalendarVisibility $hidden_cat
 

Detailed Description

Calendar schedule filter for hidden categories.

Author
Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilCalendarScheduleFilterHidden::__construct ( int  $a_user_id)

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

18 {
19 $this->user_id = $a_user_id;
21 $this->user_id,
22 ilCalendarCategories::_getInstance($this->user_id)->getSourceRefId()
23 );
24 }
static _getInstance($a_usr_id=0)
get singleton instance
static _getInstanceByUserId(int $a_user_id, int $a_ref_id=0)

References ilCalendarCategories\_getInstance(), and ilCalendarVisibility\_getInstanceByUserId().

+ Here is the call graph for this function:

Member Function Documentation

◆ addCustomEvents()

ilCalendarScheduleFilterHidden::addCustomEvents ( ilDate  $start,
ilDate  $end,
array  $a_categories 
)

@inheritDoc

Implements ilCalendarScheduleFilter.

Definition at line 52 of file class.ilCalendarScheduleFilterHidden.php.

52 : array
53 {
54 return [];
55 }

◆ filterCategories()

ilCalendarScheduleFilterHidden::filterCategories ( array  $a_cats)

@ineritDoc

Implements ilCalendarScheduleFilter.

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

29 : array
30 {
31 return $this->hidden_cat->filterHidden(
32 $a_cats,
33 ilCalendarCategories::_getInstance($this->user_id)->getCategoriesInfo()
34 );
35 }

References ilCalendarCategories\_getInstance().

+ Here is the call graph for this function:

◆ modifyEvent()

ilCalendarScheduleFilterHidden::modifyEvent ( ilCalendarEntry  $a_event)

@inheritDoc

Implements ilCalendarScheduleFilter.

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

41 {
42 // the not is ok since isAppointmentVisible return false for visible appointments
43 if (!$this->hidden_cat->isAppointmentVisible($a_event->getEntryId())) {
44 return $a_event;
45 }
46 return null;
47 }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

References ilCalendarEntry\getEntryId().

+ Here is the call graph for this function:

Field Documentation

◆ $hidden_cat

ilCalendarVisibility ilCalendarScheduleFilterHidden::$hidden_cat
protected

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

◆ $user_id

int ilCalendarScheduleFilterHidden::$user_id
protected

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


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