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...

	getComponentType ()
	Get component type. More...

	getComponentName ()
	Get component Name. More...

	getSlot ()
	Get slot name. More...

	getSlotId ()
	Get slot Id. More...

	slotInit ()
	empty More...

	replaceContent ($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 (\ILIAS\UI\Component\Item\Item $item)

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

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

	getVersion ()

	getIliasMinVersion ()

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

	getActive ()

	setDBVersion (int $a_dbversion)

	getDBVersion ()

	writeDBVersion (int $a_dbversion)

	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 (string $a_var)
	Get Language Variable (prefix will be prepended automatically) More...

	getTemplate (string $a_template, bool $a_par1=true, bool $a_par2=true)
	gets a ilTemplate instance of a html-file in the plugin /templates More...

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

	getStyleSheetLocation (string $a_css_file)

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

	activate ()
	Activate. More...

	deactivate ()
	Deactivate. More...

	uninstall ()

	update ()
	Update plugin. More...

	promoteGlobalScreenProvider ()

Protected Attributes
	$appointment

	$start_date

Protected Attributes inherited from ilPlugin
	$slot

	$active = false

	$iliasmaxversion = ""

	$iliasminversion = ""

	$version = ""

	$lastupdateversion = ""

	$dbversion = 0

	$lang_initialised = false

	$id = ''

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

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

static	hasConfigureClass (string $a_slot_dir, array $plugin_data, array $plugin_db_data)
	Has the plugin a configure class? More...

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

static	getDBUpdateScriptName (string $a_ctype, string $a_cname, string $a_slot_name, string $a_pname)

static	lookupTxt (string $a_mod_prefix, string $a_pl_id, string $a_lang_var)

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

static	_getImagePath (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname, string $a_img)

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

static	getPluginRecord (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)

static	getPluginObject (string $a_ctype, string $a_cname, string $a_slot_id, string $a_pname)

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

static	getActivePluginsForSlot (string $a_ctype, string $a_cname, string $a_slot_id)

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

static	lookupNameForId (string $a_ctype, string $a_cname, string $a_slot_id, string $a_plugin_id)

static	lookupIdForName (string $a_ctype, string $a_cname, string $a_slot_id, string $a_plugin_name)

static	lookupTypeInformationsForId (string $id)

Protected Member Functions inherited from ilPlugin
	setSlotObject (ilPluginSlot $a_slot)

	getSlotObject ()

	getClassesDirectory ()

	getLanguageDirectory ()

	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 ()
	This is Plugin-Specific and is triggered after the uninstall command of a plugin. More...

	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 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 12 of file class.ilAppointmentCustomGridPlugin.php.

Member Function Documentation

◆ addExtraContent()

ilAppointmentCustomGridPlugin::addExtraContent ( )

abstract

Add extra content in the grid after the event title.

Returns: mixed

Referenced by slotInit().

Here is the caller graph for this function:

◆ addGlyph()

ilAppointmentCustomGridPlugin::addGlyph ( )

abstract

Add glyph before the appointment title.

Returns: mixed

Referenced by slotInit().

Here is the caller graph for this function:

◆ editAgendaItem()

ilAppointmentCustomGridPlugin::editAgendaItem ( \ILIAS\UI\Component\Item\Item $item )

abstract

Parameters

$item

Referenced by slotInit().

Here is the caller graph for this function:

◆ editShyButtonTitle()

ilAppointmentCustomGridPlugin::editShyButtonTitle ( )

abstract

Edit the shy button title.

Returns: mixed

Referenced by slotInit().

Here is the caller graph for this function:

◆ getAppointment()

ilAppointmentCustomGridPlugin::getAppointment ( )

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

Returns: ilCalendarEntry

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

References $appointment.

     {
         return $this->appointment;
     }

◆ getComponentName()

ilAppointmentCustomGridPlugin::getComponentName ( )

final

Get component Name.

Returns: string

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

     {
         return "Calendar";
     }

◆ getComponentType()

ilAppointmentCustomGridPlugin::getComponentType ( )

final

Get component type.

Returns: string

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

References IL_COMP_SERVICE.

     {
         return IL_COMP_SERVICE;
     }

◆ getSlot()

ilAppointmentCustomGridPlugin::getSlot ( )

final

Get slot name.

Returns: string

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

     {
         return "AppointmentCustomGrid";
     }

◆ getSlotId()

ilAppointmentCustomGridPlugin::getSlotId ( )

final

Get slot Id.

Returns: string

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

     {
         return "capg";
     }

◆ getStartDate()

ilAppointmentCustomGridPlugin::getStartDate ( )

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

Returns: ilDateTime

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

References $start_date.

     {
         return $this->start_date;
     }

◆ replaceContent()

ilAppointmentCustomGridPlugin::replaceContent ( $content )

abstract

Replaces the complete content in a calendar Grid.

Parameters

$content string html content

Returns: mixed

Referenced by slotInit().

Here is the caller graph for this function:

◆ setAppointment()

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

Parameters

ilCalendarEntry	$a_appointment
ilDateTime	$a_start_date

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

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

◆ slotInit()

ilAppointmentCustomGridPlugin::slotInit ( )

final

empty

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

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

     {
         //nothing to do here.
     }

Here is the call graph for this function:

Field Documentation

◆ $appointment

ilCalendarEntry ilAppointmentCustomGridPlugin::$appointment

protected

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

Referenced by getAppointment().

◆ $start_date

DateTime ilAppointmentCustomGridPlugin::$start_date

protected

Definition at line 22 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

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addExtraContent()

◆ addGlyph()

◆ editAgendaItem()

◆ editShyButtonTitle()

◆ getAppointment()

◆ getComponentName()

◆ getComponentType()

◆ getSlot()

◆ getSlotId()

◆ getStartDate()

◆ replaceContent()

◆ setAppointment()

◆ slotInit()

Field Documentation

◆ $appointment

◆ $start_date