Location: PHPKode > projects > PhpiCalLib > doc/PhpiCalLib/PhpiCalLib_DataTypes_Duration.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_Duration</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_Duration</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 dur-value data type.</p>
<p class="description"><p><pre>        dur-value  = (["+"] / "-") "P" (dur-date / dur-time / dur-week)

        dur-date   = dur-day [dur-time]
        dur-time   = "T" (dur-hour / dur-minute / dur-second)
        dur-week   = 1*DIGIT "W"
        dur-hour   = 1*DIGIT "H" [dur-minute]
        dur-minute = 1*DIGIT "M" [dur-second]
        dur-second = 1*DIGIT "S"
        dur-day    = 1*DIGIT "D"</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.6">http://tools.ietf.org/html/draft-ietf-calsify-rfc2445bis-08#section-3.3.6</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_datatypes.php.html">/datatypes.php</a> (line <span class="field">457</span>)
		</p>
		
				
		<pre><a href="../PhpiCalLib/PhpiCalLib_DataType.html">PhpiCalLib_DataType</a>
   |
   --PhpiCalLib_DataTypes_Duration</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_Duration</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">integer</span>
										<a href="#GetDays" title="details" class="method-name">GetDays</a>
										()
									</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">bool</span>
										<a href="#GetPolarity" title="details" class="method-name">GetPolarity</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">integer</span>
										<a href="#GetWeeks" title="details" class="method-name">GetWeeks</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#SetDays" title="details" class="method-name">SetDays</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$Number</span>, <span class="var-type">number</span>&nbsp;<span class="var-name">$Days</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"></span>&nbsp;<span class="var-name">$Number</span>, <span class="var-type">number</span>&nbsp;<span class="var-name">$Hours</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"></span>&nbsp;<span class="var-name">$Number</span>, <span class="var-type">number</span>&nbsp;<span class="var-name">$Minutes</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#SetPolarity" title="details" class="method-name">SetPolarity</a>
											(<span class="var-type">bool</span>&nbsp;<span class="var-name">$Polarity</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="#SetWeeks" title="details" class="method-name">SetWeeks</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$Number</span>, <span class="var-type">number</span>&nbsp;<span class="var-name">$Week</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#ToString" title="details" class="method-name">ToString</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="evenrow">
	
	<div class="method-header">
		<span class="method-title">Constructor __construct</span> (line <span class="line-number">465</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_Duration</span>
		<span class="method-name">
			__construct
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodGetDays" id="GetDays"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">GetDays</span> (line <span class="line-number">556</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access the dur-day</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">
			GetDays
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodGetHours" id="GetHours"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">GetHours</span> (line <span class="line-number">533</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access the dur-hour</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="oddrow">
	
	<div class="method-header">
		<span class="method-title">GetMinutes</span> (line <span class="line-number">510</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access the dur-minute</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="methodGetPolarity" id="GetPolarity"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">GetPolarity</span> (line <span class="line-number">590</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">bool</span>
		<span class="method-name">
			GetPolarity
		</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">487</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access the dur-second</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="methodGetWeeks" id="GetWeeks"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">GetWeeks</span> (line <span class="line-number">582</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access the dur-week</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">
			GetWeeks
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodSetDays" id="SetDays"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">SetDays</span> (line <span class="line-number">543</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the dur-day component of the dur-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">
			SetDays
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$Number</span>, <span class="var-type">number</span>&nbsp;<span class="var-name">$Days</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">number</span>
				<span class="var-name">$Days</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$Number</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">520</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the dur-hour component of the dur-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">
			SetHours
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$Number</span>, <span class="var-type">number</span>&nbsp;<span class="var-name">$Hours</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">number</span>
				<span class="var-name">$Hours</span>			</li>
					<li>
				<span class="var-type"></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">497</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the dur-minute component of the dur-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">
			SetMinutes
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$Number</span>, <span class="var-type">number</span>&nbsp;<span class="var-name">$Minutes</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">number</span>
				<span class="var-name">$Minutes</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$Number</span>			</li>
				</ul>
		
			
	</div>
<a name="methodSetPolarity" id="SetPolarity"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">SetPolarity</span> (line <span class="line-number">597</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">
			SetPolarity
		</span>
					(<span class="var-type">bool</span>&nbsp;<span class="var-name">$Polarity</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">bool</span>
				<span class="var-name">$Polarity</span>			</li>
				</ul>
		
			
	</div>
<a name="methodSetSeconds" id="SetSeconds"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">SetSeconds</span> (line <span class="line-number">474</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the dur-second component of the dur-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">
			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="methodSetWeeks" id="SetWeeks"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">SetWeeks</span> (line <span class="line-number">566</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the dur-week component of the dur-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">
			SetWeeks
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$Number</span>, <span class="var-type">number</span>&nbsp;<span class="var-name">$Week</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">number</span>
				<span class="var-name">$Week</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$Number</span>			</li>
				</ul>
		
			
	</div>
<a name="methodToString" id="ToString"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">ToString</span> (line <span class="line-number">628</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>
							<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:12 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
	</p>
	</div></body>
</html>
Return current item: PhpiCalLib