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 ([ $force = false])
 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 207)

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 142)

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 175)

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. The 'value' may be an array of values.
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 255)

Render a suitably escaped RFC2445 content string.

void Render ([ $force = false])
  • $force
RenderParameters (line 236)

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

void RenderParameters ()
SetParameterValue (line 220)

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 317)

Test a PROP-FILTER or PARAM-FILTER and return a true/false PROP-FILTER (is-defined | is-not-defined | ((time-range | text-match)?, param-filter*)) PARAM-FILTER (is-defined | is-not-defined | ((time-range | text-match)?, param-filter*))

  • 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 363)
void TestParamFilter ( $filters,  $parameter_value)
  • $filters
  • $parameter_value
TextMatch (line 194)

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 159)

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 303)
  • access: public
void __toString ()

Documentation generated on Fri, 13 Jan 2012 23:40:19 +1300 by phpDocumentor 1.4.3