vComponent
A Class for representing components within an vComponent
Located in /vComponent.php (line 376)
| Class | Description |
|---|---|
VCalendar
|
A Class for representing components within an vComponent |
array
$components
(line 400)
An array of (sub-)components, which are vComponent objects
array
$properties
(line 393)
An array of properties, which are vProperty objects
array
$rendered
(line 407)
The rendered result (or what was originally parsed, if there have been no changes)
string
$type
(line 386)
The type of this component, such as 'VEVENT', 'VTODO', 'VTIMEZONE', 'VCARD', etc.
Constructor __construct (line 414)
A basic constructor
- $content
- VCalendar::__construct() : Constructor. If a string is passed it will be parsed as if it was an iCalendar object, otherwise a new vCalendar will be initialised with basic content. If an array of key value pairs is provided they will also be used as top-level properties.
AddComponent (line 762)
Adds a new subcomponent
- vComponent $new_component: The new component to append to the set
AddProperty (line 660)
Adds a new property
- vProperty $new_property: The new property to append to the set, or a string with the name
- string $value: The value of the new property (default: param 1 is an vProperty with everything
- array $parameters: The key/value parameter pairs (default: none, or param 1 is an vProperty with everything)
ClearComponents (line 718)
Clear all components, or the components matching a particular type
- string $type: The type of component - omit for all components
ClearProperties (line 622)
Clear all properties, or the properties matching a particular type
- string|array $type: The type of property - omit for all properties - or an array associating property names with true values: array( 'PROPERTY' => true, 'PROPERTY2' => true )
CollectParameterValues (line 429)
Collect an array of all parameters of our properties which are the specified type
Mainly used for collecting the full variety of references TZIDs
- $parameter_name
ComponentCount (line 679)
Return number of components
GetComponents (line 693)
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 )
- mixed $type: The type(s) to match (default: All)
- boolean $normal_match: Set to false to invert the match (default: true)
GetProperties (line 605)
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 )
- $type
GetPropertiesByPath (line 854)
Return an array of properties matching the specified path
- $path
GetProperty (line 577)
Return the first instance of a property of this name
- $type
GetPValue (line 594)
Return the value of the first instance of a property of this name, or null
- $type
GetType (line 559)
Return the type of component which this is
MaskComponents (line 780)
Mask components, removing any that are not of the types in the list
- array $keep: An array of component types to be kept
MaskProperties (line 798)
Mask properties, removing any that are not in the list
- array $keep: An array of property names to be kept
- array $component_list: An array of component types to check within
ParseFrom (line 450)
Parse the text $content into sets of vProperty & vComponent within this vComponent
- string $content: The raw RFC2445-compliant vComponent component, including BEGIN:TYPE & END:TYPE
Render (line 816)
Renders the component, possibly restricted to only the listed properties
- $restricted_properties
SetComponents (line 748)
Sets some or all sub-components of the component to the supplied new components
- string $type: The type of components to be replaced. Defaults to null, which means all components will be replaced.
- array $new_component: of vComponent $new_components The new components to replace the existing ones
SetProperties (line 644)
Set all properties, or the ones matching a particular type
- $new_properties
- $type
SetType (line 567)
Set the type of component which this is
- $type
TestFilter (line 907)
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*))
- array $filter: An array of XMLElement defining the filter
- $filters
UnwrapComponent (line 535)
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.
- $content
WrapComponent (line 547)
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.
- $content
__toString (line 840)
Documentation generated on Tue, 13 Sep 2011 13:14:51 +1200 by phpDocumentor 1.4.3