ilAppointmentCustomGridPlugin Class Reference
Abstract parent class for all calendar custom grid plugin classes. More...
Inheritance diagram for ilAppointmentCustomGridPlugin:
Collaboration diagram for ilAppointmentCustomGridPlugin:
Public Member Functions | |
| setAppointment (ilCalendarEntry $a_appointment, ilDateTime $a_start_date) | |
| getAppointment () | |
| Get the calendar entry (appointment['event']) More... | |
| getStartDate () | |
| Get the specific start date of the calendar entry, not the appointment starting date. More... | |
| replaceContent (string $content) | |
| Replaces the complete content in a calendar Grid. More... | |
| addExtraContent () | |
| Add extra content in the grid after the event title. More... | |
| addGlyph () | |
| Add glyph before the appointment title. More... | |
| editShyButtonTitle () | |
| Edit the shy button title. More... | |
| editAgendaItem (UiComponentItem $item) | |
| Modify the agenda item. More... | |
| Public Member Functions inherited from ilPlugin | |
| getMessage () | |
| __construct (\ilDBInterface $db, \ilComponentRepositoryWrite $component_repository, string $id) | |
| getPluginName () | |
| getId () | |
| getVersion () | |
| Only very little classes seem to care about this: More... | |
| getDirectory () | |
| Only very little classes seem to care about this: More... | |
| isActive () | |
| Only very little classes seem to care about this: More... | |
| needsUpdate () | |
| install () | |
| uninstall () | |
| activate () | |
| This will update (if required) and activate the plugin. More... | |
| deactivate () | |
| update () | |
| loadLanguageModule () | |
| Load language module for plugin. More... | |
| txt (string $a_var) | |
| Get Language Variable (prefix will be prepended automatically) More... | |
| getTemplate (string $a_template, bool $a_par1=true, bool $a_par2=true) | |
| @deprecate ILIAS is moving towards UI components and plugins are expected to use these components. More... | |
| getStyleSheetLocation (string $a_css_file) | |
| @deprecate ILIAS is moving towards UI components and plugins are expected to use these components. More... | |
| addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname) | |
| @deprecate ILIAS is moving towards UI components and plugins are expected to use these components. More... | |
| getGlobalScreenProviderCollection () | |
| exchangeUIRendererAfterInitialization (\ILIAS\DI\Container $dic) | |
| This methods allows to replace the UI Renderer (see src/UI) of ILIAS after initialization by returning a closure returning a custom renderer. More... | |
| exchangeUIFactoryAfterInitialization (string $dic_key, \ILIAS\DI\Container $dic) | |
| This methods allows to replace some factory for UI Components (see src/UI) of ILIAS after initialization by returning a closure returning a custom factory. More... | |
Protected Attributes | |
| ilCalendarEntry | $appointment |
| ilDateTime | $start_date |
| Protected Attributes inherited from ilPlugin | |
| ilDBInterface | $db |
| ilComponentRepositoryWrite | $component_repository |
| string | $id |
| ilPluginLanguage | $language_handler = null |
| bool | $lang_initialised = false |
| ProviderCollection | $provider_collection |
| string | $message = '' |
Additional Inherited Members | |
| Protected Member Functions inherited from ilPlugin | |
| init () | |
| Object initialization. More... | |
| getPluginInfo () | |
| getComponentInfo () | |
| getPluginSlotInfo () | |
| afterInstall () | |
| @deprecate If you cannot get rid of the requirement to use this, adjust the install method in your subclass instead. More... | |
| beforeUninstall () | |
| @deprecate If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More... | |
| afterUninstall () | |
| @deprecate If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More... | |
| beforeActivation () | |
| @deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More... | |
| afterActivation () | |
| @deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More... | |
| afterDeactivation () | |
| @deprecate If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More... | |
| updateDatabase () | |
| beforeUpdate () | |
| @deprecate If you cannot get rid of the requirement to use this, adjust the update method in your subclass instead. More... | |
| afterUpdate () | |
| getLanguageHandler () | |
| buildLanguageHandler () | |
| readEventListening () | |
| clearEventListening () | |
Detailed Description
Abstract parent class for all calendar custom grid plugin classes.
- Version
- $Id$
Definition at line 15 of file class.ilAppointmentCustomGridPlugin.php.
Member Function Documentation
◆ addExtraContent()
|
abstract |
Add extra content in the grid after the event title.
◆ addGlyph()
|
abstract |
Add glyph before the appointment title.
◆ editAgendaItem()
|
abstract |
Modify the agenda item.
◆ editShyButtonTitle()
|
abstract |
Edit the shy button title.
◆ getAppointment()
| ilAppointmentCustomGridPlugin::getAppointment | ( | ) |
Get the calendar entry (appointment['event'])
Definition at line 29 of file class.ilAppointmentCustomGridPlugin.php.
29 : ?ilCalendarEntry
30 {
32 }
ilCalendarEntry $appointment
Definition: class.ilAppointmentCustomGridPlugin.php:17
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: class.ilCalendarEntry.php:28
References $appointment.
◆ getStartDate()
| ilAppointmentCustomGridPlugin::getStartDate | ( | ) |
Get the specific start date of the calendar entry, not the appointment starting date.
Definition at line 37 of file class.ilAppointmentCustomGridPlugin.php.
37 : ?ilDateTime
38 {
40 }
ilDateTime $start_date
Definition: class.ilAppointmentCustomGridPlugin.php:18
References $start_date.
◆ replaceContent()
|
abstract |
Replaces the complete content in a calendar Grid.
◆ setAppointment()
| ilAppointmentCustomGridPlugin::setAppointment | ( | ilCalendarEntry | $a_appointment, |
| ilDateTime | $a_start_date | ||
| ) |
Definition at line 20 of file class.ilAppointmentCustomGridPlugin.php.
20 : void
21 {
22 $this->appointment = $a_appointment;
23 $this->start_date = $a_start_date;
24 }
Field Documentation
◆ $appointment
|
protected |
Definition at line 17 of file class.ilAppointmentCustomGridPlugin.php.
Referenced by getAppointment().
◆ $start_date
|
protected |
Definition at line 18 of file class.ilAppointmentCustomGridPlugin.php.
Referenced by getStartDate().
The documentation for this class was generated from the following file:
- Services/Calendar/classes/class.ilAppointmentCustomGridPlugin.php
