ilCalendarScheduleFilter Interface Reference

Calendar schedule filter interface. More...

Inheritance diagram for ilCalendarScheduleFilter:

Collaboration diagram for ilCalendarScheduleFilter:

Public Member Functions
	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...

Detailed Description

Calendar schedule filter interface.

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 14 of file interface.ilCalendarScheduleFilter.php.

Member Function Documentation

addCustomEvents()

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

Add (return) an array of custom ilCalendarEntry's.

Parameters

ilDate	$start
ilDate	$end
array	$a_categories

Returns

ilCalendarEntry[]

Implemented in ilCalendarScheduleFilterTimings, ilCalendarScheduleFilterExercise, ilCalendarScheduleFilterBookings, ilCalendarScheduleFilterConsultationHourInRepository, ilCalendarScheduleFilterBookingPool, and ilCalendarScheduleFilterHidden.

filterCategories()

ilCalendarScheduleFilter::filterCategories

(

array

$a_cats

)

Parameters

array

$a_cats

Returns

array

Implemented in ilCalendarScheduleFilterTimings, ilCalendarScheduleFilterExercise, ilCalendarScheduleFilterBookings, ilCalendarScheduleFilterConsultationHourInRepository, ilCalendarScheduleFilterHidden, and ilCalendarScheduleFilterBookingPool.

modifyEvent()

ilCalendarScheduleFilter::modifyEvent

(

ilCalendarEntry

$a_event

)

Modifies event properties.

Return null to hide the event.

Parameters

ilCalendarEntry

$a_event

Returns

ilCalendarEntry|null

Implemented in ilCalendarScheduleFilterTimings, ilCalendarScheduleFilterExercise, ilCalendarScheduleFilterBookings, ilCalendarScheduleFilterHidden, ilCalendarScheduleFilterConsultationHourInRepository, and ilCalendarScheduleFilterBookingPool.

---

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

• Services/Calendar/interfaces/interface.ilCalendarScheduleFilter.php