Location: PHPKode > projects > PhpiCalLib > doc/PhpiCalLib/PhpiCalLib_DataTypes_DateTime.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_DataTypes_DateTime</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_DateTime</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 date-time data type.</p>
<p class="description"><p><pre>        date-time  = date "T" time ;As specified in the date and time
                                   ;value definitions</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.5">http://tools.ietf.org/html/draft-ietf-calsify-rfc2445bis-08#section-3.3.5</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_datatypes.php.html">/datatypes.php</a> (line <span class="field">351</span>)
		</p>
		
				
		<pre><a href="../PhpiCalLib/PhpiCalLib_DataType.html">PhpiCalLib_DataType</a>
   |
   --PhpiCalLib_DataTypes_DateTime</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_DateTime</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#FromTimeStamp" title="details" class="method-name">FromTimeStamp</a>
											(<span class="var-type">number</span>&nbsp;<span class="var-name">$Time</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$Utc</span>)
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../PhpiCalLib/PhpiCalLib_DataTypes_Date.html">PhpiCalLib_DataTypes_Date</a></span>
										<a href="#GetDate" title="details" class="method-name">GetDate</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result"><a href="../PhpiCalLib/PhpiCalLib_DataTypes_Time.html">PhpiCalLib_DataTypes_Time</a></span>
										<a href="#GetTime" title="details" class="method-name">GetTime</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>&nbsp;<span class="var-name">$EncodedString</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#SetDate" title="details" class="method-name">SetDate</a>
											(<span class="var-type"><a href="../PhpiCalLib/PhpiCalLib_DataTypes_Date.html">PhpiCalLib_DataTypes_Date</a></span>&nbsp;<span class="var-name">$Date</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#SetTime" title="details" class="method-name">SetTime</a>
											(<span class="var-type"><a href="../PhpiCalLib/PhpiCalLib_DataTypes_Time.html">PhpiCalLib_DataTypes_Time</a></span>&nbsp;<span class="var-name">$Time</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#ToString" title="details" class="method-name">ToString</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">integer</span>
										<a href="#ToTimeStamp" title="details" class="method-name">ToTimeStamp</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="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">355</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_DataTypes_DateTime</span>
		<span class="method-name">
			__construct
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodFromTimeStamp" id="FromTimeStamp"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">FromTimeStamp</span> (line <span class="line-number">404</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the time from a unix timestamp</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">
			FromTimeStamp
		</span>
					(<span class="var-type">number</span>&nbsp;<span class="var-name">$Time</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$Utc</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">number</span>
				<span class="var-name">$Time</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$Utc</span><span class="var-description">: true to store in utc, false to store in &quot;floating time&quot;, TZ specified by the TZID parameter</span>			</li>
				</ul>
		
			
	</div>
<a name="methodGetDate" id="GetDate"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">GetDate</span> (line <span class="line-number">364</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"><a href="../PhpiCalLib/PhpiCalLib_DataTypes_Date.html">PhpiCalLib_DataTypes_Date</a></span>
		<span class="method-name">
			GetDate
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodGetTime" id="GetTime"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">GetTime</span> (line <span class="line-number">378</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"><a href="../PhpiCalLib/PhpiCalLib_DataTypes_Time.html">PhpiCalLib_DataTypes_Time</a></span>
		<span class="method-name">
			GetTime
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodParse" id="Parse"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Parse</span> (line <span class="line-number">420</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Extract the date-time 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>&nbsp;<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="methodSetDate" id="SetDate"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">SetDate</span> (line <span class="line-number">371</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">void</span>
		<span class="method-name">
			SetDate
		</span>
					(<span class="var-type"><a href="../PhpiCalLib/PhpiCalLib_DataTypes_Date.html">PhpiCalLib_DataTypes_Date</a></span>&nbsp;<span class="var-name">$Date</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../PhpiCalLib/PhpiCalLib_DataTypes_Date.html">PhpiCalLib_DataTypes_Date</a></span>
				<span class="var-name">$Date</span>			</li>
				</ul>
		
			
	</div>
<a name="methodSetTime" id="SetTime"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">SetTime</span> (line <span class="line-number">385</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">void</span>
		<span class="method-name">
			SetTime
		</span>
					(<span class="var-type"><a href="../PhpiCalLib/PhpiCalLib_DataTypes_Time.html">PhpiCalLib_DataTypes_Time</a></span>&nbsp;<span class="var-name">$Time</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"><a href="../PhpiCalLib/PhpiCalLib_DataTypes_Time.html">PhpiCalLib_DataTypes_Time</a></span>
				<span class="var-name">$Time</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">437</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Convert to 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>
<a name="methodToTimeStamp" id="ToTimeStamp"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">ToTimeStamp</span> (line <span class="line-number">394</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the time WRT to midnight Jan 1st 1970, UTC</p>
	<ul class="tags">
				<li><span class="field">return:</span> Seconds since January 1 1970 00:00:00 GMT</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">integer</span>
		<span class="method-name">
			ToTimeStamp
		</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:11 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>
Return current item: PhpiCalLib