Location: PHPKode > scripts > Calendar Solution > convissor-calendar_solution-ff69243/include/CalendarSolution/doc/phpdoc-output/CalendarSolution/CalendarSolution_FrequentEvent_List.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 CalendarSolution_FrequentEvent_List</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 CalendarSolution_FrequentEvent_List</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>)
						
											<a href="#sec-consts">Constants</a>
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The means to output a list of Frequent Events</p>
	<ul class="tags">
				<li><span class="field">author:</span> Daniel Convissor &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</li>
				<li><span class="field">copyright:</span> The Analysis and Solutions Company, 2002-2012</li>
				<li><span class="field">license:</span> <a href="http://www.analysisandsolutions.com/software/license.htm">Simple Public License</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_include---CalendarSolution---FrequentEvent---List.php.html">/include/CalendarSolution/FrequentEvent/List.php</a> (line <span class="field">20</span>)
		</p>
		
				
		<pre><a href="../CalendarSolution/CalendarSolution.html">CalendarSolution</a>
   |
   --<a href="../CalendarSolution/CalendarSolution_FrequentEvent.html">CalendarSolution_FrequentEvent</a>
      |
      --CalendarSolution_FrequentEvent_List</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-consts">Constants</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">string</span>
										<a href="#get_event_formatted" title="details" class="method-name">get_event_formatted</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$event</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#get_list_close" title="details" class="method-name">get_list_close</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#get_list_open" title="details" class="method-name">get_list_open</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#get_rendering" title="details" class="method-name">get_rendering</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#get_row_close" title="details" class="method-name">get_row_close</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#get_row_open" title="details" class="method-name">get_row_open</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#run_query" title="details" class="method-name">run_query</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-consts">Constants</a>
							
										| 
									<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="../CalendarSolution/CalendarSolution.html">CalendarSolution</a></span></p>
					<blockquote>
													<span class="var-title">
								<span class="var-name"><a href="../CalendarSolution/CalendarSolution.html#var$cache">CalendarSolution::$cache</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../CalendarSolution/CalendarSolution.html#var$cache_available">CalendarSolution::$cache_available</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../CalendarSolution/CalendarSolution.html#var$csrf_token_name">CalendarSolution::$csrf_token_name</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../CalendarSolution/CalendarSolution.html#var$data">CalendarSolution::$data</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../CalendarSolution/CalendarSolution.html#var$http_host">CalendarSolution::$http_host</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../CalendarSolution/CalendarSolution.html#var$sql">CalendarSolution::$sql</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../CalendarSolution/CalendarSolution.html#var$uri">CalendarSolution::$uri</a></span><br>
							</span>
													<span class="var-title">
								<span class="var-name"><a href="../CalendarSolution/CalendarSolution.html#var$use_cache">CalendarSolution::$use_cache</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-consts">Constants</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="methodget_event_formatted" id="get_event_formatted"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">get_event_formatted</span> (line <span class="line-number">26</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">return:</span> the HTML for one event</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_event_formatted
		</span>
					(<span class="var-type">array</span>&nbsp;<span class="var-name">$event</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">array</span>
				<span class="var-name">$event</span><span class="var-description">: an associative array of a given event</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_list_close" id="get_list_close"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">get_list_close</span> (line <span class="line-number">48</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">return:</span> the HTML for closing a list</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_list_close
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodget_list_open" id="get_list_open"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">get_list_open</span> (line <span class="line-number">55</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">return:</span> the HTML for opening a list</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_list_open
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodget_rendering" id="get_rendering"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">get_rendering</span> (line <span class="line-number">81</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Produces a list of events laid out in a list format</p>
	<ul class="tags">
				<li><span class="field">return:</span> the complete HTML of the events and the related interface</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">uses:</span> <a href="../CalendarSolution/CalendarSolution_FrequentEvent_List.html#methodrun_query">CalendarSolution_FrequentEvent_List::run_query()</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_rendering
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodget_row_close" id="get_row_close"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">get_row_close</span> (line <span class="line-number">62</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">return:</span> the HTML for closing a row</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_row_close
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodget_row_open" id="get_row_open"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">get_row_open</span> (line <span class="line-number">70</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">return:</span> the HTML for opening a row</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_row_open
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$class</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$class</span><span class="var-description">: the CSS class name for this row</span>			</li>
				</ul>
		
			
	</div>
<a name="methodrun_query" id="run_query"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">run_query</span> (line <span class="line-number">110</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Assembles the query string then executes it</p>
	<ul class="tags">
				<li><span class="field">throws:</span> CalendarSolution_Exception if to is later than from</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_FrequentEvent_List.html#methodget_rendering">CalendarSolution_FrequentEvent_List::get_rendering()</a></li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			run_query
		</span>
				()
			</div>
	
		
			<hr class="separator" />
		<div class="notes">Redefinition of:</div>
		<dl>
			<dt><a href="../CalendarSolution/CalendarSolution_FrequentEvent.html#methodrun_query">CalendarSolution_FrequentEvent::run_query()</a></dt>
						<dd>Assembles the query string, executes it and stores the result in  $this-&gt;data</dd>
					</dl>
			
	</div>
							<h4>Inherited Methods</h4>
				<a name='inherited_methods'><!-- --></a>	
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../CalendarSolution/CalendarSolution_FrequentEvent.html">CalendarSolution_FrequentEvent</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution_FrequentEvent.html#methodrun_query">CalendarSolution_FrequentEvent::run_query()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution_FrequentEvent.html#methodset_data_from_query">CalendarSolution_FrequentEvent::set_data_from_query()</a></span><br>
											</blockquote>
									<!-- =========== Summary =========== -->
					<p>Inherited From <span class="classname"><a href="../CalendarSolution/CalendarSolution.html">CalendarSolution</a></span></p>
					<blockquote>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#method__construct">CalendarSolution::__construct()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodconvert_windows_characters">CalendarSolution::convert_windows_characters()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodescape_data_for_html">CalendarSolution::escape_data_for_html()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodescape_for_icalendar">CalendarSolution::escape_for_icalendar()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodflush_cache">CalendarSolution::flush_cache()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodformat_date">CalendarSolution::format_date()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodget_admin_navigation">CalendarSolution::get_admin_navigation()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodget_credit">CalendarSolution::get_credit()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodget_css">CalendarSolution::get_css()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodget_date_from_request">CalendarSolution::get_date_from_request()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodget_errors">CalendarSolution::get_errors()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodget_event_formatted_icalendar">CalendarSolution::get_event_formatted_icalendar()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodget_int_array_from_request">CalendarSolution::get_int_array_from_request()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodget_int_from_request">CalendarSolution::get_int_from_request()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodget_string_from_request">CalendarSolution::get_string_from_request()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodis_admin">CalendarSolution::is_admin()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodis_cache_available">CalendarSolution::is_cache_available()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodset_data_empty">CalendarSolution::set_data_empty()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodset_data_from_post">CalendarSolution::set_data_from_post()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodset_uri">CalendarSolution::set_uri()</a></span><br>
													<span class="method-name"><a href="../CalendarSolution/CalendarSolution.html#methodvalidate_csrf_token">CalendarSolution::validate_csrf_token()</a></span><br>
											</blockquote>
										
		</div>
	</div>

	<a name="sec-consts"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constants</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</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">
										<h4>Inherited Constants</h4>
				<A NAME='inherited_vars'><!-- --></A>
									<p>Inherited from <span class="classname"><a href="../CalendarSolution/CalendarSolution.html">CalendarSolution</a></span></p>
					<blockquote>
													<span class="const-title">
								<span class="const-name"><a href="../CalendarSolution/CalendarSolution.html#constDATE_FORMAT_FULL">CalendarSolution::DATE_FORMAT_FULL</a></span><br>
							</span>
													<span class="const-title">
								<span class="const-name"><a href="../CalendarSolution/CalendarSolution.html#constDATE_FORMAT_ICALENDAR">CalendarSolution::DATE_FORMAT_ICALENDAR</a></span><br>
							</span>
													<span class="const-title">
								<span class="const-name"><a href="../CalendarSolution/CalendarSolution.html#constDATE_FORMAT_LONG">CalendarSolution::DATE_FORMAT_LONG</a></span><br>
							</span>
													<span class="const-title">
								<span class="const-name"><a href="../CalendarSolution/CalendarSolution.html#constDATE_FORMAT_MEDIUM">CalendarSolution::DATE_FORMAT_MEDIUM</a></span><br>
							</span>
													<span class="const-title">
								<span class="const-name"><a href="../CalendarSolution/CalendarSolution.html#constDATE_FORMAT_NAME_NUMBER">CalendarSolution::DATE_FORMAT_NAME_NUMBER</a></span><br>
							</span>
													<span class="const-title">
								<span class="const-name"><a href="../CalendarSolution/CalendarSolution.html#constDATE_FORMAT_SHORT">CalendarSolution::DATE_FORMAT_SHORT</a></span><br>
							</span>
													<span class="const-title">
								<span class="const-name"><a href="../CalendarSolution/CalendarSolution.html#constDATE_FORMAT_TIME_12AP">CalendarSolution::DATE_FORMAT_TIME_12AP</a></span><br>
							</span>
													<span class="const-title">
								<span class="const-name"><a href="../CalendarSolution/CalendarSolution.html#constDATE_FORMAT_TIME_24">CalendarSolution::DATE_FORMAT_TIME_24</a></span><br>
							</span>
													<span class="const-title">
								<span class="const-name"><a href="../CalendarSolution/CalendarSolution.html#constDATE_FORMAT_TIME_ICALENDAR">CalendarSolution::DATE_FORMAT_TIME_ICALENDAR</a></span><br>
							</span>
													<span class="const-title">
								<span class="const-name"><a href="../CalendarSolution/CalendarSolution.html#constLINK_TO_CALENDAR_URI">CalendarSolution::LINK_TO_CALENDAR_URI</a></span><br>
							</span>
													<span class="const-title">
								<span class="const-name"><a href="../CalendarSolution/CalendarSolution.html#constLINK_TO_DETAIL_PAGE">CalendarSolution::LINK_TO_DETAIL_PAGE</a></span><br>
							</span>
													<span class="const-title">
								<span class="const-name"><a href="../CalendarSolution/CalendarSolution.html#constLINK_TO_FREQUENT_EVENT_URI">CalendarSolution::LINK_TO_FREQUENT_EVENT_URI</a></span><br>
							</span>
													<span class="const-title">
								<span class="const-name"><a href="../CalendarSolution/CalendarSolution.html#constLINK_TO_NONE">CalendarSolution::LINK_TO_NONE</a></span><br>
							</span>
													<span class="const-title">
								<span class="const-name"><a href="../CalendarSolution/CalendarSolution.html#constSTATUS_CANCELLED">CalendarSolution::STATUS_CANCELLED</a></span><br>
							</span>
													<span class="const-title">
								<span class="const-name"><a href="../CalendarSolution/CalendarSolution.html#constSTATUS_FULL">CalendarSolution::STATUS_FULL</a></span><br>
							</span>
													<span class="const-title">
								<span class="const-name"><a href="../CalendarSolution/CalendarSolution.html#constSTATUS_OPEN">CalendarSolution::STATUS_OPEN</a></span><br>
							</span>
											</blockquote> 
										
		</div>
	</div>

	<p class="notes" id="credit">
		Documentation generated on Wed, 21 Mar 2012 14:16:43 -0400 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.4</a>
	</p>
	</div></body>
</html>
Return current item: Calendar Solution