Overview

Packages

  • awl
    • AuthPlugin
    • AwlDatabase
    • Browser
    • classEditor
    • DataEntry
    • DataUpdate
    • EMail
    • iCalendar
    • MenuSet
    • PgQuery
    • Session
    • Translation
    • User
    • Utilities
    • Validation
    • vCalendar
    • vComponent
    • XMLDocument
    • XMLElement
  • None
  • PHP

Classes

  • iCalComponent
  • iCalProp
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class iCalProp

A Class for representing properties within an iCalendar

Package: awl\iCalendar
Copyright: Catalyst IT Ltd, Morphoss Ltd <http://www.morphoss.com/>
License: GNU GPL v2 or later
Author: Andrew McMillan <andrew@mcmillan.net.nz>
Located at iCalendar.php
Methods summary
public
# iCalProp( string $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().

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

$propstring
string
$propstring The string from the iCalendar which contains this property.
public
# ParseFrom( string $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().

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

$propstring
string
$propstring The string from the iCalendar which contains this property.
public array
# SplitQuoted( string $str, string $sep = ',', integer $limit = 0 )

Splits quoted strings

Splits quoted strings

Parameters

$str
string
$str The string
$sep
string
$sep The delimeter character
$limit
integer
$limit Limit number of results, rest of string in last element

Returns

array
public string
# Name( string $newname = null )

Get/Set name property

Get/Set name property

Parameters

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

Returns

string
The name for the property.
public string
# Value( string $newvalue = null )

Get/Set the content of the property

Get/Set the content of the property

Parameters

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

Returns

string
The value of the property.
public array
# Parameters( array $newparams = null )

Get/Set parameters in their entirety

Get/Set parameters in their entirety

Parameters

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

Returns

array
The current array of parameters for the property.
public string
# TextMatch( string $search )

Test if our value contains a string

Test if our value contains a string

Parameters

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

Returns

string
The name for the property.
public string
# GetParameterValue( string $name )

Get the value of a parameter

Get the value of a parameter

Parameters

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

Returns

string
The value of the parameter
public
# SetParameterValue( string $name, string $value )

Set the value of a parameter

Set the value of a parameter

Parameters

$name
string
$name The name of the parameter to set the value for
$value
string
$value The value of the parameter
public
# RenderParameters( )

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

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

public
# Render( )

Render a suitably escaped RFC2445 content string.

Render a suitably escaped RFC2445 content string.

Properties summary
public string $name
#

The name of this property

The name of this property

public array $parameters
#

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

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

public string $content
#

The value of this property.

The value of this property.

public string $rendered
#

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

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

AWL API documentation generated by ApiGen 2.8.0