ILIAS  release_5-2 Revision v5.2.25-18-g3f80b82851
ilCalendarAppointmentTemplate Class Reference

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

+ Collaboration diagram for ilCalendarAppointmentTemplate:

Public Member Functions

 __construct ($a_id)
 Constructor. 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
 
 $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
intunique id

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

62  {
63  $this->context_id = $a_id;
64  }

Member Function Documentation

◆ getContextId()

ilCalendarAppointmentTemplate::getContextId ( )

get context id

public

Returns

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

References $context_id.

◆ getDescription()

ilCalendarAppointmentTemplate::getDescription ( )

get description

public

Returns
strin description

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

References $description.

◆ getEnd()

ilCalendarAppointmentTemplate::getEnd ( )

get end

public

Returns
ilDateTime end

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

References getStart().

221  {
222  return $this->end ? $this->end : $this->getStart();
223  }
+ Here is the call graph for this function:

◆ getInformation()

ilCalendarAppointmentTemplate::getInformation ( )

get information

public

Returns
string information

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

References $information.

◆ getLocation()

ilCalendarAppointmentTemplate::getLocation ( )

get location

public

Returns
string location

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

References $location.

◆ getStart()

ilCalendarAppointmentTemplate::getStart ( )

get start

public

Returns
ilDateTime start

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

References $start.

Referenced by getEnd().

+ Here is the caller graph for this function:

◆ getSubtitle()

ilCalendarAppointmentTemplate::getSubtitle ( )

get subtitle

public

Returns
string subtitle

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

References $subtitle.

◆ getTitle()

ilCalendarAppointmentTemplate::getTitle ( )

get title

public

Returns
string title

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

References $title.

◆ getTranslationType()

ilCalendarAppointmentTemplate::getTranslationType ( )

get translation type

public

Parameters

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

References $translation_type.

◆ isFullday()

ilCalendarAppointmentTemplate::isFullday ( )

is fullday

public

Returns
bool true if fullday event

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

References $fullday.

◆ setDescription()

ilCalendarAppointmentTemplate::setDescription (   $a_description)

get description

public

Parameters
stringdescription

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

120  {
121  $this->description = $a_description;
122  }

◆ setEnd()

ilCalendarAppointmentTemplate::setEnd ( ilDateTime  $end)

set end

public

Parameters
ilDateTimeend

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

References $end.

210  {
211  $this->end = $end;
212  }

◆ setFullday()

ilCalendarAppointmentTemplate::setFullday (   $a_fullday)

set fullday

public

Parameters
boolfullday appointment
Returns

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

233  {
234  $this->fullday = $a_fullday;
235  }

◆ setInformation()

ilCalendarAppointmentTemplate::setInformation (   $a_information)

set information

public

Parameters
stringinformation

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

142  {
143  $this->information = $a_information;
144  }

◆ setLocation()

ilCalendarAppointmentTemplate::setLocation (   $a_location)

set location

public

Parameters
strin$a_locationlocation
Returns

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

165  {
166  $this->location = $a_location;
167  }

◆ setStart()

ilCalendarAppointmentTemplate::setStart ( ilDateTime  $start)

set start

public

Parameters
ilDateTimestart
Returns

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

References $start.

188  {
189  $this->start = $start;
190  }

◆ setSubtitle()

ilCalendarAppointmentTemplate::setSubtitle (   $a_subtitle)

set subtitle Used for automatic generated appointments.

Will be translated automatically and be appended to the title.

public

Parameters
stringsubtitle
Returns
void

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

98  {
99  $this->subtitle = $a_subtitle;
100  }

◆ setTitle()

ilCalendarAppointmentTemplate::setTitle (   $a_title)

set title

public

Parameters
stringappointment title

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

73  {
74  $this->title = $a_title;
75  }

◆ setTranslationType()

ilCalendarAppointmentTemplate::setTranslationType (   $a_type)

set translation type

public

Parameters

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

References $a_type.

256  {
257  $this->translation_type = $a_type;
258  }
$a_type
Definition: workflow.php:93

Field Documentation

◆ $context_id

ilCalendarAppointmentTemplate::$context_id
protected

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

Referenced by getContextId().

◆ $description

ilCalendarAppointmentTemplate::$description
protected

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

Referenced by getDescription().

◆ $end

ilCalendarAppointmentTemplate::$end
protected

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

Referenced by setEnd().

◆ $fullday

ilCalendarAppointmentTemplate::$fullday = false
protected

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

Referenced by isFullday().

◆ $information

ilCalendarAppointmentTemplate::$information
protected

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

Referenced by getInformation().

◆ $location

ilCalendarAppointmentTemplate::$location
protected

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

Referenced by getLocation().

◆ $start

ilCalendarAppointmentTemplate::$start
protected

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

Referenced by getStart(), and setStart().

◆ $subtitle

ilCalendarAppointmentTemplate::$subtitle
protected

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

Referenced by getSubtitle().

◆ $title

ilCalendarAppointmentTemplate::$title
protected

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

Referenced by getTitle().

◆ $translation_type

ilCalendarAppointmentTemplate::$translation_type = IL_CAL_TRANSLATION_SYSTEM
protected

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

Referenced by getTranslationType().

◆ $type

ilCalendarAppointmentTemplate::$type
protected

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


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