Location: PHPKode > projects > PhpiCalLib > doc/PhpiCalLib/PhpiCalLib_Properties_TextProperty.html
<?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_Properties_TextProperty</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_Properties_TextProperty</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">Many properties specify a value of type &quot;text&quot;.  This base class can be used for those.</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 %x22, ";" %x3B, ":" %x3A, "\" %x5C, "," %x2C</pre></p></p>
		<p class="notes">
			Located in <a class="field" href="_textproperties.php.html">/textproperties.php</a> (line <span class="field">44</span>)
		</p>
		
				
		<pre><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html">PhpiCalLib_ContentLine</a>
   |
   --PhpiCalLib_Properties_TextProperty</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_Properties_ProdIdProperty.html">PhpiCalLib_Properties_ProdIdProperty</a></td>
					<td>
											The PRODID property.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../PhpiCalLib/PhpiCalLib_Properties_DescriptionProperty.html">PhpiCalLib_Properties_DescriptionProperty</a></td>
					<td>
											The DESCRIPTION property.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../PhpiCalLib/PhpiCalLib_Properties_CategoriesProperty.html">PhpiCalLib_Properties_CategoriesProperty</a></td>
					<td>
											The CATEGORIES property
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../PhpiCalLib/PhpiCalLib_Properties_SummaryProperty.html">PhpiCalLib_Properties_SummaryProperty</a></td>
					<td>
											The SUMMARY property.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../PhpiCalLib/PhpiCalLib_Properties_UidProperty.html">PhpiCalLib_Properties_UidProperty</a></td>
					<td>
											The UID property.
										</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">
					<span class="var-type"><a href="../PhpiCalLib/PhpiCalLib_DataTypes_Text.html">PhpiCalLib_DataTypes_Text</a></span>
					<a href="#$TextValue" title="details" class="var-name">$TextValue</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">
											<span class="method-result">PhpiCalLib_Properties_TextProperty</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#GetTextValue" title="details" class="method-name">GetTextValue</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#SetEncodedValue" title="details" class="method-name">SetEncodedValue</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$Text</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#SetTextValue" title="details" class="method-name">SetTextValue</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$String</span>)
									</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$TextValue" id="$TextValue"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type"><a href="../PhpiCalLib/PhpiCalLib_DataTypes_Text.html">PhpiCalLib_DataTypes_Text</a></span>
			<span class="var-name">$TextValue</span>
			 = <span class="var-default"> null</span>			(line <span class="line-number">50</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The text token value of this property</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>

							<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html">PhpiCalLib_ContentLine</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#var$aParameters">PhpiCalLib_ContentLine::$aParameters</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#var$aPermittedParameters">PhpiCalLib_ContentLine::$aPermittedParameters</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#var$EncodedValue">PhpiCalLib_ContentLine::$EncodedValue</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#var$IanaTokenRegex">PhpiCalLib_ContentLine::$IanaTokenRegex</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#var$Name">PhpiCalLib_ContentLine::$Name</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#var$NameSplitRegex">PhpiCalLib_ContentLine::$NameSplitRegex</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#var$Type">PhpiCalLib_ContentLine::$Type</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-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="method__construct" id="__construct"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">52</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">PhpiCalLib_Properties_TextProperty</span>
		<span class="method-name">
			__construct
		</span>
				()
			</div>
	
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#method__construct">PhpiCalLib_ContentLine::__construct()</a></dt>
						<dd>Constructor</dd>
					</dl>
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../PhpiCalLib/PhpiCalLib_Properties_ProdIdProperty.html#method__construct">PhpiCalLib_Properties_ProdIdProperty::__construct()</a>
							</li>
					<li>
				<a href="../PhpiCalLib/PhpiCalLib_Properties_DescriptionProperty.html#method__construct">PhpiCalLib_Properties_DescriptionProperty::__construct()</a>
							</li>
					<li>
				<a href="../PhpiCalLib/PhpiCalLib_Properties_CategoriesProperty.html#method__construct">PhpiCalLib_Properties_CategoriesProperty::__construct()</a>
							</li>
					<li>
				<a href="../PhpiCalLib/PhpiCalLib_Properties_SummaryProperty.html#method__construct">PhpiCalLib_Properties_SummaryProperty::__construct()</a>
							</li>
					<li>
				<a href="../PhpiCalLib/PhpiCalLib_Properties_UidProperty.html#method__construct">PhpiCalLib_Properties_UidProperty::__construct()</a>
							</li>
				</ul>
	</div>
<a name="methodGetTextValue" id="GetTextValue"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">GetTextValue</span> (line <span class="line-number">70</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access the TextValue</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">
			GetTextValue
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodSetEncodedValue" id="SetEncodedValue"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">SetEncodedValue</span> (line <span class="line-number">60</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Overridden to do extra parsing to extract the $TextValue</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">
			SetEncodedValue
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$Text</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$Text</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodSetEncodedValue">PhpiCalLib_ContentLine::SetEncodedValue()</a></dt>
						<dd>Sets the property value by specifying the encoded value</dd>
					</dl>
			
	</div>
<a name="methodSetTextValue" id="SetTextValue"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">SetTextValue</span> (line <span class="line-number">77</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the TextValue</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">
			SetTextValue
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$String</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$String</span>			</li>
				</ul>
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html">PhpiCalLib_ContentLine</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#method__construct">PhpiCalLib_ContentLine::__construct()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodAddParameter">PhpiCalLib_ContentLine::AddParameter()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodAddParameterPermitted">PhpiCalLib_ContentLine::AddParameterPermitted()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodCopy">PhpiCalLib_ContentLine::Copy()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodCreate">PhpiCalLib_ContentLine::Create()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodCreateContentLine">PhpiCalLib_ContentLine::CreateContentLine()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodGetEncodedValue">PhpiCalLib_ContentLine::GetEncodedValue()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodGetName">PhpiCalLib_ContentLine::GetName()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodGetParameter">PhpiCalLib_ContentLine::GetParameter()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodGetParameters">PhpiCalLib_ContentLine::GetParameters()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodGetType">PhpiCalLib_ContentLine::GetType()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodRemoveParameter">PhpiCalLib_ContentLine::RemoveParameter()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodRemoveParameterPermitted">PhpiCalLib_ContentLine::RemoveParameterPermitted()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodSetEncodedValue">PhpiCalLib_ContentLine::SetEncodedValue()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodSetName">PhpiCalLib_ContentLine::SetName()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodSetParameter">PhpiCalLib_ContentLine::SetParameter()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodSetParameterPermitted">PhpiCalLib_ContentLine::SetParameterPermitted()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodSetParameters">PhpiCalLib_ContentLine::SetParameters()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodSetType">PhpiCalLib_ContentLine::SetType()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodToContentLines">PhpiCalLib_ContentLine::ToContentLines()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodToPropertyName">PhpiCalLib_ContentLine::ToPropertyName()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodToPropertyType">PhpiCalLib_ContentLine::ToPropertyType()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodToString">PhpiCalLib_ContentLine::ToString()</a></span><br>
											</blockquote>
										
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Tue, 01 Apr 2008 01:07:29 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>
Return current item: PhpiCalLib