ILIAS  trunk Revision v11.0_alpha-3011-gc6b235a2e85
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 26 of file class.ilCalendarAppointmentTemplate.php.

Constructor & Destructor Documentation

◆ __construct()

ilCalendarAppointmentTemplate::__construct ( int  $a_id)

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

41 {
42 $this->context_id = $a_id;
43 }

Member Function Documentation

◆ getContextId()

ilCalendarAppointmentTemplate::getContextId ( )

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

156 : int
157 {
158 return $this->context_id;
159 }

References $context_id.

◆ getContextInfo()

ilCalendarAppointmentTemplate::getContextInfo ( )

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

50 : string
51 {
52 return $this->context_info;
53 }

References $context_info.

◆ getDescription()

ilCalendarAppointmentTemplate::getDescription ( )

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

88 : string
89 {
90 return $this->description;
91 }

References $description.

◆ getEnd()

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

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

131 : ?ilDateTime
132 {
133 return $this->end ?: $this->getStart();
134 }
ilDateTime
@classDescription Date and time handling
Definition: class.ilDateTime.php:43

References getStart().

+ Here is the call graph for this function:

◆ getInformation()

ilCalendarAppointmentTemplate::getInformation ( )

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

98 : string
99 {
100 return $this->information;
101 }

References $information.

◆ getLocation()

ilCalendarAppointmentTemplate::getLocation ( )

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

108 : string
109 {
110 return $this->location;
111 }

References $location.

◆ getStart()

ilCalendarAppointmentTemplate::getStart ( )

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

118 : ?ilDateTime
119 {
120 return $this->start;
121 }

References $start.

Referenced by getEnd().

+ Here is the caller graph for this function:

◆ getSubtitle()

ilCalendarAppointmentTemplate::getSubtitle ( )

get subtitle

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

78 : string
79 {
80 return $this->subtitle;
81 }

References $subtitle.

◆ getTitle()

ilCalendarAppointmentTemplate::getTitle ( )

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

60 : string
61 {
62 return $this->title;
63 }

References $title.

◆ getTranslationType()

ilCalendarAppointmentTemplate::getTranslationType ( )

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

151 : int
152 {
153 return $this->translation_type;
154 }

References $translation_type.

◆ isFullday()

ilCalendarAppointmentTemplate::isFullday ( )

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

141 : bool
142 {
143 return $this->fullday;
144 }

References $fullday.

◆ setContextInfo()

ilCalendarAppointmentTemplate::setContextInfo ( string  $a_info)

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

45 : void
46 {
47 $this->context_info = $a_info;
48 }

◆ setDescription()

ilCalendarAppointmentTemplate::setDescription ( string  $a_description)

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

83 : void
84 {
85 $this->description = $a_description;
86 }

◆ setEnd()

ilCalendarAppointmentTemplate::setEnd ( ilDateTime  $end)

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

123 : void
124 {
125 $this->end = $end;
126 }

References $end.

◆ setFullday()

ilCalendarAppointmentTemplate::setFullday ( bool  $a_fullday)

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

136 : void
137 {
138 $this->fullday = $a_fullday;
139 }

◆ setInformation()

ilCalendarAppointmentTemplate::setInformation ( string  $a_information)

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

93 : void
94 {
95 $this->information = $a_information;
96 }

◆ setLocation()

ilCalendarAppointmentTemplate::setLocation ( string  $a_location)

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

103 : void
104 {
105 $this->location = $a_location;
106 }

◆ setStart()

ilCalendarAppointmentTemplate::setStart ( ilDateTime  $start)

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

113 : void
114 {
115 $this->start = $start;
116 }

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

70 : void
71 {
72 $this->subtitle = $a_subtitle;
73 }

◆ setTitle()

ilCalendarAppointmentTemplate::setTitle ( string  $a_title)

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

55 : void
56 {
57 $this->title = $a_title;
58 }

◆ setTranslationType()

ilCalendarAppointmentTemplate::setTranslationType ( int  $a_type)

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

146 : void
147 {
148 $this->translation_type = $a_type;
149 }

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: