vComponentA Class for representing components within an vComponent
Located in /vComponent.php (line 350)
array
$components
(line 374)
An array of (sub-)components, which are vComponent objects
array
$properties
(line 367)
An array of properties, which are vProperty objects
array
$rendered
(line 381)
The rendered result (or what was originally parsed, if there have been no changes)
string
$type
(line 360)
The type of this component, such as 'VEVENT', 'VTODO', 'VTIMEZONE', 'VCARD', etc.
Constructor __construct (line 388)
A basic constructor
AddComponent (line 715)
Adds a new subcomponent
AddProperty (line 621)
Adds a new property
ClearComponents (line 671)
Clear all components, or the components matching a particular type
ClearProperties (line 583)
Clear all properties, or the properties matching a particular type
CollectParameterValues (line 403)
Collect an array of all parameters of our properties which are the specified type
Mainly used for collecting the full variety of references TZIDs
GetComponents (line 646)
Get all sub-components, or at least get those matching a type, or failling to match, should the second parameter be set to false. Component types may be a string or an array associating property names with true values: array( 'TYPE' => true, 'TYPE2' => true )
GetProperties (line 566)
Get all properties, or the properties matching a particular type, or matching an
array associating property names with true values: array( 'PROPERTY' => true, 'PROPERTY2' => true )
GetPropertiesByPath (line 800)
Return an array of properties matching the specified path
GetProperty (line 551)
Return the first instance of a property of this name
GetType (line 533)
Return the type of component which this is
MaskComponents (line 733)
Mask components, removing any that are not of the types in the list
MaskProperties (line 751)
Mask properties, removing any that are not in the list
ParseFrom (line 424)
Parse the text $content into sets of vProperty & vComponent within this vComponent
Render (line 769)
Renders the component, possibly restricted to only the listed properties
SetComponents (line 701)
Sets some or all sub-components of the component to the supplied new components
SetProperties (line 605)
Set all properties, or the ones matching a particular type
SetType (line 541)
Set the type of component which this is
TestFilter (line 853)
Test a PROP-FILTER or COMP-FILTER and return a true/false COMP-FILTER (is-defined | is-not-defined | (time-range?, prop-filter*, comp-filter*)) PROP-FILTER (is-defined | is-not-defined | ((time-range | text-match)?, param-filter*))
UnwrapComponent (line 509)
This unescapes the (CRLF + linear space) wrapping specified in RFC2445. According to RFC2445 we should always end with CRLF but the CalDAV spec says that normalising XML parsers often muck with it and may remove the CR. We accept either case.
WrapComponent (line 521)
This imposes the (CRLF + linear space) wrapping specified in RFC2445. According to RFC2445 we should always end with CRLF but the CalDAV spec says that normalising XML parsers often muck with it and may remove the CR. We output RFC2445 compliance.
In order to preserve pre-existing wrapping in the component, we split the incoming string on line breaks before running wordwrap over each component of that.
Documentation generated on Mon, 20 Sep 2010 12:52:19 +1200 by phpDocumentor 1.4.3