\vjournal

class for calendar component VJOURNAL

properties and functions shared by vcalendar and calendarComponents

Summary

Methods
Properties
Constants
__construct()
createAction()
setAction()
createAttach()
setAttach()
createAttendee()
setAttendee()
createCategories()
setCategories()
createClass()
setClass()
createComment()
setComment()
createCompleted()
setCompleted()
createContact()
setContact()
createCreated()
setCreated()
createDescription()
setDescription()
createDtend()
setDtend()
createDtstamp()
_makeDtstamp()
setDtstamp()
createDtstart()
setDtstart()
createDue()
setDue()
createDuration()
setDuration()
createExdate()
setExdate()
createExrule()
setExrule()
createFreebusy()
setFreebusy()
createGeo()
setGeo()
createLastModified()
setLastModified()
createLocation()
setLocation()
createOrganizer()
setOrganizer()
createPercentComplete()
setPercentComplete()
createPriority()
setPriority()
createRdate()
setRdate()
createRecurrenceid()
setRecurrenceid()
createRelatedTo()
setRelatedTo()
createRepeat()
setRepeat()
createRequestStatus()
setRequestStatus()
createResources()
setResources()
createRrule()
setRrule()
createSequence()
setSequence()
createStatus()
setStatus()
createSummary()
setSummary()
createTransp()
setTransp()
createTrigger()
setTrigger()
createTzid()
setTzid()
createTzname()
setTzname()
createTzoffsetfrom()
setTzoffsetfrom()
createTzoffsetto()
setTzoffsetto()
createTzurl()
setTzurl()
createUid()
_makeUid()
setUid()
createUrl()
setUrl()
_createFormat()
_format_recur()
_notExistProp()
getConfig()
setConfig()
deleteProperty()
deletePropertyM()
getProperty()
_getProperties()
setProperty()
parse()
copy()
deleteComponent()
getComponent()
addSubComponent()
newComponent()
setComponent()
createSubComponent()
createXprop()
setXprop()
createComponent()
$objName
$components
$unparsed
No constants found
_createElement()
_createParams()
$uid
$dtstamp
$xprop
$allowEmpty
$language
$nl
$unique_id
$format
$dtzid
$componentStart1
$componentStart2
$componentEnd1
$componentEnd2
$elementStart1
$elementStart2
$elementEnd1
$elementEnd2
$intAttrDelimiter
$attributeDelimiter
$valueInit
$xcaldecl
$attach
$attendee
$categories
$comment
$contact
$class
$created
$description
$dtstart
$exdate
$exrule
$lastmodified
$organizer
$rdate
$recurrenceid
$relatedto
$requeststatus
$rrule
$sequence
$status
$summary
$url
N/A
No private methods found
No private properties found
N/A

Properties

$objName

$objName : string

Type

string — component type

$components

$components : array

Type

array — container for sub-components

$unparsed

$unparsed : array

Type

array — calendar/components in 'raw' text...

$uid

$uid : array

Type

array — component property UID value

$dtstamp

$dtstamp : array

Type

array — component property DTSTAMP value

$xprop

$xprop : array

Type

array — component property X-property value @access protected

$allowEmpty

$allowEmpty : boolean

Type

boolean — config variable @var string $language config variable @var string $nl config variable @var string $unique_id config variable @var string $format config variable @var string $dtzid config variable @access protected

$language

$language : 

Type

$nl

$nl : 

Type

$unique_id

$unique_id : 

Type

$format

$format : 

Type

$dtzid

$dtzid : 

Type

$componentStart1

$componentStart1 : string

Type

string — valendar/component internal variable @var string $componentStart2 valendar/component internal variable @var string $componentEnd1 valendar/component internal variable @var string $componentEnd2 valendar/component internal variable @var string $elementStart1 valendar/component internal variable @var string $elementStart2 valendar/component internal variable @var string $elementEnd1 valendar/component internal variable @var string $elementEnd2 valendar/component internal variable @var string $intAttrDelimiter valendar/component internal variable @var string $attributeDelimiter valendar/component internal variable @var string $valueInit valendar/component internal variable @access protected

$componentStart2

$componentStart2 : 

Type

$componentEnd1

$componentEnd1 : 

Type

$componentEnd2

$componentEnd2 : 

Type

$elementStart1

$elementStart1 : 

Type

$elementStart2

$elementStart2 : 

Type

$elementEnd1

$elementEnd1 : 

Type

$elementEnd2

$elementEnd2 : 

Type

$intAttrDelimiter

$intAttrDelimiter : 

Type

$attributeDelimiter

$attributeDelimiter : 

Type

$valueInit

$valueInit : 

Type

$xcaldecl

$xcaldecl : array

Type

array — xCal declaration container @access protected

$attach

$attach : array

Type

array — component property value

$attendee

$attendee : 

Type

$categories

$categories : 

Type

$comment

$comment : 

Type

$contact

$contact : 

Type

$class

$class : 

Type

$created

$created : 

Type

$description

$description : 

Type

$dtstart

$dtstart : 

Type

$exdate

$exdate : 

Type

$exrule

$exrule : 

Type

$lastmodified

$lastmodified : 

Type

$organizer

$organizer : 

Type

$rdate

$rdate : 

Type

$recurrenceid

$recurrenceid : 

Type

$relatedto

$relatedto : 

Type

$requeststatus

$requeststatus : 

Type

$rrule

$rrule : 

Type

$sequence

$sequence : 

Type

$status

$status : 

Type

$summary

$summary : 

Type

$url

$url : 

Type

Methods

__construct()

__construct(array  $config = array()) 

constructor for calendar component VJOURNAL object

Parameters

array $config

createAction()

createAction() : string

creates formatted output for calendar component property action

Returns

string

setAction()

setAction(string  $value, mixed  $params = FALSE) : boolean

set calendar component property action

Parameters

string $value

"AUDIO" / "DISPLAY" / "EMAIL" / "PROCEDURE"

mixed $params

Returns

boolean

createAttach()

createAttach() : string

creates formatted output for calendar component property attach

Returns

string

setAttach()

setAttach(string  $value, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property attach

Parameters

string $value
array $params
integer $index

Returns

boolean

createAttendee()

createAttendee() : string

creates formatted output for calendar component property attendee

Returns

string

setAttendee()

setAttendee(string  $value, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property attach

Parameters

string $value
array $params
integer $index

Returns

boolean

createCategories()

createCategories() : string

creates formatted output for calendar component property categories

Returns

string

setCategories()

setCategories(mixed  $value, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property categories

Parameters

mixed $value
array $params
integer $index

Returns

boolean

createClass()

createClass() : string

creates formatted output for calendar component property class

Returns

string

setClass()

setClass(string  $value, array  $params = FALSE) : boolean

set calendar component property class

Parameters

string $value

"PUBLIC" / "PRIVATE" / "CONFIDENTIAL" / iana-token / x-name

array $params

optional

Returns

boolean

createComment()

createComment() : string

creates formatted output for calendar component property comment

Returns

string

setComment()

setComment(string  $value, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property comment

Parameters

string $value
array $params
integer $index

Returns

boolean

createCompleted()

createCompleted() : string

creates formatted output for calendar component property completed

Returns

string

setCompleted()

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

Parameters

mixed $year
mixed $month
integer $day
integer $hour
integer $min
integer $sec
array $params

Returns

boolean

createContact()

createContact() : string

creates formatted output for calendar component property contact

Returns

string

setContact()

setContact(string  $value, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property contact

Parameters

string $value
array $params
integer $index

Returns

boolean

createCreated()

createCreated() : string

creates formatted output for calendar component property created

Returns

string

setCreated()

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

Parameters

mixed $year
mixed $month
integer $day
integer $hour
integer $min
integer $sec
mixed $params

Returns

boolean

createDescription()

createDescription() : string

creates formatted output for calendar component property description

Returns

string

setDescription()

setDescription(string  $value, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property description

Parameters

string $value
array $params
integer $index

Returns

boolean

createDtend()

createDtend() : string

creates formatted output for calendar component property dtend

Returns

string

setDtend()

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

Parameters

mixed $year
mixed $month
integer $day
integer $hour
integer $min
integer $sec
string $tz
array $params

Returns

boolean

createDtstamp()

createDtstamp() : string

creates formatted output for calendar component property dtstamp

Returns

string

_makeDtstamp()

_makeDtstamp() : void

computes datestamp for calendar component object instance dtstamp

setDtstamp()

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

Parameters

mixed $year
mixed $month
integer $day
integer $hour
integer $min
integer $sec
array $params

Returns

TRUE

createDtstart()

createDtstart() : string

creates formatted output for calendar component property dtstart

Returns

string

setDtstart()

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

Parameters

mixed $year
mixed $month
integer $day
integer $hour
integer $min
integer $sec
string $tz
array $params

Returns

boolean

createDue()

createDue() : string

creates formatted output for calendar component property due

Returns

string

setDue()

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

Parameters

mixed $year
mixed $month
integer $day
integer $hour
integer $min
integer $sec
string $tz
array $params

Returns

boolean

createDuration()

createDuration() : string

creates formatted output for calendar component property duration

Returns

string

setDuration()

setDuration(mixed  $week, mixed  $day = FALSE, integer  $hour = FALSE, integer  $min = FALSE, integer  $sec = FALSE, array  $params = FALSE) : boolean

set calendar component property duration

Parameters

mixed $week
mixed $day
integer $hour
integer $min
integer $sec
array $params

Returns

boolean

createExdate()

createExdate() : string

creates formatted output for calendar component property exdate

Returns

string

setExdate()

setExdate(array  $exdates, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property exdate

Parameters

array $exdates
array $params
integer $index

Returns

boolean

createExrule()

createExrule() : string

creates formatted output for calendar component property exrule

Returns

string

setExrule()

setExrule(array  $exruleset, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property exdate

Parameters

array $exruleset
array $params
integer $index

Returns

boolean

createFreebusy()

createFreebusy() : string

creates formatted output for calendar component property freebusy

Returns

string

setFreebusy()

setFreebusy(string  $fbType, array  $fbValues, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property freebusy

Parameters

string $fbType
array $fbValues
array $params
integer $index

Returns

boolean

createGeo()

createGeo() : string

creates formatted output for calendar component property geo

Returns

string

setGeo()

setGeo(mixed  $latitude, mixed  $longitude, array  $params = FALSE) : boolean

set calendar component property geo

Parameters

mixed $latitude
mixed $longitude
array $params

Returns

boolean

createLastModified()

createLastModified() : string

creates formatted output for calendar component property last-modified

Returns

string

setLastModified()

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

Parameters

mixed $year

optional

mixed $month

optional

integer $day

optional

integer $hour

optional

integer $min

optional

integer $sec

optional

array $params

optional

Returns

\boll

createLocation()

createLocation() : string

creates formatted output for calendar component property location

Returns

string

setLocation()

setLocation(string  $value, array  $params = FALSE) : boolean

set calendar component property location '

Parameters

string $value
array $params

Returns

boolean

createOrganizer()

createOrganizer() : string

creates formatted output for calendar component property organizer

Returns

string

setOrganizer()

setOrganizer(string  $value, array  $params = FALSE) : boolean

set calendar component property organizer

Parameters

string $value
array $params

Returns

boolean

createPercentComplete()

createPercentComplete() : string

creates formatted output for calendar component property percent-complete

Returns

string

setPercentComplete()

setPercentComplete(integer  $value, array  $params = FALSE) : boolean

set calendar component property percent-complete

Parameters

integer $value
array $params

Returns

boolean

createPriority()

createPriority() : string

creates formatted output for calendar component property priority

Returns

string

setPriority()

setPriority(integer  $value, array  $params = FALSE) : boolean

set calendar component property priority

Parameters

integer $value
array $params

Returns

boolean

createRdate()

createRdate() : string

creates formatted output for calendar component property rdate

Returns

string

setRdate()

setRdate(array  $rdates, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property rdate

Parameters

array $rdates
array $params
integer $index

Returns

boolean

createRecurrenceid()

createRecurrenceid() : string

creates formatted output for calendar component property recurrence-id

Returns

string

setRecurrenceid()

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

Parameters

mixed $year
mixed $month
integer $day
integer $hour
integer $min
integer $sec
string $tz
array $params

Returns

boolean

createRelatedTo()

createRelatedTo() : string

creates formatted output for calendar component property related-to

Returns

string

setRelatedTo()

setRelatedTo(string  $value, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property related-to

Parameters

string $value
array $params
integer $index

Returns

boolean

createRepeat()

createRepeat() : string

creates formatted output for calendar component property repeat

Returns

string

setRepeat()

setRepeat(string  $value, array  $params = FALSE) : void

set calendar component property repeat

Parameters

string $value
array $params

createRequestStatus()

createRequestStatus() : string

creates formatted output for calendar component property request-status

Returns

string

setRequestStatus()

setRequestStatus(float  $statcode, string  $text, string  $extdata = FALSE, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property request-status

Parameters

float $statcode
string $text
string $extdata
array $params
integer $index

Returns

boolean

createResources()

createResources() : string

creates formatted output for calendar component property resources

Returns

string

setResources()

setResources(mixed  $value, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property recources

Parameters

mixed $value
array $params
integer $index

Returns

boolean

createRrule()

createRrule() : string

creates formatted output for calendar component property rrule

Returns

string

setRrule()

setRrule(array  $rruleset, array  $params = FALSE, integer  $index = FALSE) : void

set calendar component property rrule

Parameters

array $rruleset
array $params
integer $index

createSequence()

createSequence() : string

creates formatted output for calendar component property sequence

Returns

string

setSequence()

setSequence(integer  $value = FALSE, array  $params = FALSE) : boolean

set calendar component property sequence

Parameters

integer $value
array $params

Returns

boolean

createStatus()

createStatus() : string

creates formatted output for calendar component property status

Returns

string

setStatus()

setStatus(string  $value, array  $params = FALSE) : boolean

set calendar component property status

Parameters

string $value
array $params

Returns

boolean

createSummary()

createSummary() : string

creates formatted output for calendar component property summary

Returns

string

setSummary()

setSummary(string  $value, string  $params = FALSE) : boolean

set calendar component property summary

Parameters

string $value
string $params

Returns

boolean

createTransp()

createTransp() : string

creates formatted output for calendar component property transp

Returns

string

setTransp()

setTransp(string  $value, string  $params = FALSE) : boolean

set calendar component property transp

Parameters

string $value
string $params

Returns

boolean

createTrigger()

createTrigger() : string

creates formatted output for calendar component property trigger

Returns

string

setTrigger()

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

Parameters

mixed $year
mixed $month
integer $day
integer $week
integer $hour
integer $min
integer $sec
boolean $relatedStart
boolean $before
array $params

Returns

boolean

createTzid()

createTzid() : string

creates formatted output for calendar component property tzid

Returns

string

setTzid()

setTzid(string  $value, array  $params = FALSE) : boolean

set calendar component property tzid

Parameters

string $value
array $params

Returns

boolean

createTzname()

createTzname() : string

creates formatted output for calendar component property tzname

Returns

string

setTzname()

setTzname(string  $value, array  $params = FALSE, integer  $index = FALSE) : boolean

set calendar component property tzname

Parameters

string $value
array $params
integer $index

Returns

boolean

createTzoffsetfrom()

createTzoffsetfrom() : string

creates formatted output for calendar component property tzoffsetfrom

Returns

string

setTzoffsetfrom()

setTzoffsetfrom(string  $value, array  $params = FALSE) : boolean

set calendar component property tzoffsetfrom

Parameters

string $value
array $params

Returns

boolean

createTzoffsetto()

createTzoffsetto() : string

creates formatted output for calendar component property tzoffsetto

Returns

string

setTzoffsetto()

setTzoffsetto(string  $value, array  $params = FALSE) : boolean

set calendar component property tzoffsetto

Parameters

string $value
array $params

Returns

boolean

createTzurl()

createTzurl() : string

creates formatted output for calendar component property tzurl

Returns

string

setTzurl()

setTzurl(string  $value, array  $params = FALSE) : \boll

set calendar component property tzurl

Parameters

string $value
array $params

Returns

\boll

createUid()

createUid() : string

creates formatted output for calendar component property uid

Returns

string

_makeUid()

_makeUid() : void

create an unique id for this calendar component object instance

setUid()

setUid(string  $value, array  $params = FALSE) : boolean

set calendar component property uid

Parameters

string $value
array $params

Returns

boolean

createUrl()

createUrl() : string

creates formatted output for calendar component property url

Returns

string

setUrl()

setUrl(string  $value, array  $params = FALSE) : boolean

set calendar component property url

Parameters

string $value
array $params

Returns

boolean

_createFormat()

_createFormat() : boolean

create element format parts

Returns

boolean

_format_recur()

_format_recur(array  $recurlabel, array  $recurdata) : string

creates formatted output for calendar component property data value type recur

Parameters

array $recurlabel
array $recurdata

Returns

string

_notExistProp()

_notExistProp(string  $propName) : boolean

check if property not exists within component

Parameters

string $propName

Returns

boolean

getConfig()

getConfig(mixed  $config = FALSE) : \value

get general component config variables or info about subcomponents

Parameters

mixed $config

Returns

\value

setConfig()

setConfig(mixed  $config, string  $value = FALSE, boolean  $softUpdate = FALSE) : void

general component config setting

Parameters

mixed $config
string $value
boolean $softUpdate

deleteProperty()

deleteProperty(mixed  $propName = FALSE, integer  $propix = FALSE) : \bool,

delete component property value

Parameters

mixed $propName

bool FALSE => X-property

integer $propix

specific property in case of multiply occurences

Returns

\bool, —

if successfull delete TRUE

deletePropertyM()

deletePropertyM(array  $multiprop, integer  $propix) : boolean

delete component property value, fixing components with multiple occurencies

Parameters

array $multiprop

component (multi-)property

integer $propix

removal counter

Returns

boolean —

TRUE

getProperty()

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

Parameters

string $propName
integer $propix

specific property in case of multiply occurences

boolean $inclParam
boolean $specform

Returns

mixed

_getProperties()

_getProperties(string  $propName, array  $output) 

returns calendar property unique values for 'ATTENDEE', 'CATEGORIES', 'CONTACT', 'RELATED-TO' or 'RESOURCES' and for each, number of occurrence

Parameters

string $propName
array $output

incremented result array

setProperty()

setProperty() : void

general component property setting

parse()

parse(mixed  $unparsedtext = null) : boolean

parse component unparsed data into properties

Parameters

mixed $unparsedtext

strict rfc2445 formatted, single property string or array of strings

Returns

boolean —

FALSE if error occurs during parsing

copy()

copy() : object

return a copy of this component

Returns

object

deleteComponent()

deleteComponent(mixed  $arg1, mixed  $arg2 = FALSE) : void

delete calendar subcomponent from component container

Parameters

mixed $arg1

ordno / component type / component uid

mixed $arg2

ordno if arg1 = component type

getComponent()

getComponent(mixed  $arg1 = FALSE, mixed  $arg2 = FALSE) : object

get calendar component subcomponent from component container

Parameters

mixed $arg1

ordno/component type/ component uid

mixed $arg2

ordno if arg1 = component type

Returns

object

addSubComponent()

addSubComponent(object  $component) : void

add calendar component as subcomponent to container for subcomponents

Parameters

object $component

calendar component

newComponent()

newComponent(string  $compType) : object

create new calendar component subcomponent, already included within component

Parameters

string $compType

subcomponent type

Returns

object —

(reference)

setComponent()

setComponent(object  $component, mixed  $arg1 = FALSE, mixed  $arg2 = FALSE) : boolean

add calendar component as subcomponent to container for subcomponents

Parameters

object $component

calendar component

mixed $arg1

ordno/component type/ component uid

mixed $arg2

ordno if arg1 = component type

Returns

boolean

createSubComponent()

createSubComponent() : string

creates formatted output for subcomponents

Returns

string

createXprop()

createXprop() : string

creates formatted output for calendar/component property x-prop

Returns

string

setXprop()

setXprop(string  $label, string  $value, array  $params = FALSE) : boolean

set calendar property x-prop

Parameters

string $label
string $value
array $params

optional

Returns

boolean

createComponent()

createComponent(array  $xcaldecl) : string

create formatted output for calendar component VJOURNAL object instance

Parameters

array $xcaldecl

Returns

string

_createElement()

_createElement(string  $label, string  $attributes = null, string  $content = FALSE) : string

creates formatted output for calendar component property

Parameters

string $label

property name

string $attributes

property attributes

string $content

property content (optional)

Returns

string

_createParams()

_createParams(array  $params = array(), array  $ctrKeys = array()) : string

creates formatted output for calendar component property parameters

Parameters

array $params

optional

array $ctrKeys

optional

Returns

string