Andrew's Web Libraries (AWL) 0.64
Loading...
Searching...
No Matches
iCalProp Class Reference

Public Member Functions

 __construct ( $propstring=null)
 ParseFrom ( $propstring)

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

◆ 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.

Get/Set name property

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

Get/Set the content of the property

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

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.

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.

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

Set the value of a parameter

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

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

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 77 of file iCalendar.php.

Member Data Documentation

◆ $content

iCalProp::$content

Definition at line 39 of file iCalendar.php.

◆ $name

iCalProp::$name

Definition at line 25 of file iCalendar.php.

◆ $parameters

iCalProp::$parameters

Definition at line 32 of file iCalendar.php.

◆ $rendered

iCalProp::$rendered

Definition at line 46 of file iCalendar.php.

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