Docs For Class vProperty

Description

A Class for representing properties within a vComponent (VCALENDAR or VCARD)

Located in /vComponent.php (line 23)

Variable Summary

string $content

string $name

array $parameters

string $rendered

Method Summary

vProperty __construct ([string $propstring = null])

string GetParameterValue (string $name)

string Name ([string $newname = null])

array Parameters ([array $newparams = null])

void ParseFrom (string $propstring)

void Render ()

void RenderParameters ()

void SetParameterValue (string $name, string $value)

boolean TestFilter ( $filters, array $filter)

void TestParamFilter ( $filters, $parameter_value)

string TextMatch (string $search)

string Value ([string $newvalue = null])

void __toString ()

Variables

string $content (line 47)

The value of this property.

access: protected

string $name (line 33)

The name of this property

access: protected

array $parameters (line 40)

An array of parameters to this property, represented as key/value pairs.

access: protected

string $rendered (line 54)

The original value that this was parsed from, if that's the way it happened.

access: protected

Methods

Constructor __construct (line 66)

The constructor parses the incoming string, which is formatted as per RFC2445 as a propname[;param1=pval1[; ... ]]:propvalue however we allow ourselves to assume that the RFC2445 content unescaping has already happened when vComponent::ParseFrom() called vComponent::UnwrapComponent().

vProperty __construct ([string $propstring = null])

string $propstring: The string from the vComponent which contains this property.

GetParameterValue (line 200)

Get the value of a parameter

return: The value of the parameter

string GetParameterValue (string $name)

string $name: The name of the parameter to retrieve the value for

Name (line 135)

Get/Set name property

return: The name for the property.

string Name ([string $newname = null])

string $newname: [optional] A new name for the property

Parameters (line 168)

Get/Set parameters in their entirety

return: The current array of parameters for the property.

array Parameters ([array $newparams = null])

array $newparams: An array of new parameter key/value pairs

ParseFrom (line 85)

The constructor parses the incoming string, which is formatted as per RFC2445 as a propname[;param1=pval1[; ... ]]:propvalue however we allow ourselves to assume that the RFC2445 content unescaping has already happened when vComponent::ParseFrom() called vComponent::UnwrapComponent().

void ParseFrom (string $propstring)

string $propstring: The string from the vComponent which contains this property.

Render (line 235)

Render a suitably escaped RFC2445 content string.

void Render ()

RenderParameters (line 222)

Render the set of parameters as key1=value1[;key2=value2[; ...]] with any colons or semicolons escaped.

void RenderParameters ()

SetParameterValue (line 213)

Set the value of a parameter

void SetParameterValue (string $name, string $value)

string $name: The name of the parameter to set the value for
string $value: The value of the parameter

TestFilter (line 288)

return: Whether or not this vProperty passes the test

boolean TestFilter ( $filters, array $filter)

array $filter: An array of XMLElement defining the filter
$filters

TestParamFilter (line 332)

void TestParamFilter ( $filters, $parameter_value)

$filters
$parameter_value

TextMatch (line 187)

Test if our value contains a string

return: The name for the property.

string TextMatch (string $search)

string $search: The needle which we shall search the haystack for.

Value (line 152)

Get/Set the content of the property

return: The value of the property.

string Value ([string $newvalue = null])

string $newvalue: [optional] A new value for the property

__toString (line 274)

access: public

void __toString ()