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)
	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 ()

Detailed Description

Abstract parent class for all calendar custom grid plugin classes.

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

Version: $Id$

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

Member Function Documentation

◆ addExtraContent()

ilAppointmentCustomGridPlugin::addExtraContent ( )

abstract

Add extra content in the grid after the event title.

Referenced by getStartDate().

Here is the caller graph for this function:

◆ addGlyph()

ilAppointmentCustomGridPlugin::addGlyph ( )

abstract

Add glyph before the appointment title.

Referenced by getStartDate().

Here is the caller graph for this function:

◆ editAgendaItem()

ilAppointmentCustomGridPlugin::editAgendaItem ( UiComponentItem $item )

abstract

Modify the agenda item.

Referenced by getStartDate().

Here is the caller graph for this function:

◆ editShyButtonTitle()

ilAppointmentCustomGridPlugin::editShyButtonTitle ( )

abstract

Edit the shy button title.

Referenced by getStartDate().

Here is the caller graph for this function:

◆ getAppointment()

ilAppointmentCustomGridPlugin::getAppointment ( )

Get the calendar entry (appointment['event'])

Definition at line 43 of file class.ilAppointmentCustomGridPlugin.php.

References $appointment.

                                     : ?ilCalendarEntry
     {
         return $this->appointment;
     }

◆ getStartDate()

ilAppointmentCustomGridPlugin::getStartDate ( )

Get the specific start date of the calendar entry, not the appointment starting date.

Definition at line 51 of file class.ilAppointmentCustomGridPlugin.php.

References $start_date, addExtraContent(), addGlyph(), editAgendaItem(), editShyButtonTitle(), and replaceContent().

                                   : ?ilDateTime
     {
         return $this->start_date;
     }

Here is the call graph for this function:

◆ replaceContent()

ilAppointmentCustomGridPlugin::replaceContent ( string $content )

abstract

Replaces the complete content in a calendar Grid.

Referenced by getStartDate().

Here is the caller graph for this function:

◆ setAppointment()

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

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

                                                                                             : void
     {
         $this->appointment = $a_appointment;
         $this->start_date = $a_start_date;
     }

Field Documentation

◆ $appointment

ilCalendarEntry ilAppointmentCustomGridPlugin::$appointment

protected

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

Referenced by getAppointment().

◆ $start_date

ilDateTime ilAppointmentCustomGridPlugin::$start_date

protected

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

Referenced by getStartDate().

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

components/ILIAS/Calendar/classes/class.ilAppointmentCustomGridPlugin.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addExtraContent()

◆ addGlyph()

◆ editAgendaItem()

◆ editShyButtonTitle()

◆ getAppointment()

◆ getStartDate()

◆ replaceContent()

◆ setAppointment()

Field Documentation

◆ $appointment

◆ $start_date