<?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_DataTypes_Text</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_DataTypes_Text</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-vars">Vars</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">The text data type.</p>
<p class="description"><p><pre> text = *(TSAFE-CHAR / ":" / DQUOTE / ESCAPED-CHAR)
; Folded according to description above
ESCAPED-CHAR = ("\\" / "\;" / "\," / "\N" / "\n")
; \\ encodes \, \N or \n encodes newline
; \; encodes ;, \, encodes ,
TSAFE-CHAR = %x20-21 / %x23-2B / %x2D-39 / %x3C-5B /
%x5D-7E / NON-US-ASCII
; Any character except CTLs not needed by the current
; character set, DQUOTE, ";", ":", "\", ","</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.3.11">http://tools.ietf.org/html/draft-ietf-calsify-rfc2445bis-08#section-3.3.11</a></li>
</ul>
<p class="notes">
Located in <a class="field" href="_datatypes.php.html">/datatypes.php</a> (line <span class="field">686</span>)
</p>
<pre><a href="../PhpiCalLib/PhpiCalLib_DataType.html">PhpiCalLib_DataType</a>
|
--PhpiCalLib_DataTypes_Text</pre>
</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-vars">Vars</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">
<span class="method-result">PhpiCalLib_DataTypes_Text</span>
<a href="#__construct" title="details" class="method-name">__construct</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">void</span>
<a href="#Parse" title="details" class="method-name">Parse</a>
(<span class="var-type">string</span> <span class="var-name">$EncodedString</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">$Text</span>)
</div>
<div class="method-definition">
<span class="method-result">string</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-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">
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../PhpiCalLib/PhpiCalLib_DataType.html">PhpiCalLib_DataType</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_DataType.html#var$DataType">PhpiCalLib_DataType::$DataType</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_DataType.html#var$IanaTokenRegex">PhpiCalLib_DataType::$IanaTokenRegex</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_DataType.html#var$TypeMap">PhpiCalLib_DataType::$TypeMap</a></span><br>
</span>
</blockquote>
</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-vars">Vars</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="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">698</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_DataTypes_Text</span>
<span class="method-name">
__construct
</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">741</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access the unescaped text value</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="methodParse" id="Parse"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Parse</span> (line <span class="line-number">750</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Extract the text value from the encoded string</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">
Parse
</span>
(<span class="var-type">string</span> <span class="var-name">$EncodedString</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$EncodedString</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">707</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the 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">$Text</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$Text</span> </li>
</ul>
</div>
<a name="methodToString" id="ToString"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">ToString</span> (line <span class="line-number">776</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Convert to an encoded string</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">
ToString
</span>
()
</div>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PhpiCalLib/PhpiCalLib_DataType.html">PhpiCalLib_DataType</a></span></p>
<blockquote>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_DataType.html#methodFromDataType">PhpiCalLib_DataType::FromDataType()</a></span><br>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_DataType.html#methodToDataType">PhpiCalLib_DataType::ToDataType()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Tue, 01 Apr 2008 01:07:13 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
</p>
</div></body>
</html>