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

Collaboration diagram for ilCalendarAppointmentTemplate:

Public Member Functions
	__construct ($a_id)
	Constructor. More...

	setContextInfo ($a_info)
	Set context info. More...

	getContextInfo ()
	Get context info. More...

	setTitle ($a_title)
	set title More...

	getTitle ()
	get title More...

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

	getSubtitle ()
	get subtitle More...

	setDescription ($a_description)
	get description More...

	getDescription ()
	get description More...

	setInformation ($a_information)
	set information More...

	getInformation ()
	get information More...

	setLocation ($a_location)
	set location More...

	getLocation ()
	get location More...

	setStart (ilDateTime $start)
	set start More...

	getStart ()
	get start More...

	setEnd (ilDateTime $end)
	set end More...

	getEnd ()
	get end More...

	setFullday ($a_fullday)
	set fullday More...

	isFullday ()
	is fullday More...

	setTranslationType ($a_type)
	set translation type More...

	getTranslationType ()
	get translation type More...

	getContextId ()
	get context id More...

Protected Attributes
	$context_id

	$context_info

	$title

	$subtitle

	$description

	$information

	$location

	$start

	$end

	$fullday = false

	$translation_type = IL_CAL_TRANSLATION_SYSTEM

	$type

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 40 of file class.ilCalendarAppointmentTemplate.php.

Constructor & Destructor Documentation

◆ __construct()

ilCalendarAppointmentTemplate::__construct ( $a_id )

Constructor.

public

Parameters

int unique id

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

     {
         $this->context_id = $a_id;
     }

Member Function Documentation

◆ getContextId()

ilCalendarAppointmentTemplate::getContextId ( )

get context id

public

Returns

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

References $context_id.

     {
         return $this->context_id;
     }

◆ getContextInfo()

ilCalendarAppointmentTemplate::getContextInfo ( )

Get context info.

Returns: string

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

References $context_info.

     {
         return $this->context_info;
     }

◆ getDescription()

ilCalendarAppointmentTemplate::getDescription ( )

get description

public

Returns: strin description

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

References $description.

     {
         return $this->description;
     }

◆ getEnd()

ilCalendarAppointmentTemplate::getEnd ( )

get end

public

Returns: ilDateTime end

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

References getStart().

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

Here is the call graph for this function:

◆ getInformation()

ilCalendarAppointmentTemplate::getInformation ( )

get information

public

Returns: string information

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

References $information.

     {
         return $this->information;
     }

◆ getLocation()

ilCalendarAppointmentTemplate::getLocation ( )

get location

public

Returns: string location

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

References $location.

     {
         return $this->location;
     }

◆ getStart()

ilCalendarAppointmentTemplate::getStart ( )

get start

public

Returns: ilDateTime start

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

References $start.

Referenced by getEnd().

     {
         return $this->start;
     }

Here is the caller graph for this function:

◆ getSubtitle()

ilCalendarAppointmentTemplate::getSubtitle ( )

get subtitle

public

Returns: string subtitle

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

References $subtitle.

     {
         return $this->subtitle;
     }

◆ getTitle()

ilCalendarAppointmentTemplate::getTitle ( )

get title

public

Returns: string title

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

References $title.

     {
         return $this->title;
     }

◆ getTranslationType()

ilCalendarAppointmentTemplate::getTranslationType ( )

get translation type

public

Parameters

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

References $translation_type.

     {
         return $this->translation_type;
     }

◆ isFullday()

ilCalendarAppointmentTemplate::isFullday ( )

is fullday

public

Returns: bool true if fullday event

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

References $fullday.

     {
         return $this->fullday;
     }

◆ setContextInfo()

ilCalendarAppointmentTemplate::setContextInfo ( $a_info )

Set context info.

Parameters

string

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

     {
         $this->context_info = $a_info;
     }

◆ setDescription()

ilCalendarAppointmentTemplate::setDescription ( $a_description )

get description

public

Parameters

string description

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

     {
         $this->description = $a_description;
     }

◆ setEnd()

ilCalendarAppointmentTemplate::setEnd ( ilDateTime $end )

set end

public

Parameters

ilDateTime end

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

References $end.

     {
         $this->end = $end;
     }

◆ setFullday()

ilCalendarAppointmentTemplate::setFullday ( $a_fullday )

set fullday

public

Parameters

bool	fullday appointment

Returns

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

     {
         $this->fullday = $a_fullday;
     }

◆ setInformation()

ilCalendarAppointmentTemplate::setInformation ( $a_information )

set information

public

Parameters

string information

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

     {
         $this->information = $a_information;
     }

◆ setLocation()

ilCalendarAppointmentTemplate::setLocation ( $a_location )

set location

public

Parameters

strin $a_location location

Returns

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

     {
         $this->location = $a_location;
     }

◆ setStart()

ilCalendarAppointmentTemplate::setStart ( ilDateTime $start )

set start

public

Parameters

ilDateTime start

Returns

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

References $start.

     {
         $this->start = $start;
     }

◆ setSubtitle()

ilCalendarAppointmentTemplate::setSubtitle ( $a_subtitle )

set subtitle Used for automatic generated appointments.

Will be translated automatically and be appended to the title.

public

Parameters

string subtitle

Returns: void

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

     {
         $this->subtitle = $a_subtitle;
     }

◆ setTitle()

ilCalendarAppointmentTemplate::setTitle ( $a_title )

set title

public

Parameters

string appointment title

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

     {
         $this->title = $a_title;
     }

◆ setTranslationType()

ilCalendarAppointmentTemplate::setTranslationType ( $a_type )

set translation type

public

Parameters

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

References $a_type.

     {
         $this->translation_type = $a_type;
     }

Field Documentation

◆ $context_id

ilCalendarAppointmentTemplate::$context_id

protected

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

Referenced by getContextId().

◆ $context_info

ilCalendarAppointmentTemplate::$context_info

protected

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

Referenced by getContextInfo().

◆ $description

ilCalendarAppointmentTemplate::$description

protected

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

Referenced by getDescription().

◆ $end

ilCalendarAppointmentTemplate::$end

protected

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

Referenced by setEnd().

◆ $fullday

ilCalendarAppointmentTemplate::$fullday = false

protected

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

Referenced by isFullday().

◆ $information

ilCalendarAppointmentTemplate::$information

protected

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

Referenced by getInformation().

◆ $location

ilCalendarAppointmentTemplate::$location

protected

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

Referenced by getLocation().

◆ $start

ilCalendarAppointmentTemplate::$start

protected

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

Referenced by getStart(), and setStart().

◆ $subtitle

ilCalendarAppointmentTemplate::$subtitle

protected

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

Referenced by getSubtitle().

◆ $title

ilCalendarAppointmentTemplate::$title

protected

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

Referenced by getTitle().

◆ $translation_type

ilCalendarAppointmentTemplate::$translation_type = IL_CAL_TRANSLATION_SYSTEM

protected

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

Referenced by getTranslationType().

◆ $type

ilCalendarAppointmentTemplate::$type

protected

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

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

Services/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

◆ $type