ILIAS  release_8 Revision v8.19
All Data Structures Namespaces Files Functions Variables Modules Pages
ilAppointmentCustomModalPlugin Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

+ Inheritance diagram for ilAppointmentCustomModalPlugin:
+ Collaboration diagram for ilAppointmentCustomModalPlugin:

Public Member Functions

 setAppointment (ilCalendarEntry $a_appointment, ilDateTime $a_start_date)
 
 getAppointment ()
 
 getStartDate ()
 This is the date of the calendar entry, it's not the appointment start date. More...
 
 replaceContent ()
 Replace the content inside the modal. More...
 
 addExtraContent ()
 Add content after the Infoscreen. More...
 
 infoscreenAddContent (ilInfoScreenGUI $a_info)
 Add elements in the infoscreen. More...
 
 toolbarAddItems (ilToolbarGUI $a_toolbar)
 Add elements in the toolbar. More...
 
 toolbarReplaceContent ()
 Replace the toolbar for another one. More...
 
 editModalTitle ($current_title)
 
- 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)
 ILIAS is moving towards UI components and plugins are expected to use these components. More...
 
 getStyleSheetLocation (string $a_css_file)
 ILIAS is moving towards UI components and plugins are expected to use these components. More...
 
 addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname)
 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 ()
 If you cannot get rid of the requirement to use this, adjust the install method in your subclass instead. More...
 
 beforeUninstall ()
 If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More...
 
 afterUninstall ()
 If you cannot get rid of the requirement to use this, adjust the uninstall method in your subclass instead. More...
 
 beforeActivation ()
 If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...
 
 afterActivation ()
 If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...
 
 afterDeactivation ()
 If you cannot get rid of the requirement to use this, adjust the activate method in your subclass instead. More...
 
 updateDatabase ()
 
 beforeUpdate ()
 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

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 Abstract parent class for all calendar custom modals plugin classes.

Author
Jesús López Reyes lopez.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Member Function Documentation

◆ addExtraContent()

ilAppointmentCustomModalPlugin::addExtraContent ( )
abstract

Add content after the Infoscreen.

Referenced by getStartDate().

+ Here is the caller graph for this function:

◆ editModalTitle()

ilAppointmentCustomModalPlugin::editModalTitle (   $current_title)
abstract

Referenced by getStartDate().

+ Here is the caller graph for this function:

◆ getAppointment()

ilAppointmentCustomModalPlugin::getAppointment ( )

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

References $appointment.

38  {
39  return $this->appointment;
40  }
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...

◆ getStartDate()

ilAppointmentCustomModalPlugin::getStartDate ( )

This is the date of the calendar entry, it's not the appointment start date.

This is important because an appointment can be recursive (e.g. 11 july, 12 july, 13, july) The appointment start date is always 11 July but for an entry it can be 11,12 or 13) When routing it is used to set up the parameter "dt"

Definition at line 48 of file class.ilAppointmentCustomModalPlugin.php.

References $start_date, addExtraContent(), editModalTitle(), infoscreenAddContent(), replaceContent(), toolbarAddItems(), and toolbarReplaceContent().

+ Here is the call graph for this function:

◆ infoscreenAddContent()

ilAppointmentCustomModalPlugin::infoscreenAddContent ( ilInfoScreenGUI  $a_info)
abstract

Add elements in the infoscreen.

Referenced by getStartDate().

+ Here is the caller graph for this function:

◆ replaceContent()

ilAppointmentCustomModalPlugin::replaceContent ( )
abstract

Replace the content inside the modal.

Referenced by getStartDate().

+ Here is the caller graph for this function:

◆ setAppointment()

ilAppointmentCustomModalPlugin::setAppointment ( ilCalendarEntry  $a_appointment,
ilDateTime  $a_start_date 
)

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

31  : void
32  {
33  $this->appointment = $a_appointment;
34  $this->start_date = $a_start_date;
35  }

◆ toolbarAddItems()

ilAppointmentCustomModalPlugin::toolbarAddItems ( ilToolbarGUI  $a_toolbar)
abstract

Add elements in the toolbar.

Referenced by getStartDate().

+ Here is the caller graph for this function:

◆ toolbarReplaceContent()

ilAppointmentCustomModalPlugin::toolbarReplaceContent ( )
abstract

Replace the toolbar for another one.

Referenced by getStartDate().

+ Here is the caller graph for this function:

Field Documentation

◆ $appointment

ilCalendarEntry ilAppointmentCustomModalPlugin::$appointment
protected

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

Referenced by getAppointment().

◆ $start_date

ilDateTime ilAppointmentCustomModalPlugin::$start_date
protected

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

Referenced by getStartDate().


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