Abstract parent class for all calendar custom modals plugin classes. More...

Inheritance diagram for ilAppointmentCustomModalPlugin:

Collaboration diagram for ilAppointmentCustomModalPlugin:

Public Member Functions
	setAppointment (ilCalendarEntry $a_appointment, ilDateTime $a_start_date)

	getAppointment ()

	getStartDate ()

	getComponentType ()
	Get component type. More...

	getComponentName ()
	Get component Name. More...

	getSlot ()
	Get slot. More...

	getSlotId ()
	Get Slot id. More...

	slotInit ()
	empty 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
	__construct ()

	getComponentType ()
	Get Component Type. More...

	getComponentName ()
	Get Component Name. More...

	getSlot ()
	Get Slot Name. More...

	getSlotId ()
	Get Slot ID. More...

	getPluginName ()
	Get Plugin Name. More...

	getId ()
	Get Id. More...

	getLastUpdateVersion ()
	Get Version of last update. More...

	getVersion ()
	Get Current Version (from plugin.php file). More...

	getIliasMinVersion ()
	Get Required ILIAS min. More...

	getIliasMaxVersion ()
	Get Required ILIAS max. More...

	getActive ()
	Get Active. More...

	setDBVersion ($a_dbversion)
	Set DB Version. More...

	getDBVersion ()
	Get DB Version. More...

	writeDBVersion ($a_dbversion)
	Write DB version to database. More...

	getDirectory ()
	Get Plugin Directory. More...

	includeClass ($a_class_file_name)
	Include (once) a class file. More...

	getPrefix ()
	Get plugin prefix, used for lang vars. More...

	getTablePrefix ()
	Get db table plugin prefix. More...

	updateLanguages ($a_lang_keys=null)

	updateDatabase ()
	Update database. More...

	loadLanguageModule ()
	Load language module for plugin. More...

	txt ($a_var)
	Get Language Variable (prefix will be prepended automatically) More...

	getTemplate ($a_template, $a_par1=true, $a_par2=true)
	Get template from plugin. More...

	getImagePath ($a_img)
	Get image path. More...

	getStyleSheetLocation ($a_css_file)
	Get css file location. More...

	addBlockFile ($a_tpl, $a_var, $a_block, $a_tplname)
	Add template content to placeholder variable. More...

	isActive ()
	Check whether plugin is active. More...

	needsUpdate ()
	Check whether update is needed. More...

	install ()
	Install. More...

	activate ()
	Activate. More...

	deactivate ()
	Deactivate. More...

	uninstall ()

	update ()
	Update plugin. More...

Protected Attributes
	$appointment

	$start_date

Protected Attributes inherited from ilPlugin
	$lang_initialised = false

	$id = ''

Additional Inherited Members
Static Public Member Functions inherited from ilPlugin
static	_getDirectory ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get plugin directory. More...

static	getAvailableLangFiles ($a_lang_directory)
	Get array of all language files in the plugin. More...

static	hasConfigureClass ($a_slot_dir, $a_name)
	Has the plugin a configure class? More...

static	getConfigureClassName ($a_name)
	Get plugin configure class name. More...

static	getDBUpdateScriptName ($a_ctype, $a_cname, $a_slot_name, $a_pname)
	Get DB update script filename (full path) More...

static	lookupTxt ($a_mod_prefix, $a_pl_id, $a_lang_var)
	Lookup language text. More...

static	langExitsById ($pluginId, $langVar)
	Is searched lang var available in plugin lang files. More...

static	_getImagePath ( $a_ctype, $a_cname, $a_slot_id, $a_pname, $a_img)
	Get image path. More...

static	createPluginRecord ($a_ctype, $a_cname, $a_slot_id, $a_pname)

static	getPluginRecord ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get record from il_plugin table. More...

static	getPluginObject ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Get plugin object. More...

static	lookupStoredData ($a_ctype, $a_cname, $a_slot_id, $a_pname)
	Lookup information data in il_plugin. More...

static	getActivePluginsForSlot ($a_ctype, $a_cname, $a_slot_id)
	Get all active plugin names for a slot. More...

static	getActivePluginIdsForSlot ($a_ctype, $a_cname, $a_slot_id)
	Get All active plugin ids for a slot. More...

static	lookupNameForId ($a_ctype, $a_cname, $a_slot_id, $a_plugin_id)
	Lookup name for id. More...

static	lookupIdForName ($a_ctype, $a_cname, $a_slot_id, $a_plugin_name)
	Lookup id for name. More...

Protected Member Functions inherited from ilPlugin
	setSlotObject ($a_slot)
	Set Plugin Slot. More...

	getSlotObject ()
	Get Plugin Slot. More...

	getClassesDirectory ()
	Get Plugin's classes Directory. More...

	getLanguageDirectory ()
	Get Plugin's language Directory. More...

	slotInit ()
	Object initialization done by slot. More...

	init ()
	Object initialization. More...

	afterInstall ()
	After install processing. More...

	beforeActivation ()
	Before activation processing. More...

	afterActivation ()
	After activation processing. More...

	afterDeactivation ()
	After deactivation processing. More...

	beforeUninstall ()

	afterUninstall ()

	readEventListening ()
	Read the event listening definitions from the plugin.xml (if file exists) More...

	clearEventListening ()
	Clear the entries of this plugin in the event handling table. More...

	beforeUpdate ()
	Before update processing. More...

	afterUpdate ()
	After update processing. More...

Detailed Description

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

Version: $Id$

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

Member Function Documentation

◆ addExtraContent()

ilAppointmentCustomModalPlugin::addExtraContent ( )

abstract

Add content after the Infoscreen.

Returns: mixed

Referenced by slotInit().

Here is the caller graph for this function:

◆ editModalTitle()

ilAppointmentCustomModalPlugin::editModalTitle ( $current_title )

abstract

Parameters

string $current_title

Returns: string

Referenced by slotInit().

Here is the caller graph for this function:

◆ getAppointment()

ilAppointmentCustomModalPlugin::getAppointment ( )

Returns: ilCalendarEntry

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

References $appointment.

     {
         return $this->appointment;
     }

◆ getComponentName()

ilAppointmentCustomModalPlugin::getComponentName ( )

final

Get component Name.

Returns: string

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

     {
         return "Calendar";
     }

◆ getComponentType()

ilAppointmentCustomModalPlugin::getComponentType ( )

final

Get component type.

Returns: string

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

References IL_COMP_SERVICE.

     {
         return IL_COMP_SERVICE;
     }

◆ getSlot()

ilAppointmentCustomModalPlugin::getSlot ( )

final

Get slot.

Returns: string

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

     {
         return "AppointmentCustomModal";
     }

◆ getSlotId()

ilAppointmentCustomModalPlugin::getSlotId ( )

final

Get Slot id.

Returns: string

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

     {
         return "capm";
     }

◆ getStartDate()

ilAppointmentCustomModalPlugin::getStartDate ( )

Returns: ilDateTime 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 49 of file class.ilAppointmentCustomModalPlugin.php.

References $start_date.

     {
         return $this->start_date;
     }

◆ infoscreenAddContent()

ilAppointmentCustomModalPlugin::infoscreenAddContent ( ilInfoScreenGUI $a_info )

abstract

Add elements in the infoscreen.

Parameters

ilInfoScreenGUI $a_info

Returns: mixed

Referenced by slotInit().

Here is the caller graph for this function:

◆ replaceContent()

ilAppointmentCustomModalPlugin::replaceContent ( )

abstract

Replace the content inside the modal.

Returns: mixed

Referenced by slotInit().

Here is the caller graph for this function:

◆ setAppointment()

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

Parameters

ilCalendarEntry	$a_appointment
ilDateTime	$a_start_date

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

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

◆ slotInit()

ilAppointmentCustomModalPlugin::slotInit ( )

final

empty

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

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

     {
         //nothing to do here.
     }

Here is the call graph for this function:

◆ toolbarAddItems()

ilAppointmentCustomModalPlugin::toolbarAddItems ( ilToolbarGUI $a_toolbar )

abstract

Add elements in the toolbar.

Parameters

ilToolbarGUI $a_toolbar

Returns: ilToolbarGUI

Referenced by slotInit().

Here is the caller graph for this function:

◆ toolbarReplaceContent()

ilAppointmentCustomModalPlugin::toolbarReplaceContent ( )

abstract

Replace the toolbar for another one.

Returns: mixed

Referenced by slotInit().

Here is the caller graph for this function:

Field Documentation

◆ $appointment

ilCalendarEntry ilAppointmentCustomModalPlugin::$appointment

protected

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

Referenced by getAppointment().

◆ $start_date

DateTime ilAppointmentCustomModalPlugin::$start_date

protected

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

Referenced by getStartDate().

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

Services/Calendar/classes/class.ilAppointmentCustomModalPlugin.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addExtraContent()

◆ editModalTitle()

◆ getAppointment()

◆ getComponentName()

◆ getComponentType()

◆ getSlot()

◆ getSlotId()

◆ getStartDate()

◆ infoscreenAddContent()

◆ replaceContent()

◆ setAppointment()

◆ slotInit()

◆ toolbarAddItems()

◆ toolbarReplaceContent()

Field Documentation

◆ $appointment

◆ $start_date