ILIAS  release_8 Revision v8.24
Public Member Functions | Protected Attributes
ilCalendarAppointmentTemplate Class Reference
Services/Calendar

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

Constructor & Destructor Documentation

◆ __construct()

ilCalendarAppointmentTemplate::__construct ( int  $a_id)

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

47 {
48 $this->context_id = $a_id;
49 }

Member Function Documentation

◆ getContextId()

ilCalendarAppointmentTemplate::getContextId ( )

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

162 : int
163 {
164 return $this->context_id;
165 }

References $context_id.

◆ getContextInfo()

ilCalendarAppointmentTemplate::getContextInfo ( )

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

56 : string
57 {
58 return $this->context_info;
59 }

References $context_info.

◆ getDescription()

ilCalendarAppointmentTemplate::getDescription ( )

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

94 : string
95 {
96 return $this->description;
97 }

References $description.

◆ getEnd()

ilCalendarAppointmentTemplate::getEnd ( )
Todo:
check if this is required

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

137 : ?ilDateTime
138 {
139 return $this->end ?: $this->getStart();
140 }
ilDateTime
@classDescription Date and time handling
Definition: class.ilDateTime.php:29

References getStart().

+ Here is the call graph for this function:

◆ getInformation()

ilCalendarAppointmentTemplate::getInformation ( )

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

104 : string
105 {
106 return $this->information;
107 }

References $information.

◆ getLocation()

ilCalendarAppointmentTemplate::getLocation ( )

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

114 : string
115 {
116 return $this->location;
117 }

References $location.

◆ getStart()

ilCalendarAppointmentTemplate::getStart ( )

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

124 : ?ilDateTime
125 {
126 return $this->start;
127 }

References $start.

Referenced by getEnd().

+ Here is the caller graph for this function:

◆ getSubtitle()

ilCalendarAppointmentTemplate::getSubtitle ( )

get subtitle

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

84 : string
85 {
86 return $this->subtitle;
87 }

References $subtitle.

◆ getTitle()

ilCalendarAppointmentTemplate::getTitle ( )

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

66 : string
67 {
68 return $this->title;
69 }

References $title.

◆ getTranslationType()

ilCalendarAppointmentTemplate::getTranslationType ( )

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

157 : int
158 {
159 return $this->translation_type;
160 }

References $translation_type.

◆ isFullday()

ilCalendarAppointmentTemplate::isFullday ( )

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

147 : bool
148 {
149 return $this->fullday;
150 }

References $fullday.

◆ setContextInfo()

ilCalendarAppointmentTemplate::setContextInfo ( string  $a_info)

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

51 : void
52 {
53 $this->context_info = $a_info;
54 }

◆ setDescription()

ilCalendarAppointmentTemplate::setDescription ( string  $a_description)

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

89 : void
90 {
91 $this->description = $a_description;
92 }

◆ setEnd()

ilCalendarAppointmentTemplate::setEnd ( ilDateTime  $end)

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

129 : void
130 {
131 $this->end = $end;
132 }

References $end.

◆ setFullday()

ilCalendarAppointmentTemplate::setFullday ( bool  $a_fullday)

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

142 : void
143 {
144 $this->fullday = $a_fullday;
145 }

◆ setInformation()

ilCalendarAppointmentTemplate::setInformation ( string  $a_information)

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

99 : void
100 {
101 $this->information = $a_information;
102 }

◆ setLocation()

ilCalendarAppointmentTemplate::setLocation ( string  $a_location)

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

109 : void
110 {
111 $this->location = $a_location;
112 }

◆ setStart()

ilCalendarAppointmentTemplate::setStart ( ilDateTime  $start)

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

119 : void
120 {
121 $this->start = $start;
122 }

References $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 76 of file class.ilCalendarAppointmentTemplate.php.

76 : void
77 {
78 $this->subtitle = $a_subtitle;
79 }

◆ setTitle()

ilCalendarAppointmentTemplate::setTitle ( string  $a_title)

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

61 : void
62 {
63 $this->title = $a_title;
64 }

◆ setTranslationType()

ilCalendarAppointmentTemplate::setTranslationType ( int  $a_type)

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

152 : void
153 {
154 $this->translation_type = $a_type;
155 }

Field Documentation

◆ $context_id

int ilCalendarAppointmentTemplate::$context_id = 0
protected

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

Referenced by getContextId().

◆ $context_info

string ilCalendarAppointmentTemplate::$context_info = ''
protected

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

Referenced by getContextInfo().

◆ $description

string ilCalendarAppointmentTemplate::$description = ''
protected

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

Referenced by getDescription().

◆ $end

ilDateTime ilCalendarAppointmentTemplate::$end = null
protected

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

Referenced by setEnd().

◆ $fullday

bool ilCalendarAppointmentTemplate::$fullday = false
protected

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

Referenced by isFullday().

◆ $information

string ilCalendarAppointmentTemplate::$information = ''
protected

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

Referenced by getInformation().

◆ $location

string ilCalendarAppointmentTemplate::$location = ''
protected

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

Referenced by getLocation().

◆ $start

ilDateTime ilCalendarAppointmentTemplate::$start = null
protected

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

Referenced by getStart(), and setStart().

◆ $subtitle

string ilCalendarAppointmentTemplate::$subtitle = ''
protected

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

Referenced by getSubtitle().

◆ $title

string ilCalendarAppointmentTemplate::$title = ''
protected

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

Referenced by getTitle().

◆ $translation_type

int ilCalendarAppointmentTemplate::$translation_type = ilCalendarEntry::TRANSLATION_SYSTEM
protected

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

Referenced by getTranslationType().

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