Apointment templates are used for automatic generated apointments. More...

Collaboration diagram for ilCalendarAppointmentTemplate:

Public Member Functions
	__construct (int $a_id)

	setContextInfo (string $a_info)

	getContextInfo ()

	setTitle (string $a_title)

	getTitle ()

	setSubtitle (string $a_subtitle)
	set subtitle Used for automatic generated appointments. More...

	getSubtitle ()
	get subtitle More...

	setDescription (string $a_description)

	getDescription ()

	setInformation (string $a_information)

	getInformation ()

	setLocation (string $a_location)

	getLocation ()

	setStart (ilDateTime $start)

	getStart ()

	setEnd (ilDateTime $end)

	getEnd ()

	setFullday (bool $a_fullday)

	isFullday ()

	setTranslationType (int $a_type)

	getTranslationType ()

	getContextId ()

Protected Attributes
int	$context_id = 0

string	$context_info = ''

string	$title = ''

string	$subtitle = ''

string	$description = ''

string	$information = ''

string	$location = ''

ilDateTime	$start = null

ilDateTime	$end = null

bool	$fullday = false

int	$translation_type = ilCalendarEntry::TRANSLATION_SYSTEM

Detailed Description

Apointment templates are used for automatic generated apointments.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilCalendarAppointmentTemplate::__construct ( int $a_id )

Definition at line 40 of file class.ilCalendarAppointmentTemplate.php.

     {
         $this->context_id = $a_id;
     }

Member Function Documentation

◆ getContextId()

ilCalendarAppointmentTemplate::getContextId ( )

Definition at line 156 of file class.ilCalendarAppointmentTemplate.php.

References $context_id.

                                   : int
     {
         return $this->context_id;
     }

◆ getContextInfo()

ilCalendarAppointmentTemplate::getContextInfo ( )

Definition at line 50 of file class.ilCalendarAppointmentTemplate.php.

References $context_info.

                                     : string
     {
         return $this->context_info;
     }

◆ getDescription()

ilCalendarAppointmentTemplate::getDescription ( )

Definition at line 88 of file class.ilCalendarAppointmentTemplate.php.

References $description.

                                     : string
     {
         return $this->description;
     }

◆ getEnd()

ilCalendarAppointmentTemplate::getEnd ( )

Todo:: check if this is required

Definition at line 131 of file class.ilCalendarAppointmentTemplate.php.

References getStart().

                             : ?ilDateTime
     {
         return $this->end ?: $this->getStart();
     }

Here is the call graph for this function:

◆ getInformation()

ilCalendarAppointmentTemplate::getInformation ( )

Definition at line 98 of file class.ilCalendarAppointmentTemplate.php.

References $information.

                                     : string
     {
         return $this->information;
     }

◆ getLocation()

ilCalendarAppointmentTemplate::getLocation ( )

Definition at line 108 of file class.ilCalendarAppointmentTemplate.php.

References $location.

                                  : string
     {
         return $this->location;
     }

◆ getStart()

ilCalendarAppointmentTemplate::getStart ( )

Definition at line 118 of file class.ilCalendarAppointmentTemplate.php.

References $start.

Referenced by getEnd().

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

Here is the caller graph for this function:

◆ getSubtitle()

ilCalendarAppointmentTemplate::getSubtitle ( )

get subtitle

Definition at line 78 of file class.ilCalendarAppointmentTemplate.php.

References $subtitle.

                                  : string
     {
         return $this->subtitle;
     }

◆ getTitle()

ilCalendarAppointmentTemplate::getTitle ( )

Definition at line 60 of file class.ilCalendarAppointmentTemplate.php.

References $title.

                               : string
     {
         return $this->title;
     }

◆ getTranslationType()

ilCalendarAppointmentTemplate::getTranslationType ( )

Definition at line 151 of file class.ilCalendarAppointmentTemplate.php.

References $translation_type.

                                         : int
     {
         return $this->translation_type;
     }

◆ isFullday()

ilCalendarAppointmentTemplate::isFullday ( )

Definition at line 141 of file class.ilCalendarAppointmentTemplate.php.

References $fullday.

                                : bool
     {
         return $this->fullday;
     }

◆ setContextInfo()

ilCalendarAppointmentTemplate::setContextInfo ( string $a_info )

Definition at line 45 of file class.ilCalendarAppointmentTemplate.php.

                                                   : void
     {
         $this->context_info = $a_info;
     }

◆ setDescription()

ilCalendarAppointmentTemplate::setDescription ( string $a_description )

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

                                                          : void
     {
         $this->description = $a_description;
     }

◆ setEnd()

ilCalendarAppointmentTemplate::setEnd ( ilDateTime $end )

Definition at line 123 of file class.ilCalendarAppointmentTemplate.php.

References $end.

                                            : void
     {
         $this->end = $end;
     }

◆ setFullday()

ilCalendarAppointmentTemplate::setFullday ( bool $a_fullday )

Definition at line 136 of file class.ilCalendarAppointmentTemplate.php.

                                                : void
     {
         $this->fullday = $a_fullday;
     }

◆ setInformation()

ilCalendarAppointmentTemplate::setInformation ( string $a_information )

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

                                                          : void
     {
         $this->information = $a_information;
     }

◆ setLocation()

ilCalendarAppointmentTemplate::setLocation ( string $a_location )

Definition at line 103 of file class.ilCalendarAppointmentTemplate.php.

                                                    : void
     {
         $this->location = $a_location;
     }

◆ setStart()

ilCalendarAppointmentTemplate::setStart ( ilDateTime $start )

Definition at line 113 of file class.ilCalendarAppointmentTemplate.php.

References $start.

                                                : void
     {
         $this->start = $start;
     }

◆ setSubtitle()

ilCalendarAppointmentTemplate::setSubtitle ( string $a_subtitle )

set subtitle Used for automatic generated appointments.

Will be translated automatically and be appended to the title.

Definition at line 70 of file class.ilCalendarAppointmentTemplate.php.

                                                    : void
     {
         $this->subtitle = $a_subtitle;
     }

◆ setTitle()

ilCalendarAppointmentTemplate::setTitle ( string $a_title )

Definition at line 55 of file class.ilCalendarAppointmentTemplate.php.

                                              : void
     {
         $this->title = $a_title;
     }

◆ setTranslationType()

ilCalendarAppointmentTemplate::setTranslationType ( int $a_type )

Definition at line 146 of file class.ilCalendarAppointmentTemplate.php.

                                                    : void
     {
         $this->translation_type = $a_type;
     }

Field Documentation

◆ $context_id

int ilCalendarAppointmentTemplate::$context_id = 0

protected

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

Referenced by getContextId().

◆ $context_info

string ilCalendarAppointmentTemplate::$context_info = ''

protected

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

Referenced by getContextInfo().

◆ $description

string ilCalendarAppointmentTemplate::$description = ''

protected

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

Referenced by getDescription().

◆ $end

ilDateTime ilCalendarAppointmentTemplate::$end = null

protected

Definition at line 36 of file class.ilCalendarAppointmentTemplate.php.

Referenced by setEnd().

◆ $fullday

bool ilCalendarAppointmentTemplate::$fullday = false

protected

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

Referenced by isFullday().

◆ $information

string ilCalendarAppointmentTemplate::$information = ''

protected

Definition at line 33 of file class.ilCalendarAppointmentTemplate.php.

Referenced by getInformation().

◆ $location

string ilCalendarAppointmentTemplate::$location = ''

protected

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

Referenced by getLocation().

◆ $start

ilDateTime ilCalendarAppointmentTemplate::$start = null

protected

Definition at line 35 of file class.ilCalendarAppointmentTemplate.php.

Referenced by getStart(), and setStart().

◆ $subtitle

string ilCalendarAppointmentTemplate::$subtitle = ''

protected

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

Referenced by getSubtitle().

◆ $title

string ilCalendarAppointmentTemplate::$title = ''

protected

Definition at line 30 of file class.ilCalendarAppointmentTemplate.php.

Referenced by getTitle().

◆ $translation_type

int ilCalendarAppointmentTemplate::$translation_type = ilCalendarEntry::TRANSLATION_SYSTEM

protected

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

Referenced by getTranslationType().

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getContextId()

◆ getContextInfo()

◆ getDescription()

◆ getEnd()

◆ getInformation()

◆ getLocation()

◆ getStart()

◆ getSubtitle()

◆ getTitle()

◆ getTranslationType()

◆ isFullday()

◆ setContextInfo()

◆ setDescription()

◆ setEnd()

◆ setFullday()

◆ setInformation()

◆ setLocation()

◆ setStart()

◆ setSubtitle()

◆ setTitle()

◆ setTranslationType()

Field Documentation

◆ $context_id

◆ $context_info

◆ $description

◆ $end

◆ $fullday

◆ $information

◆ $location

◆ $start

◆ $subtitle

◆ $title

◆ $translation_type