ILIAS  Release_4_0_x_branch Revision 61816
 All Data Structures Namespaces Files Functions Variables Groups Pages
ilCalendarAppointmentTemplate Class Reference

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

+ Collaboration diagram for ilCalendarAppointmentTemplate:

Public Member Functions

 __construct ($a_id)
 Constructor.
 setTitle ($a_title)
 set title
 getTitle ()
 get title
 setSubtitle ($a_subtitle)
 set subtitle Used for automatic generated appointments.
 getSubtitle ()
 get subtitle
 setDescription ($a_description)
 get description
 getDescription ()
 get description
 setInformation ($a_information)
 set information
 getInformation ()
 get information
 setLocation ($a_location)
 set location
 getLocation ()
 get location
 setStart (ilDateTime $start)
 set start
 getStart ()
 get start
 setEnd (ilDateTime $end)
 set end
 getEnd ()
 get end
 setFullday ($a_fullday)
 set fullday
 isFullday ()
 is fullday
 setTranslationType ($a_type)
 set translation type
 getTranslationType ()
 get translation type
 getContextId ()
 get context id

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

ilCalendarAppointmentTemplate::__construct (   $a_id)

Constructor.

public

Parameters
intunique id

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

{
$this->context_id = $a_id;
}

Member Function Documentation

ilCalendarAppointmentTemplate::getContextId ( )

get context id

public

Returns

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

References $context_id.

{
}
ilCalendarAppointmentTemplate::getDescription ( )

get description

public

Returns
strin description

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

References $description.

{
}
ilCalendarAppointmentTemplate::getEnd ( )

get end

public

Returns
ilDateTime end

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

References getStart().

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

+ Here is the call graph for this function:

ilCalendarAppointmentTemplate::getInformation ( )

get information

public

Returns
string information

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

References $information.

{
}
ilCalendarAppointmentTemplate::getLocation ( )

get location

public

Returns
string location

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

References $location.

{
}
ilCalendarAppointmentTemplate::getStart ( )

get start

public

Returns
ilDateTime start

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

References $start.

Referenced by getEnd().

{
return $this->start;
}

+ Here is the caller graph for this function:

ilCalendarAppointmentTemplate::getSubtitle ( )

get subtitle

public

Returns
string subtitle

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

References $subtitle.

{
}
ilCalendarAppointmentTemplate::getTitle ( )

get title

public

Returns
string title

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

References $title.

{
return $this->title;
}
ilCalendarAppointmentTemplate::getTranslationType ( )

get translation type

public

Parameters
@return

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

References $translation_type.

ilCalendarAppointmentTemplate::isFullday ( )

is fullday

public

Returns
bool true if fullday event

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

References $fullday.

{
}
ilCalendarAppointmentTemplate::setDescription (   $a_description)

get description

public

Parameters
stringdescription

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

{
$this->description = $a_description;
}
ilCalendarAppointmentTemplate::setEnd ( ilDateTime  $end)

set end

public

Parameters
ilDateTimeend

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

References $end.

{
$this->end = $end;
}
ilCalendarAppointmentTemplate::setFullday (   $a_fullday)

set fullday

public

Parameters
boolfullday appointment
Returns

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

{
$this->fullday = $a_fullday;
}
ilCalendarAppointmentTemplate::setInformation (   $a_information)

set information

public

Parameters
stringinformation

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

{
$this->information = $a_information;
}
ilCalendarAppointmentTemplate::setLocation (   $a_location)

set location

public

Parameters
strin$a_locationlocation
Returns

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

{
$this->location = $a_location;
}
ilCalendarAppointmentTemplate::setStart ( ilDateTime  $start)

set start

public

Parameters
ilDateTimestart
Returns

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

References $start.

{
$this->start = $start;
}
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.

{
$this->subtitle = $a_subtitle;
}
ilCalendarAppointmentTemplate::setTitle (   $a_title)

set title

public

Parameters
stringappointment title

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

{
$this->title = $a_title;
}
ilCalendarAppointmentTemplate::setTranslationType (   $a_type)

set translation type

public

Parameters
@return

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

{
$this->translation_type = $a_type;
}

Field Documentation

ilCalendarAppointmentTemplate::$context_id
protected

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

Referenced by getContextId().

ilCalendarAppointmentTemplate::$description
protected

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

Referenced by getDescription().

ilCalendarAppointmentTemplate::$end
protected

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

Referenced by setEnd().

ilCalendarAppointmentTemplate::$fullday = false
protected

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

Referenced by isFullday().

ilCalendarAppointmentTemplate::$information
protected

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

Referenced by getInformation().

ilCalendarAppointmentTemplate::$location
protected

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

Referenced by getLocation().

ilCalendarAppointmentTemplate::$start
protected

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

Referenced by getStart(), and setStart().

ilCalendarAppointmentTemplate::$subtitle
protected

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

Referenced by getSubtitle().

ilCalendarAppointmentTemplate::$title
protected

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

Referenced by getTitle().

ilCalendarAppointmentTemplate::$translation_type = IL_CAL_TRANSLATION_SYSTEM
protected

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

Referenced by getTranslationType().

ilCalendarAppointmentTemplate::$type
protected

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


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