Location: PHPKode > projects > PhpiCalLib > doc/PhpiCalLib/PhpiCalLib_Parameters_Value.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_Parameters_Value</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_Parameters_Value</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 VALUE parameter.</p>
<p class="description"><p><pre>         valuetypeparam = "VALUE" "=" valuetype
         valuetype  = ("BINARY"
                    / "BOOLEAN"
                    / "CAL-ADDRESS"
                    / "DATE"
                    / "DATE-TIME"
                    / "DURATION"
                    / "FLOAT"
                    / "INTEGER"
                    / "PERIOD"
                    / "RECUR"
                    / "TEXT"
                    / "TIME"
                    / "URI"
                    / "UTC-OFFSET"
                    / x-name
                    ; Some experimental iCalendar value type.
                    / iana-token)
                    ; Some other IANA registered iCalendar value type.</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.2.20">http://tools.ietf.org/html/draft-ietf-calsify-rfc2445bis-08#section-3.2.20</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_parameters.php.html">/parameters.php</a> (line <span class="field">532</span>)
		</p>
		
				
		<pre><a href="../PhpiCalLib/PhpiCalLib_Parameter.html">PhpiCalLib_Parameter</a>
   |
   --PhpiCalLib_Parameters_Value</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_Parameters_Value</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>&nbsp;<span class="var-name">$Value</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#FromDataType" title="details" class="method-name">FromDataType</a>
											(<span class="var-type">integer</span>&nbsp;<span class="var-name">$DataTypeId</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">integer</span>
										<a href="#ToDataType" title="details" class="method-name">ToDataType</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_Parameter.html">PhpiCalLib_Parameter</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#var$aValues">PhpiCalLib_Parameter::$aValues</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#var$BadParamSplitRegex">PhpiCalLib_Parameter::$BadParamSplitRegex</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#var$IanaTokenRegex">PhpiCalLib_Parameter::$IanaTokenRegex</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#var$Name">PhpiCalLib_Parameter::$Name</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#var$QSafeCharRegex">PhpiCalLib_Parameter::$QSafeCharRegex</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#var$SafeCharRegex">PhpiCalLib_Parameter::$SafeCharRegex</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#var$Type">PhpiCalLib_Parameter::$Type</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#var$UnSafeCharRegex">PhpiCalLib_Parameter::$UnSafeCharRegex</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">533</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_Parameters_Value</span>
		<span class="method-name">
			__construct
		</span>
				()
			</div>
	
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#method__construct">PhpiCalLib_Parameter::__construct()</a></dt>
						<dd>Constructor</dd>
					</dl>
			
	</div>
<a name="methodAddValue" id="AddValue"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">AddValue</span> (line <span class="line-number">543</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Overridden because this property only allows one 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>&nbsp;<span class="var-name">$Value</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$Value</span><span class="var-description">: The new value</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#methodAddValue">PhpiCalLib_Parameter::AddValue()</a></dt>
						<dd>Add another parameter value</dd>
					</dl>
			
	</div>
<a name="methodFromDataType" id="FromDataType"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">FromDataType</span> (line <span class="line-number">591</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the parameter value by specifying the data type</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">
			FromDataType
		</span>
					(<span class="var-type">integer</span>&nbsp;<span class="var-name">$DataTypeId</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$DataTypeId</span>			</li>
				</ul>
		
			
	</div>
<a name="methodToDataType" id="ToDataType"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">ToDataType</span> (line <span class="line-number">582</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access the data type id</p>
	<ul class="tags">
				<li><span class="field">return:</span> One of the PHPICALLIB_DATATYPE_* values</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">integer</span>
		<span class="method-name">
			ToDataType
		</span>
				()
			</div>
	
		
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html">PhpiCalLib_Parameter</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#method__construct">PhpiCalLib_Parameter::__construct()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#methodAddValue">PhpiCalLib_Parameter::AddValue()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#methodCreate">PhpiCalLib_Parameter::Create()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#methodCreateParameter">PhpiCalLib_Parameter::CreateParameter()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#methodGetName">PhpiCalLib_Parameter::GetName()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#methodGetParamRegex">PhpiCalLib_Parameter::GetParamRegex()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#methodGetType">PhpiCalLib_Parameter::GetType()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#methodGetValue">PhpiCalLib_Parameter::GetValue()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#methodGetValues">PhpiCalLib_Parameter::GetValues()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#methodSetName">PhpiCalLib_Parameter::SetName()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#methodSetType">PhpiCalLib_Parameter::SetType()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#methodSetValue">PhpiCalLib_Parameter::SetValue()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#methodSetValues">PhpiCalLib_Parameter::SetValues()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#methodToParameterType">PhpiCalLib_Parameter::ToParameterType()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Parameter.html#methodToString">PhpiCalLib_Parameter::ToString()</a></span><br>
											</blockquote>
										
		</div>
	</div>


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