$objName
$objName : string
class for calendar component VEVENT
properties and functions shared by vcalendar and calendarComponents
$componentStart1 : string
setCompleted(mixed $year, mixed $month = FALSE, integer $day = FALSE, integer $hour = FALSE, integer $min = FALSE, integer $sec = FALSE, array $params = FALSE) : boolean
set calendar component property completed
mixed | $year | |
mixed | $month | |
integer | $day | |
integer | $hour | |
integer | $min | |
integer | $sec | |
array | $params |
setCreated(mixed $year = FALSE, mixed $month = FALSE, integer $day = FALSE, integer $hour = FALSE, integer $min = FALSE, integer $sec = FALSE, mixed $params = FALSE) : boolean
set calendar component property created
mixed | $year | |
mixed | $month | |
integer | $day | |
integer | $hour | |
integer | $min | |
integer | $sec | |
mixed | $params |
setDtend(mixed $year, mixed $month = FALSE, integer $day = FALSE, integer $hour = FALSE, integer $min = FALSE, integer $sec = FALSE, string $tz = FALSE, array $params = FALSE) : boolean
set calendar component property dtend
mixed | $year | |
mixed | $month | |
integer | $day | |
integer | $hour | |
integer | $min | |
integer | $sec | |
string | $tz | |
array | $params |
setDtstamp(mixed $year, mixed $month = FALSE, integer $day = FALSE, integer $hour = FALSE, integer $min = FALSE, integer $sec = FALSE, array $params = FALSE) : TRUE
set calendar component property dtstamp
mixed | $year | |
mixed | $month | |
integer | $day | |
integer | $hour | |
integer | $min | |
integer | $sec | |
array | $params |
setDtstart(mixed $year, mixed $month = FALSE, integer $day = FALSE, integer $hour = FALSE, integer $min = FALSE, integer $sec = FALSE, string $tz = FALSE, array $params = FALSE) : boolean
set calendar component property dtstart
mixed | $year | |
mixed | $month | |
integer | $day | |
integer | $hour | |
integer | $min | |
integer | $sec | |
string | $tz | |
array | $params |
setDue(mixed $year, mixed $month = FALSE, integer $day = FALSE, integer $hour = FALSE, integer $min = FALSE, integer $sec = FALSE, string $tz = FALSE, array $params = FALSE) : boolean
set calendar component property due
mixed | $year | |
mixed | $month | |
integer | $day | |
integer | $hour | |
integer | $min | |
integer | $sec | |
string | $tz | |
array | $params |
setDuration(mixed $week, mixed $day = FALSE, integer $hour = FALSE, integer $min = FALSE, integer $sec = FALSE, array $params = FALSE) : boolean
set calendar component property duration
mixed | $week | |
mixed | $day | |
integer | $hour | |
integer | $min | |
integer | $sec | |
array | $params |
setLastModified(mixed $year = FALSE, mixed $month = FALSE, integer $day = FALSE, integer $hour = FALSE, integer $min = FALSE, integer $sec = FALSE, array $params = FALSE) : \boll
set calendar component property completed
mixed | $year | optional |
mixed | $month | optional |
integer | $day | optional |
integer | $hour | optional |
integer | $min | optional |
integer | $sec | optional |
array | $params | optional |
setRecurrenceid(mixed $year, mixed $month = FALSE, integer $day = FALSE, integer $hour = FALSE, integer $min = FALSE, integer $sec = FALSE, string $tz = FALSE, array $params = FALSE) : boolean
set calendar component property recurrence-id
mixed | $year | |
mixed | $month | |
integer | $day | |
integer | $hour | |
integer | $min | |
integer | $sec | |
string | $tz | |
array | $params |
setTrigger(mixed $year, mixed $month = null, integer $day = null, integer $week = FALSE, integer $hour = FALSE, integer $min = FALSE, integer $sec = FALSE, boolean $relatedStart = TRUE, boolean $before = TRUE, array $params = FALSE) : boolean
set calendar component property trigger
mixed | $year | |
mixed | $month | |
integer | $day | |
integer | $week | |
integer | $hour | |
integer | $min | |
integer | $sec | |
boolean | $relatedStart | |
boolean | $before | |
array | $params |
getProperty(string $propName = FALSE, integer $propix = FALSE, boolean $inclParam = FALSE, boolean $specform = FALSE) : mixed
get component property value/params
if property has multiply values, consequtive function calls are needed
string | $propName | |
integer | $propix | specific property in case of multiply occurences |
boolean | $inclParam | |
boolean | $specform |
setComponent(object $component, mixed $arg1 = FALSE, mixed $arg2 = FALSE) : boolean
add calendar component as subcomponent to container for subcomponents
object | $component | calendar component |
mixed | $arg1 | ordno/component type/ component uid |
mixed | $arg2 | ordno if arg1 = component type |
_createElement(string $label, string $attributes = null, string $content = FALSE) : string
creates formatted output for calendar component property
string | $label | property name |
string | $attributes | property attributes |
string | $content | property content (optional) |