Andrew's Web Libraries (AWL)
iCalProp Class Reference

Public Member Functions

 __construct ( $propstring=null)
 
 ParseFrom ( $propstring)
 
 SplitQuoted ($str, $sep=',', $limit=0)
 
 Name ( $newname=null)
 
 Value ( $newvalue=null)
 
 Parameters ( $newparams=null)
 
 TextMatch ( $search)
 
 GetParameterValue ( $name)
 
 SetParameterValue ( $name, $value)
 
 RenderParameters ()
 
 Render ()
 

Public Attributes

 $name
 
 $parameters
 
 $content
 
 $rendered
 

Detailed Description

Definition at line 15 of file iCalendar.php.

Constructor & Destructor Documentation

◆ __construct()

iCalProp::__construct (   $propstring = null)

#- 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 iCalComponent::ParseFrom() called iCalComponent::UnwrapComponent().

Parameters
string$propstringThe string from the iCalendar which contains this property.

Definition at line 58 of file iCalendar.php.

Member Function Documentation

◆ GetParameterValue()

iCalProp::GetParameterValue (   $name)

Get the value of a parameter

Parameters
string$nameThe name of the parameter to retrieve the value for
Returns
string The value of the parameter

Definition at line 226 of file iCalendar.php.

◆ Name()

iCalProp::Name (   $newname = null)

Get/Set name property

Parameters
string$newname[optional] A new name for the property
Returns
string The name for the property.

Definition at line 162 of file iCalendar.php.

◆ Parameters()

iCalProp::Parameters (   $newparams = null)

Get/Set parameters in their entirety

Parameters
array$newparamsAn array of new parameter key/value pairs
Returns
array The current array of parameters for the property.

Definition at line 195 of file iCalendar.php.

◆ ParseFrom()

iCalProp::ParseFrom (   $propstring)

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 iCalComponent::ParseFrom() called iCalComponent::UnwrapComponent().

Parameters
string$propstringThe string from the iCalendar which contains this property.

Definition at line 77 of file iCalendar.php.

◆ Render()

iCalProp::Render ( )

Render a suitably escaped RFC2445 content string.

Content escaping does not apply to these properties culled from RFC2445

Content escaping applies by default to other properties

Definition at line 259 of file iCalendar.php.

◆ RenderParameters()

iCalProp::RenderParameters ( )

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

Definition at line 246 of file iCalendar.php.

◆ SetParameterValue()

iCalProp::SetParameterValue (   $name,
  $value 
)

Set the value of a parameter

Parameters
string$nameThe name of the parameter to set the value for
string$valueThe value of the parameter

Definition at line 237 of file iCalendar.php.

◆ SplitQuoted()

iCalProp::SplitQuoted (   $str,
  $sep = ',',
  $limit = 0 
)

Splits quoted strings

Parameters
string$strThe string
string$sepThe delimeter character
integer$limitLimit number of results, rest of string in last element
Returns
array

Definition at line 124 of file iCalendar.php.

◆ TextMatch()

iCalProp::TextMatch (   $search)

Test if our value contains a string

Parameters
string$searchThe needle which we shall search the haystack for.
Returns
string The name for the property.

Definition at line 211 of file iCalendar.php.

◆ Value()

iCalProp::Value (   $newvalue = null)

Get/Set the content of the property

Parameters
string$newvalue[optional] A new value for the property
Returns
string The value of the property.

Definition at line 179 of file iCalendar.php.


The documentation for this class was generated from the following file: