Class iCalComponent
A Class for representing components within an iCalendar
Copyright: Catalyst IT Ltd, Morphoss Ltd <http://www.morphoss.com/>
License: GNU GPL v2 or later
Author: Andrew McMillan <andrew@mcmillan.net.nz>
Located at iCalendar.php
public
|
|
public
|
|
public
|
#
CollectParameterValues( mixed $parameter_name )
Collect an array of all parameters of our properties which are the specified type Mainly used for collecting the full variety of references TZIDs |
public
|
|
public
|
#
UnwrapComponent( mixed $content )
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. |
public
|
#
WrapComponent( mixed $content )
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. |
public
|
|
public
|
|
public
|
#
GetProperties( mixed $type = null )
Get all properties, or the properties matching a particular type |
public
string
|
|
public
string
|
#
GetPParamValue( string $type, string $parameter_name )
Get the value of the specified parameter for the first property matching the name. Obviously this isn't so useful for properties which may occur multiply, but most don't. |
public
|
#
ClearProperties( string $type = null )
Clear all properties, or the properties matching a particular type |
public
|
#
SetProperties( mixed $new_properties, mixed $type = null )
Set all properties, or the ones matching a particular type |
public
|
#
AddProperty(
Adds a new property |
public
array
&
|
#
FirstNonTimezone( mixed $type = null )
Get all sub-components, or at least get those matching a type |
public
boolean
|
#
IsOrganizer( string $email )
Return true if the person identified by the email address is down as an organizer for this meeting. |
public
boolean
|
#
IsAttendee( string $email )
Return true if the person identified by the email address is down as an attendee or organizer for this meeting. |
public
array
|
#
GetComponents( string $type = null, boolean $normal_match = true )
Get all sub-components, or at least get those matching a type, or failling to match, should the second parameter be set to false. |
public
|
#
ClearComponents( string $type = null )
Clear all components, or the components matching a particular type |
public
|
#
SetComponents( array $new_component, string $type = null )
Sets some or all sub-components of the component to the supplied new components |
public
|
|
public
|
|
public
|
#
MaskProperties( array $keep, array $component_list = null )
Mask properties, removing any that are not in the list |
public
|
#
CloneConfidential( )
Clone this component (and subcomponents) into a confidential version of it. A confidential event will be scrubbed of any identifying characteristics other than time/date, repeat, uid and a summary which is just a translated 'Busy'. |
public
string
|
#
RenderWithoutWrap( null $restricted_properties = null )
this function supstitute function from vCalendar::RenderWithoutWrap NOTE:
vCalendar::RenderWithoutWrap - return string without \r\n on end |
public
|
|
public
array
|
public
string
|
$type |
|
#
The type of this component, such as 'VEVENT', 'VTODO', 'VTIMEZONE', etc. |
public
array
|
$properties |
|
#
An array of properties, which are iCalProp objects |
public
array
|
$components |
|
#
An array of (sub-)components, which are iCalComponent objects |
public
array
|
$rendered |
|
#
The rendered result (or what was originally parsed, if there have been no changes) |