<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class PhpiCalLib_Parameter</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class PhpiCalLib_Parameter</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-descendents">Descendents</a>
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Base class for all contentline parameters</p>
<p class="notes">
Located in <a class="field" href="_parameters.php.html">/parameters.php</a> (line <span class="field">99</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-descendents"></a>
<div class="info-box">
<div class="info-box-title">Direct descendents</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Descendents</span>
| <a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PhpiCalLib/PhpiCalLib_ParameterFactory.html">PhpiCalLib_ParameterFactory</a></td>
<td>
The factory class for creating the right kind of <a href="../PhpiCalLib/PhpiCalLib_Parameter.html">PhpiCalLib_Parameter</a> objects.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../PhpiCalLib/PhpiCalLib_Parameters_Value.html">PhpiCalLib_Parameters_Value</a></td>
<td>
The VALUE parameter.
</td>
</tr>
</table>
</div>
</div>
<a name="sec-var-summary"></a>
<div class="info-box">
<div class="info-box-title">Variable Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendents</a> |
<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="var-summary">
<div class="var-title">
static <span class="var-type">mixed</span>
<a href="#$BadParamSplitRegex" title="details" class="var-name">$BadParamSplitRegex</a>
</div>
<div class="var-title">
static <span class="var-type">string</span>
<a href="#$IanaTokenRegex" title="details" class="var-name">$IanaTokenRegex</a>
</div>
<div class="var-title">
static <span class="var-type">string</span>
<a href="#$QSafeCharRegex" title="details" class="var-name">$QSafeCharRegex</a>
</div>
<div class="var-title">
static <span class="var-type">string</span>
<a href="#$SafeCharRegex" title="details" class="var-name">$SafeCharRegex</a>
</div>
<div class="var-title">
static <span class="var-type">string</span>
<a href="#$UnSafeCharRegex" title="details" class="var-name">$UnSafeCharRegex</a>
</div>
<div class="var-title">
<span class="var-type">array:</span>
<a href="#$aValues" title="details" class="var-name">$aValues</a>
</div>
<div class="var-title">
<span class="var-type">string</span>
<a href="#$Name" title="details" class="var-name">$Name</a>
</div>
<div class="var-title">
<span class="var-type">integer</span>
<a href="#$Type" title="details" class="var-name">$Type</a>
</div>
</div>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
static <span class="method-result">string</span>
<a href="#GetParamRegex" title="details" class="method-name">GetParamRegex</a>
()
</div>
<div class="method-definition">
static <span class="method-result">int</span>
<a href="#ToParameterType" title="details" class="method-name">ToParameterType</a>
(<span class="var-type">string</span> <span class="var-name">$Name</span>)
</div>
<div class="method-definition">
<span class="method-result">PhpiCalLib_Parameter</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#AddValue" title="details" class="method-name">AddValue</a>
(<span class="var-type">string</span> <span class="var-name">$ParamValue</span>)
</div>
<div class="method-definition">
<span class="method-result">A</span>
<a href="#Create" title="details" class="method-name">Create</a>
(<span class="var-type"></span> <span class="var-name">$Param</span>, <span class="var-type">string</span> <span class="var-name">$String</span>)
</div>
<div class="method-definition">
<span class="method-result"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html">PhpiCalLib_Parameter</a></span>
<a href="#CreateParameter" title="details" class="method-name">CreateParameter</a>
(<span class="var-type">string</span> <span class="var-name">$Name</span>)
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#GetName" title="details" class="method-name">GetName</a>
()
</div>
<div class="method-definition">
<span class="method-result">PHPICALLIB_PARAMETER_*</span>
<a href="#GetType" title="details" class="method-name">GetType</a>
()
</div>
<div class="method-definition">
<span class="method-result">string</span>
<a href="#GetValue" title="details" class="method-name">GetValue</a>
()
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#GetValues" title="details" class="method-name">GetValues</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#SetName" title="details" class="method-name">SetName</a>
(<span class="var-type">string</span> <span class="var-name">$Name</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#SetType" title="details" class="method-name">SetType</a>
(<span class="var-type">integer</span> <span class="var-name">$Type</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#SetValue" title="details" class="method-name">SetValue</a>
(<span class="var-type">string</span> <span class="var-name">$Value</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#SetValues" title="details" class="method-name">SetValues</a>
(<span class="var-type">array</span> <span class="var-name">$aValues</span>)
</div>
<div class="method-definition">
<span class="method-result">A</span>
<a href="#ToString" title="details" class="method-name">ToString</a>
()
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<a name="var$BadParamSplitRegex" id="$BadParamSplitRegex"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
static <span class="var-type">mixed</span>
<span class="var-name">$BadParamSplitRegex</span>
= <span class="var-default"> '[^\x09\x20-\x39\x3c-\x7e]'</span> (line <span class="line-number">219</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$IanaTokenRegex" id="$IanaTokenRegex"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
static <span class="var-type">string</span>
<span class="var-name">$IanaTokenRegex</span>
= <span class="var-default"> '[a-zA-Z0-9-]+'</span> (line <span class="line-number">151</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Regex to capture validate an iana-token</p>
<ul class="tags">
<li><span class="field">link:</span> <a href="http://tools.ietf.org/html/draft-ietf-calsify-rfc2445bis-08#section-3.1">http://tools.ietf.org/html/draft-ietf-calsify-rfc2445bis-08#section-3.1
iana-token = 1*(ALPHA / DIGIT / "-")</a></li>
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$QSafeCharRegex" id="$QSafeCharRegex"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
static <span class="var-type">string</span>
<span class="var-name">$QSafeCharRegex</span>
= <span class="var-default"> '[\x09\x20\x21\x23-\x7E]'</span> (line <span class="line-number">188</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A regular expression to match the QSAFE-CHAR token.</p>
<p class="description"><p><pre> QSAFE-CHAR = WSP / %x21 / %x23-7E / NON-US-ASCII
==>
### Note we are going to assume that the utf-8 decoding has been done for us already and that
our string is essentially in unicode
QSAFE-CHAR = %x09 / %x20-21 / %x23-7E</pre></p></p>
<ul class="tags">
<li><span class="field">link:</span> <a href="http://tools.ietf.org/html/draft-ietf-calsify-rfc2445bis-08#section-3.1">http://tools.ietf.org/html/draft-ietf-calsify-rfc2445bis-08#section-3.1</a></li>
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$SafeCharRegex" id="$SafeCharRegex"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
static <span class="var-type">string</span>
<span class="var-name">$SafeCharRegex</span>
= <span class="var-default"> '[\x09\x20\x21\x23-\x2B\x2D-\x39\x3C-\x7E]'</span> (line <span class="line-number">167</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A regular express to match the SAFE-CHAR token.</p>
<p class="description"><p><pre> SAFE-CHAR = WSP / %x21 / %x23-2B / %x2D-39 / %x3C-7E
/ NON-US-ASCII
; Any character except CONTROL, DQUOTE, ";", ":", ","
==>
### Note we are going to assume that the utf-8 decoding has been done for us already and that
our string is essentially in unicode
SAFE-CHAR = %x09 / %x20-21 / %x23-2B / %x2D-39 / %x3C-7E</pre></p></p>
<ul class="tags">
<li><span class="field">link:</span> <a href="http://tools.ietf.org/html/draft-ietf-calsify-rfc2445bis-08#section-3.1">http://tools.ietf.org/html/draft-ietf-calsify-rfc2445bis-08#section-3.1</a></li>
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$UnSafeCharRegex" id="$UnSafeCharRegex"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
static <span class="var-type">string</span>
<span class="var-name">$UnSafeCharRegex</span>
= <span class="var-default"> '[^\x09\x20\x21\x23-\x2B\x2D-\x39\x3C-\x7E]'</span> (line <span class="line-number">174</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">An array to locate the converse of SafeCharRegex.</p>
<ul class="tags">
<li><span class="field">see:</span> <a href="../PhpiCalLib/PhpiCalLib_Parameter.html#var$SafeCharRegex">PhpiCalLib_Parameter::$SafeCharRegex</a></li>
<li><span class="field">access:</span> public</li>
</ul>
</div>
<a name="var$aValues" id="$aValues"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">array:</span>
<span class="var-name">$aValues</span>
= <span class="var-default">array()</span> (line <span class="line-number">113</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The "param-value" tokens</p>
<ul class="tags">
<li><span class="field">var:</span> of strings</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$Name" id="$Name"><!-- --></A>
<div class="oddrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">string</span>
<span class="var-name">$Name</span>
= <span class="var-default"> ''</span> (line <span class="line-number">104</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The "param-name" token</p>
<ul class="tags">
<li><span class="field">access:</span> protected</li>
</ul>
</div>
<a name="var$Type" id="$Type"><!-- --></A>
<div class="evenrow">
<div class="var-header">
<span class="var-title">
<span class="var-type">integer</span>
<span class="var-name">$Type</span>
= <span class="var-default"> 0</span> (line <span class="line-number">108</span>)
</span>
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">var:</span> The type of this parameter</li>
<li><span class="field">access:</span> protected</li>
</ul>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodGetParamRegex" id="GetParamRegex"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">static method GetParamRegex</span> (line <span class="line-number">200</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">A quick regular expression to validate a param token.</p>
<p class="description"><p><pre> ==>
param = param-name "=" param-value *("," param-value)
param-name = iana-token / x-name</pre></p></p>
<ul class="tags">
<li><span class="field">link:</span> <a href="http://tools.ietf.org/html/draft-ietf-calsify-rfc2445bis-08#section-3.1">http://tools.ietf.org/html/draft-ietf-calsify-rfc2445bis-08#section-3.1</a></li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">string</span>
<span class="method-name">
GetParamRegex
</span>
()
</div>
</div>
<a name="methodToParameterType" id="ToParameterType"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">static method ToParameterType</span> (line <span class="line-number">234</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Convert a parameter name to it's defined type</p>
<ul class="tags">
<li><span class="field">return:</span> one of the PHPICALLIB_PARAMETER_* properties</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
static
<span class="method-result">int</span>
<span class="method-name">
ToParameterType
</span>
(<span class="var-type">string</span> <span class="var-name">$Name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$Name</span><span class="var-description">: a "name" RFC2445 token</span> </li>
</ul>
</div>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">224</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">PhpiCalLib_Parameter</span>
<span class="method-name">
__construct
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PhpiCalLib/PhpiCalLib_Parameters_Value.html#method__construct">PhpiCalLib_Parameters_Value::__construct()</a>
</li>
</ul>
</div>
<a name="methodAddValue" id="AddValue"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">AddValue</span> (line <span class="line-number">430</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add another parameter value</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
AddValue
</span>
(<span class="var-type">string</span> <span class="var-name">$ParamValue</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$ParamValue</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PhpiCalLib/PhpiCalLib_Parameters_Value.html#methodAddValue">PhpiCalLib_Parameters_Value::AddValue()</a>
: Overridden because this property only allows one value
</li>
</ul>
</div>
<a name="methodCreate" id="Create"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">Create</span> (line <span class="line-number">271</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parse a param from the string, returning the new object</p>
<ul class="tags">
<li><span class="field">return:</span> PhpiCalLib_Parameter derived class, according to what CreateParameter returned</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">A</span>
<span class="method-name">
Create
</span>
(<span class="var-type"></span> <span class="var-name">$Param</span>, <span class="var-type">string</span> <span class="var-name">$String</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$String</span><span class="var-description">: The encoded value that represents the parameter</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$Param</span> </li>
</ul>
</div>
<a name="methodCreateParameter" id="CreateParameter"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">CreateParameter</span> (line <span class="line-number">259</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Create a new Parameter object</p>
<p class="description"><p>A component would override this class, providing a new version of this function in order to choose the right kind of class to create which will offer better validation.</p></p>
<ul class="tags">
<li><span class="field">return:</span> derived class</li>
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html">PhpiCalLib_Parameter</a></span>
<span class="method-name">
CreateParameter
</span>
(<span class="var-type">string</span> <span class="var-name">$Name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$Name</span><span class="var-description">: The name of the param</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../PhpiCalLib/PhpiCalLib_ParameterFactory.html#methodCreateParameter">PhpiCalLib_ParameterFactory::CreateParameter()</a>
: Overridden, to create the right kind of PhpiCalLib_ContentLine
</li>
</ul>
</div>
<a name="methodGetName" id="GetName"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">GetName</span> (line <span class="line-number">351</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access the name of the parameter</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
GetName
</span>
()
</div>
</div>
<a name="methodGetType" id="GetType"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">GetType</span> (line <span class="line-number">393</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access the component type</p>
<p class="description"><p>Note this will return PHPICALLIB_PARAMETER_IANAPARAM for components that it doesn't recognize</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">PHPICALLIB_PARAMETER_*</span>
<span class="method-name">
GetType
</span>
()
</div>
</div>
<a name="methodGetValue" id="GetValue"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">GetValue</span> (line <span class="line-number">472</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get the value of this single value property</p>
<p class="description"><p>If the property has more than one value, it returns the first. If it has no values, it returns an empty string</p></p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">string</span>
<span class="method-name">
GetValue
</span>
()
</div>
</div>
<a name="methodGetValues" id="GetValues"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">GetValues</span> (line <span class="line-number">421</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get all the values of this parameter</p>
<ul class="tags">
<li><span class="field">return:</span> Of the parameter values</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
GetValues
</span>
()
</div>
</div>
<a name="methodSetName" id="SetName"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">SetName</span> (line <span class="line-number">363</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the name of the parameter</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
SetName
</span>
(<span class="var-type">string</span> <span class="var-name">$Name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$Name</span> </li>
</ul>
</div>
<a name="methodSetType" id="SetType"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">SetType</span> (line <span class="line-number">402</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the type of the component</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
SetType
</span>
(<span class="var-type">integer</span> <span class="var-name">$Type</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$Type</span> </li>
</ul>
</div>
<a name="methodSetValue" id="SetValue"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">SetValue</span> (line <span class="line-number">482</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the values to a single new value</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
SetValue
</span>
(<span class="var-type">string</span> <span class="var-name">$Value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$Value</span> </li>
</ul>
</div>
<a name="methodSetValues" id="SetValues"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">SetValues</span> (line <span class="line-number">457</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the new property values.</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
SetValues
</span>
(<span class="var-type">array</span> <span class="var-name">$aValues</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">array</span>
<span class="var-name">$aValues</span><span class="var-description">: The new parameter values, to replace the existing values.</span> </li>
</ul>
</div>
<a name="methodToString" id="ToString"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">ToString</span> (line <span class="line-number">491</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Dump the parameter to a string</p>
<ul class="tags">
<li><span class="field">return:</span> string representation in the default code page</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">A</span>
<span class="method-name">
ToString
</span>
()
</div>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Tue, 01 Apr 2008 01:07:25 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
</p>
</div></body>
</html>