Andrew's Web Libraries (AWL)
|
Public Member Functions | |
__construct ( $content=null) | |
VCalendar ( $extra_properties=null) | |
CollectParameterValues ( $parameter_name) | |
ParseFrom ( $content) | |
UnwrapComponent ( $content) | |
WrapComponent ( $content) | |
GetType () | |
SetType ( $type) | |
GetProperties ( $type=null) | |
GetPValue ( $type) | |
GetPParamValue ( $type, $parameter_name) | |
ClearProperties ( $type=null) | |
SetProperties ( $new_properties, $type=null) | |
AddProperty ( $new_property, $value=null, $parameters=null) | |
& | FirstNonTimezone ( $type=null) |
IsOrganizer ( $email) | |
IsAttendee ( $email) | |
GetComponents ( $type=null, $normal_match=true) | |
ClearComponents ( $type=null) | |
SetComponents ( $new_component, $type=null) | |
AddComponent ( $new_component) | |
MaskComponents ( $keep) | |
MaskProperties ( $keep, $component_list=null) | |
CloneConfidential () | |
RenderWithoutWrap ($restricted_properties=null) | |
Render ( $restricted_properties=null) | |
GetPropertiesByPath ( $path) | |
Public Attributes | |
$type | |
$properties | |
$components | |
$rendered | |
Definition at line 316 of file iCalendar.php.
iCalComponent::__construct | ( | $content = null | ) |
#- A basic constructor
Definition at line 354 of file iCalendar.php.
iCalComponent::AddComponent | ( | $new_component | ) |
Adds a new subcomponent
iCalComponent | $new_component | The new component to append to the set |
Definition at line 747 of file iCalendar.php.
iCalComponent::AddProperty | ( | $new_property, | |
$value = null, | |||
$parameters = null ) |
Adds a new property
iCalProp | $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 iCalProp with everything |
array | $parameters | The key/value parameter pairs (default: none, or param 1 is an iCalProp with everything) |
Definition at line 616 of file iCalendar.php.
iCalComponent::ClearComponents | ( | $type = null | ) |
Clear all components, or the components matching a particular type
string | $type | The type of component - omit for all components |
Definition at line 704 of file iCalendar.php.
iCalComponent::ClearProperties | ( | $type = null | ) |
Clear all properties, or the properties matching a particular type
string | $type | The type of property - omit for all properties |
Definition at line 579 of file iCalendar.php.
iCalComponent::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'.
Definition at line 804 of file iCalendar.php.
iCalComponent::CollectParameterValues | ( | $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
Definition at line 385 of file iCalendar.php.
& iCalComponent::FirstNonTimezone | ( | $type = null | ) |
Get all sub-components, or at least get those matching a type
Definition at line 636 of file iCalendar.php.
iCalComponent::GetComponents | ( | $type = null, | |
$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.
string | $type | The type to match (default: All) |
boolean | $normal_match | Set to false to invert the match (default: true) |
Definition at line 686 of file iCalendar.php.
iCalComponent::GetPParamValue | ( | $type, | |
$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.
string | $type | The type of property we are after. |
string | $type | The name of the parameter we are after. |
Definition at line 567 of file iCalendar.php.
iCalComponent::GetProperties | ( | $type = null | ) |
Get all properties, or the properties matching a particular type
Definition at line 533 of file iCalendar.php.
iCalComponent::GetPropertiesByPath | ( | $path | ) |
Return an array of properties matching the specified path
There is more to the path, so we recurse into that sub-part
Our input $path was not rooted, so we recurse further
Definition at line 876 of file iCalendar.php.
iCalComponent::GetPValue | ( | $type | ) |
Get the value of the first property matching the name. Obviously this isn't so useful for properties which may occur multiply, but most don't.
string | $type | The type of property we are after. |
Definition at line 551 of file iCalendar.php.
iCalComponent::GetType | ( | ) |
Return the type of component which this is
Definition at line 515 of file iCalendar.php.
iCalComponent::IsAttendee | ( | ) |
Return true if the person identified by the email address is down as an attendee or organizer for this meeting.
string | The e-mail address of the person we're seeking. |
an organizer is an attendee, as far as we're concerned
Definition at line 667 of file iCalendar.php.
iCalComponent::IsOrganizer | ( | ) |
Return true if the person identified by the email address is down as an organizer for this meeting.
string | The e-mail address of the person we're seeking. |
Definition at line 651 of file iCalendar.php.
iCalComponent::MaskComponents | ( | $keep | ) |
Mask components, removing any that are not of the types in the list
array | $keep | An array of component types to be kept |
Definition at line 765 of file iCalendar.php.
iCalComponent::MaskProperties | ( | $keep, | |
$component_list = null ) |
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 |
Definition at line 783 of file iCalendar.php.
iCalComponent::ParseFrom | ( | $content | ) |
Parse the text $content into sets of iCalProp & iCalComponent within this iCalComponent
string | $content | The raw RFC2445-compliant iCalendar component, including BEGIN:TYPE & END:TYPE |
Definition at line 406 of file iCalendar.php.
iCalComponent::Render | ( | $restricted_properties = null | ) |
Renders the component, possibly restricted to only the listed properties
Definition at line 844 of file iCalendar.php.
iCalComponent::RenderWithoutWrap | ( | $restricted_properties = null | ) |
this function supstitute function from vCalendar\RenderWithoutWrap NOTE: vCalendar\RenderWithoutWrap - return string without \r
on end thats here removed the tail of iCalendar::Render which return \r
on end
null | $restricted_properties |
Definition at line 834 of file iCalendar.php.
iCalComponent::SetComponents | ( | $new_component, | |
$type = null ) |
Sets some or all sub-components of the component to the supplied new components
array | of iCalComponent $new_components The new components to replace the existing ones | |
string | $type | The type of components to be replaced. Defaults to null, which means all components will be replaced. |
Definition at line 733 of file iCalendar.php.
iCalComponent::SetProperties | ( | $new_properties, | |
$type = null ) |
Set all properties, or the ones matching a particular type
Definition at line 600 of file iCalendar.php.
iCalComponent::SetType | ( | $type | ) |
Set the type of component which this is
Definition at line 523 of file iCalendar.php.
iCalComponent::UnwrapComponent | ( | $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.
Definition at line 491 of file iCalendar.php.
iCalComponent::VCalendar | ( | $extra_properties = null | ) |
Apply standard properties for a VCalendar
array | $extra_properties | Key/value pairs of additional properties |
Definition at line 369 of file iCalendar.php.
iCalComponent::WrapComponent | ( | $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.
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.
Definition at line 503 of file iCalendar.php.
iCalComponent::$components |
Definition at line 340 of file iCalendar.php.
iCalComponent::$properties |
Definition at line 333 of file iCalendar.php.
iCalComponent::$rendered |
Definition at line 347 of file iCalendar.php.
iCalComponent::$type |
Definition at line 326 of file iCalendar.php.