Location: PHPKode > projects > PhpiCalLib > doc/PhpiCalLib/PhpiCalLib_Properties_DateOrDateTimeProperty.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_Properties_DateOrDateTimeProperty</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_Properties_DateOrDateTimeProperty</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-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">Many properties specify a value of type date-time / date.  This base class can be used for those.</p>
		<p class="notes">
			Located in <a class="field" href="_dateordatetimeproperties.php.html">/dateordatetimeproperties.php</a> (line <span class="field">31</span>)
		</p>
		
				
		<pre><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html">PhpiCalLib_ContentLine</a>
   |
   --<a href="../PhpiCalLib/PhpiCalLib_Properties_UnencodedProperty.html">PhpiCalLib_Properties_UnencodedProperty</a>
      |
      --PhpiCalLib_Properties_DateOrDateTimeProperty</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-vars">Vars</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_Properties_DtEndProperty.html">PhpiCalLib_Properties_DtEndProperty</a></td>
					<td>
											The DTEND property.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../PhpiCalLib/PhpiCalLib_Properties_DueProperty.html">PhpiCalLib_Properties_DueProperty</a></td>
					<td>
											The DUE property.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../PhpiCalLib/PhpiCalLib_Properties_DtStartProperty.html">PhpiCalLib_Properties_DtStartProperty</a></td>
					<td>
											The DTSTART property.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../PhpiCalLib/PhpiCalLib_Properties_RecurrenceIdProperty.html">PhpiCalLib_Properties_RecurrenceIdProperty</a></td>
					<td>
											The RECURRENCE-ID property.
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../PhpiCalLib/PhpiCalLib_Properties_ExDateProperty.html">PhpiCalLib_Properties_ExDateProperty</a></td>
					<td>
											The EXDATE property.
										</td>
				</tr>
							</table>
		</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-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_DateType_DateTime</span>
										<a href="#GetDateTimeValue" title="details" class="method-name">GetDateTimeValue</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">PhpiCalLib_DateType_Date</span>
										<a href="#GetDateValue" title="details" class="method-name">GetDateValue</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">PhpiCalLib_DateType_Time</span>
										<a href="#GetTimeValue" title="details" class="method-name">GetTimeValue</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#SetDateFromTimeStamp" title="details" class="method-name">SetDateFromTimeStamp</a>
											(<span class="var-type">number</span>&nbsp;<span class="var-name">$Time</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#SetDateTimeFromTimeStamp" title="details" class="method-name">SetDateTimeFromTimeStamp</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">void</span>
										<a href="#SetDateTimeValue" title="details" class="method-name">SetDateTimeValue</a>
											(<span class="var-type">PhpiCalLib_DateType_DateTime</span>&nbsp;<span class="var-name">$DateTime</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#SetDateValue" title="details" class="method-name">SetDateValue</a>
											(<span class="var-type">PhpiCalLib_DateType_Date</span>&nbsp;<span class="var-name">$Date</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#SetEncodedValue" title="details" class="method-name">SetEncodedValue</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$Text</span>)
									</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-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">
			
							<h4>Inherited Variables</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html">PhpiCalLib_ContentLine</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#var$aParameters">PhpiCalLib_ContentLine::$aParameters</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#var$aPermittedParameters">PhpiCalLib_ContentLine::$aPermittedParameters</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#var$EncodedValue">PhpiCalLib_ContentLine::$EncodedValue</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#var$IanaTokenRegex">PhpiCalLib_ContentLine::$IanaTokenRegex</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#var$Name">PhpiCalLib_ContentLine::$Name</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#var$NameSplitRegex">PhpiCalLib_ContentLine::$NameSplitRegex</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#var$Type">PhpiCalLib_ContentLine::$Type</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-descendents">Descendents</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="methodGetDateTimeValue" id="GetDateTimeValue"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">GetDateTimeValue</span> (line <span class="line-number">80</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access the date-time of the value.  This will return null if the value is a date not a date-time</p>
	<ul class="tags">
				<li><span class="field">return:</span> or null</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">PhpiCalLib_DateType_DateTime</span>
		<span class="method-name">
			GetDateTimeValue
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodGetDateValue" id="GetDateValue"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">GetDateValue</span> (line <span class="line-number">55</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access the Date of the value.</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">PhpiCalLib_DateType_Date</span>
		<span class="method-name">
			GetDateValue
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodGetTimeValue" id="GetTimeValue"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">GetTimeValue</span> (line <span class="line-number">68</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access the Time of the value.  This will return null if the value is a date not a date-time</p>
	<ul class="tags">
				<li><span class="field">return:</span> or null</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">PhpiCalLib_DateType_Time</span>
		<span class="method-name">
			GetTimeValue
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodSetDateFromTimeStamp" id="SetDateFromTimeStamp"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">SetDateFromTimeStamp</span> (line <span class="line-number">134</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set to a date-time property as represented by 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">
			SetDateFromTimeStamp
		</span>
					(<span class="var-type">number</span>&nbsp;<span class="var-name">$Time</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">number</span>
				<span class="var-name">$Time</span><span class="var-description">: Unix timestamp</span>			</li>
				</ul>
		
			
	</div>
<a name="methodSetDateTimeFromTimeStamp" id="SetDateTimeFromTimeStamp"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">SetDateTimeFromTimeStamp</span> (line <span class="line-number">108</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set to a date-time property as represented by 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">
			SetDateTimeFromTimeStamp
		</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><span class="var-description">: Unix timestamp</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="methodSetDateTimeValue" id="SetDateTimeValue"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">SetDateTimeValue</span> (line <span class="line-number">120</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the value as a DateTime</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">
			SetDateTimeValue
		</span>
					(<span class="var-type">PhpiCalLib_DateType_DateTime</span>&nbsp;<span class="var-name">$DateTime</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">PhpiCalLib_DateType_DateTime</span>
				<span class="var-name">$DateTime</span>			</li>
				</ul>
		
			
	</div>
<a name="methodSetDateValue" id="SetDateValue"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">SetDateValue</span> (line <span class="line-number">145</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the value as a Date</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">
			SetDateValue
		</span>
					(<span class="var-type">PhpiCalLib_DateType_Date</span>&nbsp;<span class="var-name">$Date</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">PhpiCalLib_DateType_Date</span>
				<span class="var-name">$Date</span>			</li>
				</ul>
		
			
	</div>
<a name="methodSetEncodedValue" id="SetEncodedValue"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">SetEncodedValue</span> (line <span class="line-number">161</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Overridden to do extra parsing to extract the $TextValue</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">
			SetEncodedValue
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$Text</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$Text</span>			</li>
				</ul>
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodSetEncodedValue">PhpiCalLib_ContentLine::SetEncodedValue()</a></dt>
						<dd>Sets the property value by specifying the encoded value</dd>
					</dl>
			
	</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">94</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return a timestamp WRT to UTC.</p>
<p class="description"><p>If the value is a Date, then it will be set to midnight.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> Number of seconds since 1970 UTC</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_Properties_UnencodedProperty.html">PhpiCalLib_Properties_UnencodedProperty</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Properties_UnencodedProperty.html#methodGetValue">PhpiCalLib_Properties_UnencodedProperty::GetValue()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Properties_UnencodedProperty.html#methodSetValue">PhpiCalLib_Properties_UnencodedProperty::SetValue()</a></span><br>
											</blockquote>
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html">PhpiCalLib_ContentLine</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#method__construct">PhpiCalLib_ContentLine::__construct()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodAddParameter">PhpiCalLib_ContentLine::AddParameter()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodAddParameterPermitted">PhpiCalLib_ContentLine::AddParameterPermitted()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodCopy">PhpiCalLib_ContentLine::Copy()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodCreate">PhpiCalLib_ContentLine::Create()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodCreateContentLine">PhpiCalLib_ContentLine::CreateContentLine()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodGetEncodedValue">PhpiCalLib_ContentLine::GetEncodedValue()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodGetName">PhpiCalLib_ContentLine::GetName()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodGetParameter">PhpiCalLib_ContentLine::GetParameter()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodGetParameters">PhpiCalLib_ContentLine::GetParameters()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodGetType">PhpiCalLib_ContentLine::GetType()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodRemoveParameter">PhpiCalLib_ContentLine::RemoveParameter()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodRemoveParameterPermitted">PhpiCalLib_ContentLine::RemoveParameterPermitted()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodSetEncodedValue">PhpiCalLib_ContentLine::SetEncodedValue()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodSetName">PhpiCalLib_ContentLine::SetName()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodSetParameter">PhpiCalLib_ContentLine::SetParameter()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodSetParameterPermitted">PhpiCalLib_ContentLine::SetParameterPermitted()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodSetParameters">PhpiCalLib_ContentLine::SetParameters()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodSetType">PhpiCalLib_ContentLine::SetType()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodToContentLines">PhpiCalLib_ContentLine::ToContentLines()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodToPropertyName">PhpiCalLib_ContentLine::ToPropertyName()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodToPropertyType">PhpiCalLib_ContentLine::ToPropertyType()</a></span><br>
													<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_ContentLine.html#methodToString">PhpiCalLib_ContentLine::ToString()</a></span><br>
											</blockquote>
										
		</div>
	</div>


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