Location: PHPKode > projects > PhpiCalLib > doc/PhpiCalLib/PhpiCalLib_DataType.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_DataType</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_DataType</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 PhpiCalLib data types</p>
		<p class="notes">
			Located in <a class="field" href="_datatypes.php.html">/datatypes.php</a> (line <span class="field">65</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_DataTypes_Date.html">PhpiCalLib_DataTypes_Date</a></td>
					<td>
											The date data type.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../PhpiCalLib/PhpiCalLib_DataTypes_DateTime.html">PhpiCalLib_DataTypes_DateTime</a></td>
					<td>
											The date-time data type.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../PhpiCalLib/PhpiCalLib_DataTypes_Duration.html">PhpiCalLib_DataTypes_Duration</a></td>
					<td>
											The dur-value data type.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../PhpiCalLib/PhpiCalLib_DataTypes_Text.html">PhpiCalLib_DataTypes_Text</a></td>
					<td>
											The text data type.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../PhpiCalLib/PhpiCalLib_DataTypes_Time.html">PhpiCalLib_DataTypes_Time</a></td>
					<td>
											The time data type.
										</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">string</span>
					<a href="#$IanaTokenRegex" title="details" class="var-name">$IanaTokenRegex</a>
				</div>
																<div class="var-title">
					static <span class="var-type">array</span>
					<a href="#$TypeMap" title="details" class="var-name">$TypeMap</a>
				</div>
																				<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$DataType" title="details" class="var-name">$DataType</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="#FromDataType" title="details" class="method-name">FromDataType</a>
											(<span class="var-type">integer</span>&nbsp;<span class="var-name">$Type</span>)
									</div>
																<div class="method-definition">
					static 						<span class="method-result">int</span>
										<a href="#ToDataType" title="details" class="method-name">ToDataType</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$Name</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$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">75</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 / &quot;-&quot;)</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$TypeMap" id="$TypeMap"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			static <span class="var-type">array</span>
			<span class="var-name">$TypeMap</span>
			 = <span class="var-default">array(
<br />				PHPICALLIB_DATATYPE_BINARY =&gt; 'BINARY',
<br />				PHPICALLIB_DATATYPE_BOOLEAN =&gt; 'BOOLEAN',
<br />				PHPICALLIB_DATATYPE_CAL_ADDRESS =&gt; 'CAL-ADDRESS',
<br />				PHPICALLIB_DATATYPE_DATE =&gt; 'DATE',
<br />				PHPICALLIB_DATATYPE_DATE_TIME =&gt; 'DATE-TIME',
<br />				PHPICALLIB_DATATYPE_DURATION =&gt; 'DURATION',
<br />				PHPICALLIB_DATATYPE_FLOAT =&gt; 'FLOAT',
<br />				PHPICALLIB_DATATYPE_INTEGER =&gt; 'INTEGER',
<br />				PHPICALLIB_DATATYPE_PERIOD =&gt; 'PERIOD',
<br />				PHPICALLIB_DATATYPE_RECUR =&gt; 'RECUR',
<br />				PHPICALLIB_DATATYPE_TEXT =&gt; 'TEXT',
<br />				PHPICALLIB_DATATYPE_TIME =&gt; 'TIME',
<br />				PHPICALLIB_DATATYPE_URI =&gt; 'URI',
<br />				PHPICALLIB_DATATYPE_UTC_OFFSET =&gt; 'UTC-OFFSET')</span>			(line <span class="line-number">82</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Map a data type id to it's string name.</p>
	<ul class="tags">
				<li><span class="field">var:</span> Keyed by PHPICALLIB_DATATYPE_?, value is a string</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	
		
		

</div>
<a name="var$DataType" id="$DataType"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$DataType</span>
			 = <span class="var-default"> 0</span>			(line <span class="line-number">66</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<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="methodFromDataType" id="FromDataType"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">static method FromDataType</span> (line <span class="line-number">128</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Convert a data type to it's defined name</p>
	<ul class="tags">
				<li><span class="field">return:</span> A &quot;name&quot; RFC2445 token</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">
			FromDataType
		</span>
					(<span class="var-type">integer</span>&nbsp;<span class="var-name">$Type</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$Type</span><span class="var-description">: one of the PHPICALLIB_DATATYPE_* values</span>			</li>
				</ul>
		
			
	</div>
<a name="methodToDataType" id="ToDataType"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">static method ToDataType</span> (line <span class="line-number">106</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Convert a data type name to it's defined type</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">
	    static
		<span class="method-result">int</span>
		<span class="method-name">
			ToDataType
		</span>
					(<span class="var-type">string</span>&nbsp;<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 &quot;name&quot; RFC2445 token</span>			</li>
				</ul>
		
			
	</div>

						
		</div>
	</div>


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