Location: PHPKode > projects > PhpiCalLib > doc/PhpiCalLib/PhpiCalLib_DataTypes_Time.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_Time</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_Time</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 time data type.</p>
<p class="description"><p></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.12">http://tools.ietf.org/html/draft-ietf-calsify-rfc2445bis-08#section-3.3.12</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_datatypes.php.html">/datatypes.php</a> (line <span class="field">801</span>)
		</p>
		
				
		<pre><a href="../PhpiCalLib/PhpiCalLib_DataType.html">PhpiCalLib_DataType</a>
   |
   --PhpiCalLib_DataTypes_Time</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_Time</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">integer</span>&nbsp;<span class="var-name">$TimeStamp</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$Utc</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">integer</span>
										<a href="#GetHours" title="details" class="method-name">GetHours</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">integer</span>
										<a href="#GetMinutes" title="details" class="method-name">GetMinutes</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">integer</span>
										<a href="#GetSeconds" title="details" class="method-name">GetSeconds</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#GetUtc" title="details" class="method-name">GetUtc</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="#SetHours" title="details" class="method-name">SetHours</a>
											(<span class="var-type">number</span>&nbsp;<span class="var-name">$Number</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#SetMinutes" title="details" class="method-name">SetMinutes</a>
											(<span class="var-type">number</span>&nbsp;<span class="var-name">$Number</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#SetSeconds" title="details" class="method-name">SetSeconds</a>
											(<span class="var-type">number</span>&nbsp;<span class="var-name">$Number</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#SetUtc" title="details" class="method-name">SetUtc</a>
											(<span class="var-type">bool</span>&nbsp;<span class="var-name">$value</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">814</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_Time</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">902</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Extract the date from the given 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">integer</span>&nbsp;<span class="var-name">$TimeStamp</span>, <span class="var-type">bool</span>&nbsp;<span class="var-name">$Utc</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">integer</span>
				<span class="var-name">$TimeStamp</span><span class="var-description">: Unix epoch WRT to UTC</span>			</li>
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$Utc</span><span class="var-description">: true to extract the date WRT to utc, false to extract the &quot;local time&quot;</span>			</li>
				</ul>
		
			
	</div>
<a name="methodGetHours" id="GetHours"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">GetHours</span> (line <span class="line-number">874</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access the number of hours</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">integer</span>
		<span class="method-name">
			GetHours
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodGetMinutes" id="GetMinutes"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">GetMinutes</span> (line <span class="line-number">854</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access the number of minutes</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">integer</span>
		<span class="method-name">
			GetMinutes
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodGetSeconds" id="GetSeconds"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">GetSeconds</span> (line <span class="line-number">834</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access the number of seconds</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">integer</span>
		<span class="method-name">
			GetSeconds
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodGetUtc" id="GetUtc"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">GetUtc</span> (line <span class="line-number">892</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Determine if the time is UTC or floating/local</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			GetUtc
		</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">926</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="methodSetHours" id="SetHours"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">SetHours</span> (line <span class="line-number">863</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the time-hour component of the time</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">
			SetHours
		</span>
					(<span class="var-type">number</span>&nbsp;<span class="var-name">$Number</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">number</span>
				<span class="var-name">$Number</span>			</li>
				</ul>
		
			
	</div>
<a name="methodSetMinutes" id="SetMinutes"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">SetMinutes</span> (line <span class="line-number">843</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the time-minute component of the time</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">
			SetMinutes
		</span>
					(<span class="var-type">number</span>&nbsp;<span class="var-name">$Number</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">number</span>
				<span class="var-name">$Number</span>			</li>
				</ul>
		
			
	</div>
<a name="methodSetSeconds" id="SetSeconds"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">SetSeconds</span> (line <span class="line-number">823</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the time-second component of the time</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">
			SetSeconds
		</span>
					(<span class="var-type">number</span>&nbsp;<span class="var-name">$Number</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">number</span>
				<span class="var-name">$Number</span>			</li>
				</ul>
		
			
	</div>
<a name="methodSetUtc" id="SetUtc"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">SetUtc</span> (line <span class="line-number">883</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the time-utc component of the time</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">
			SetUtc
		</span>
					(<span class="var-type">bool</span>&nbsp;<span class="var-name">$value</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$value</span><span class="var-description">: True for Utc, else false</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">948</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">916</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the seconds from midnight on the same day</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:13 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>
Return current item: PhpiCalLib