Location: PHPKode > scripts > Calendar Solution > convissor-calendar_solution-ff69243/include/CalendarSolution/doc/phpdoc-output/CalendarSolution/CalendarSolution.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</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</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
						|											<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
											<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
						
			</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The base class</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">see:</span> <a href="../CalendarSolution/CalendarSolution_List_Title.html#methodget_rendering">CalendarSolution_List_Title::get_rendering()</a></li>
				<li><span class="field">see:</span> <a href="../CalendarSolution/CalendarSolution_List.html#methodfactory_chosen_view">CalendarSolution_List::factory_chosen_view()</a></li>
				<li><span class="field">see:</span> <a href="../CalendarSolution/CalendarSolution_List_Ul.html#methodget_rendering">CalendarSolution_List_Ul::get_rendering()</a></li>
				<li><span class="field">see:</span> <a href="../CalendarSolution/CalendarSolution_List_QuickTable.html#methodget_rendering">CalendarSolution_List_QuickTable::get_rendering()</a></li>
				<li><span class="field">see:</span> <a href="../CalendarSolution/CalendarSolution_List_Calendar.html#methodget_rendering">CalendarSolution_List_Calendar::get_rendering()</a></li>
				<li><span class="field">see:</span> <a href="../CalendarSolution/CalendarSolution_List_MonthTitle.html#methodget_rendering">CalendarSolution_List_MonthTitle::get_rendering()</a></li>
				<li><span class="field">see:</span> <a href="../CalendarSolution/CalendarSolution_List_DetailTable.html#methodget_rendering">CalendarSolution_List_DetailTable::get_rendering()</a></li>
				<li><span class="field">see:</span> <a href="../CalendarSolution/CalendarSolution_List_List.html#methodget_rendering">CalendarSolution_List_List::get_rendering()</a></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.php.html">/include/CalendarSolution.php</a> (line <span class="field">34</span>)
		</p>
		
				
		<pre></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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
								|															<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">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="../CalendarSolution/CalendarSolution_Category.html">CalendarSolution_Category</a></td>
					<td>
											The parent class for viewing and editing a Category
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../CalendarSolution/CalendarSolution_Detail.html">CalendarSolution_Detail</a></td>
					<td>
											The parent class for viewing and editing a specific event
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../CalendarSolution/CalendarSolution_FeaturedPage.html">CalendarSolution_FeaturedPage</a></td>
					<td>
											The parent class for viewing and editing a Featured Page
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../CalendarSolution/CalendarSolution_FrequentEvent.html">CalendarSolution_FrequentEvent</a></td>
					<td>
											The parent class for viewing and editing a Frequent Event
										</td>
				</tr>
								<tr>
					<td style="padding-right: 2em"><a href="../CalendarSolution/CalendarSolution_List.html">CalendarSolution_List</a></td>
					<td>
											The parent class for displaying collections of events
										</td>
				</tr>
							</table>
		</div>
	</div>

	<a name="sec-const-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Class Constant Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendants</a> |
						<span class="disabled">Constants</span> (<a href="#sec-consts">details</a>)
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
				 
				|
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="const-summary">
								<div class="const-title">
					<a href="#DATE_FORMAT_FULL" title="details" class="const-name">DATE_FORMAT_FULL</a> = 					<span class="var-type"> 'l, F jS, Y'</span>

				</div>
								<div class="const-title">
					<a href="#DATE_FORMAT_ICALENDAR" title="details" class="const-name">DATE_FORMAT_ICALENDAR</a> = 					<span class="var-type"> 'Ymd'</span>

				</div>
								<div class="const-title">
					<a href="#DATE_FORMAT_LONG" title="details" class="const-name">DATE_FORMAT_LONG</a> = 					<span class="var-type"> 'D, M jS'</span>

				</div>
								<div class="const-title">
					<a href="#DATE_FORMAT_MEDIUM" title="details" class="const-name">DATE_FORMAT_MEDIUM</a> = 					<span class="var-type"> 'D, n/j'</span>

				</div>
								<div class="const-title">
					<a href="#DATE_FORMAT_NAME_NUMBER" title="details" class="const-name">DATE_FORMAT_NAME_NUMBER</a> = 					<span class="var-type"> 'l jS'</span>

				</div>
								<div class="const-title">
					<a href="#DATE_FORMAT_SHORT" title="details" class="const-name">DATE_FORMAT_SHORT</a> = 					<span class="var-type"> 'n/j'</span>

				</div>
								<div class="const-title">
					<a href="#DATE_FORMAT_TIME_12AP" title="details" class="const-name">DATE_FORMAT_TIME_12AP</a> = 					<span class="var-type"> 'g:i\&amp;\n\b\s\p\;a'</span>

				</div>
								<div class="const-title">
					<a href="#DATE_FORMAT_TIME_24" title="details" class="const-name">DATE_FORMAT_TIME_24</a> = 					<span class="var-type"> 'H:i'</span>

				</div>
								<div class="const-title">
					<a href="#DATE_FORMAT_TIME_ICALENDAR" title="details" class="const-name">DATE_FORMAT_TIME_ICALENDAR</a> = 					<span class="var-type"> 'Ymd\THis'</span>

				</div>
								<div class="const-title">
					<a href="#LINK_TO_CALENDAR_URI" title="details" class="const-name">LINK_TO_CALENDAR_URI</a> = 					<span class="var-type"> 4</span>

				</div>
								<div class="const-title">
					<a href="#LINK_TO_DETAIL_PAGE" title="details" class="const-name">LINK_TO_DETAIL_PAGE</a> = 					<span class="var-type"> 2</span>

				</div>
								<div class="const-title">
					<a href="#LINK_TO_FREQUENT_EVENT_URI" title="details" class="const-name">LINK_TO_FREQUENT_EVENT_URI</a> = 					<span class="var-type"> 3</span>

				</div>
								<div class="const-title">
					<a href="#LINK_TO_NONE" title="details" class="const-name">LINK_TO_NONE</a> = 					<span class="var-type"> 1</span>

				</div>
								<div class="const-title">
					<a href="#STATUS_CANCELLED" title="details" class="const-name">STATUS_CANCELLED</a> = 					<span class="var-type"> 3</span>

				</div>
								<div class="const-title">
					<a href="#STATUS_FULL" title="details" class="const-name">STATUS_FULL</a> = 					<span class="var-type"> 2</span>

				</div>
								<div class="const-title">
					<a href="#STATUS_OPEN" title="details" class="const-name">STATUS_OPEN</a> = 					<span class="var-type"> 1</span>

				</div>
							</div>
		</div>
	</div>

	<a name="sec-var-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Variable Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
							<a href="#sec-descendents">Descendents</a> |
						<span class="disabled">Vars</span> (<a href="#sec-vars">details</a>)
							| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
															<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
					</div>
		<div class="info-box-body">
			<div class="var-summary">
																																																																																<div class="var-title">
					<span class="var-type"><a href="../CalendarSolution/CalendarSolution_Cache.html">CalendarSolution_Cache</a></span>
					<a href="#$cache" title="details" class="var-name">$cache</a>
				</div>
																<div class="var-title">
					<span class="var-type">bool</span>
					<a href="#$cache_available" title="details" class="var-name">$cache_available</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$csrf_token_name" title="details" class="var-name">$csrf_token_name</a>
				</div>
																<div class="var-title">
					<span class="var-type">array</span>
					<a href="#$data" title="details" class="var-name">$data</a>
				</div>
																<div class="var-title">
					<span class="var-type">string</span>
					<a href="#$http_host" title="details" class="var-name">$http_host</a>
				</div>
																<div class="var-title">
					<span class="var-type">SQLSolution_General</span>
					<a href="#$sql" title="details" class="var-name">$sql</a>
				</div>
																<div class="var-title">
					<span class="var-type">array</span>
					<a href="#$uri" title="details" class="var-name">$uri</a>
				</div>
																<div class="var-title">
					<span class="var-type">bool</span>
					<a href="#$use_cache" title="details" class="var-name">$use_cache</a>
				</div>
											</div>
		</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-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
															<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</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">CalendarSolution</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											([<span class="var-type">string</span>&nbsp;<span class="var-name">$dbms</span> = <span class="var-default">CALENDAR_SOLUTION_DBMS</span>])
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#convert_windows_characters" title="details" class="method-name">convert_windows_characters</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$in</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#escape_data_for_html" title="details" class="method-name">escape_data_for_html</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#escape_for_icalendar" title="details" class="method-name">escape_for_icalendar</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#flush_cache" title="details" class="method-name">flush_cache</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#format_date" title="details" class="method-name">format_date</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$in</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$format</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#get_admin_navigation" title="details" class="method-name">get_admin_navigation</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#get_credit" title="details" class="method-name">get_credit</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#get_css" title="details" class="method-name">get_css</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">mixed</span>
										<a href="#get_date_from_request" title="details" class="method-name">get_date_from_request</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#get_errors" title="details" class="method-name">get_errors</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#get_event_formatted_icalendar" title="details" class="method-name">get_event_formatted_icalendar</a>
											(<span class="var-type">array</span>&nbsp;<span class="var-name">$event</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">mixed</span>
										<a href="#get_int_array_from_request" title="details" class="method-name">get_int_array_from_request</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">mixed</span>
										<a href="#get_int_from_request" title="details" class="method-name">get_int_from_request</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">mixed</span>
										<a href="#get_string_from_request" title="details" class="method-name">get_string_from_request</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
									</div>
														
				<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#is_admin" title="details" class="method-name">is_admin</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#is_cache_available" title="details" class="method-name">is_cache_available</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#set_data_empty" title="details" class="method-name">set_data_empty</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#set_data_from_post" title="details" class="method-name">set_data_from_post</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#set_uri" title="details" class="method-name">set_uri</a>
										()
									</div>
														
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#validate_csrf_token" title="details" class="method-name">validate_csrf_token</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-const-summary">Constants</a> (<a href="#sec-consts">details</a>)
							
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			
<a name="var$cache" id="$cache"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type"><a href="../CalendarSolution/CalendarSolution_Cache.html">CalendarSolution_Cache</a></span>
			<span class="var-name">$cache</span>
						(line <span class="line-number">72</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The cache object</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_List.html#methodrun_query">CalendarSolution_List::run_query()</a> - to cache the results, if possible</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution.html#method__construct">CalendarSolution::__construct()</a> - to store the Calendar Solution Cache
       object instantiated by the Calendar Solution's constructor</li>
			</ul>
	
	
		
		

</div>
<a name="var$cache_available" id="$cache_available"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">bool</span>
			<span class="var-name">$cache_available</span>
			 = <span class="var-default"> false</span>			(line <span class="line-number">78</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Is caching available?</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
<a name="var$csrf_token_name" id="$csrf_token_name"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$csrf_token_name</span>
						(line <span class="line-number">85</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The name of the token used for protecting our admin forms against</p>
<p class="description"><p>Cross Site Request Forgeries</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_FrequentEvent_Form.html#method__construct">CalendarSolution_FrequentEvent_Form::__construct()</a> - to hold the token's name</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_FeaturedPage_Form.html#method__construct">CalendarSolution_FeaturedPage_Form::__construct()</a> - to hold the token's name</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_Detail_Form.html#method__construct">CalendarSolution_Detail_Form::__construct()</a> - to hold the token's name</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_Category_Form.html#method__construct">CalendarSolution_Category_Form::__construct()</a> - to hold the token's name</li>
			</ul>
	
	
		
		

</div>
<a name="var$data" id="$data"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$data</span>
			 = <span class="var-default">array()</span>			(line <span class="line-number">91</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">An associative array of the given item's data</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_FeaturedPage.html#methodset_data_from_query">CalendarSolution_FeaturedPage::set_data_from_query()</a> - to hold the data</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_FrequentEvent.html#methodset_data_from_query">CalendarSolution_FrequentEvent::set_data_from_query()</a> - to hold the data</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_Detail.html#methodset_data_from_query">CalendarSolution_Detail::set_data_from_query()</a> - to hold the data</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution.html#methodset_data_from_post">CalendarSolution::set_data_from_post()</a> - to hold the data</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution.html#methodescape_data_for_html">CalendarSolution::escape_data_for_html()</a> - as the data to sanitize</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution.html#methodset_data_empty">CalendarSolution::set_data_empty()</a> - to hold the data</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_Category.html#methodset_data_from_query">CalendarSolution_Category::set_data_from_query()</a> - to hold the data</li>
			</ul>
	
	
		
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../CalendarSolution/CalendarSolution_List.html#var$data">CalendarSolution_List::$data</a>
								: The records to be displayed
							</li>
				</ul>
		

</div>
<a name="var$http_host" id="$http_host"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">string</span>
			<span class="var-name">$http_host</span>
						(line <span class="line-number">101</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The HTTP_HOST, set in __construct()</p>
<p class="description"><p>Defaults to $_SERVER['HTTP_HOST'] and falls back to  CALENDAR_SOLUTION_HTTP_HOST if that's not set.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution.html#methodget_event_formatted_icalendar">CalendarSolution::get_event_formatted_icalendar()</a> - as the UID's domain</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution.html#method__construct">CalendarSolution::__construct()</a> - to store the HTTP_HOST string</li>
			</ul>
	
	
		
		

</div>
<a name="var$sql" id="$sql"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">SQLSolution_General</span>
			<span class="var-name">$sql</span>
						(line <span class="line-number">106</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution.html#method__construct">CalendarSolution::__construct()</a> - to store the SQL Solution object
       instantiated by the Calendar Solution's constructor</li>
			</ul>
	
	
		
		

</div>
<a name="var$uri" id="$uri"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">array</span>
			<span class="var-name">$uri</span>
						(line <span class="line-number">113</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Data from the REQUEST_URI broken into an associative array containing</p>
<p class="description"><p>the 'path' as a string and the 'query' broken into a sub-array</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_List.html#methodget_limit_navigation">CalendarSolution_List::get_limit_navigation()</a> - to know the current URI</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_List.html#methodget_limit_form">CalendarSolution_List::get_limit_form()</a> - to know the current URI</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_List.html#methodget_change_view">CalendarSolution_List::get_change_view()</a> - to know the current URI</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution.html#methodset_uri">CalendarSolution::set_uri()</a> - to store the data</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_List.html#methodget_date_navigation">CalendarSolution_List::get_date_navigation()</a> - to know the current URI</li>
			</ul>
	
	
		
		

</div>
<a name="var$use_cache" id="$use_cache"><!-- --></A>
<div class="evenrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">bool</span>
			<span class="var-name">$use_cache</span>
						(line <span class="line-number">119</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Should the current request use caching?</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	
		
		

</div>
						
		</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-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
																			<a href="#sec-const-summary">Constants</a> (<a href="#sec-consts">details</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">143</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Instantiates the database and cache classes then sets the $http_host  property</p>
	<ul class="tags">
				<li><span class="field">throws:</span> CalendarSolution_Exception if the $dbms parameter or          CALENDAR_SOLUTION_CACHE_CLASS is improper</li>
				<li><span class="field">access:</span> public</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_Detail_Form.html#method__construct">CalendarSolution_Detail_Form::__construct()</a> - for the main instantiation tasks</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_Category_Form.html#method__construct">CalendarSolution_Category_Form::__construct()</a> - for the main instantiation tasks</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_FeaturedPage_Form.html#method__construct">CalendarSolution_FeaturedPage_Form::__construct()</a> - for the main instantiation tasks</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_List.html#method__construct">CalendarSolution_List::__construct()</a> - to instantiate the database and
       cache classes</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_FrequentEvent_Form.html#method__construct">CalendarSolution_FrequentEvent_Form::__construct()</a> - for the main instantiation tasks</li>
				<li><span class="field">uses:</span> <a href="../CalendarSolution/_include---calendar_solution_settings.php.html#defineCALENDAR_SOLUTION_HTTP_HOST">CALENDAR_SOLUTION_HTTP_HOST</a> - in case $_SERVER['HTTP_HOST] is empty</li>
				<li><span class="field">uses:</span> <a href="../CalendarSolution/CalendarSolution.html#var$http_host">CalendarSolution::$http_host</a> - to store the HTTP_HOST string</li>
				<li><span class="field">uses:</span> <a href="../CalendarSolution/CalendarSolution.html#var$cache">CalendarSolution::$cache</a> - to store the Calendar Solution Cache
       object instantiated by the Calendar Solution's constructor</li>
				<li><span class="field">uses:</span> <a href="../CalendarSolution/CalendarSolution.html#var$sql">CalendarSolution::$sql</a> - to store the SQL Solution object
       instantiated by the Calendar Solution's constructor</li>
				<li><span class="field">uses:</span> <a href="../CalendarSolution/_include---calendar_solution_settings.php.html#defineCALENDAR_SOLUTION_CACHE_CLASS">CALENDAR_SOLUTION_CACHE_CLASS</a> - to know which cache class to use</li>
				<li><span class="field">uses:</span> <a href="../CalendarSolution/_include---calendar_solution_settings.php.html#defineCALENDAR_SOLUTION_DBMS">CALENDAR_SOLUTION_DBMS</a> - to know which database extension to use</li>
				<li><span class="field">uses:</span> $GLOBALS['cache_servers'] - to know where the cache servers are</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">CalendarSolution</span>
		<span class="method-name">
			__construct
		</span>
					([<span class="var-type">string</span>&nbsp;<span class="var-name">$dbms</span> = <span class="var-default">CALENDAR_SOLUTION_DBMS</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$dbms</span><span class="var-description">: optional override of the database extension setting                       in CALENDAR_SOLUTION_DBMS.  Values can be                       &quot;mysql&quot;, &quot;mysqli&quot;, &quot;pgsql&quot;, &quot;sqlite&quot;, &quot;sqlite3&quot;.</span>			</li>
				</ul>
		
			
			<hr class="separator" />
		<div class="notes">Redefined in descendants as:</div>
		<ul class="redefinitions">
					<li>
				<a href="../CalendarSolution/CalendarSolution_Category_Form.html#method__construct">CalendarSolution_Category_Form::__construct()</a>
								: Sets the CSRF token name and calls the main constructor
							</li>
					<li>
				<a href="../CalendarSolution/CalendarSolution_Detail_Form.html#method__construct">CalendarSolution_Detail_Form::__construct()</a>
								: Sets the CSRF token name and calls the main constructor
							</li>
					<li>
				<a href="../CalendarSolution/CalendarSolution_FeaturedPage_Form.html#method__construct">CalendarSolution_FeaturedPage_Form::__construct()</a>
								: Sets the CSRF token name and calls the main constructor
							</li>
					<li>
				<a href="../CalendarSolution/CalendarSolution_FrequentEvent_Form.html#method__construct">CalendarSolution_FrequentEvent_Form::__construct()</a>
								: Sets the CSRF token name and calls the main constructor
							</li>
					<li>
				<a href="../CalendarSolution/CalendarSolution_List.html#method__construct">CalendarSolution_List::__construct()</a>
								: Calls the parent constructor and set_uri() then populates the  &quot;$interval_spec&quot; property
							</li>
				</ul>
	</div>
<a name="methodconvert_windows_characters" id="convert_windows_characters"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">convert_windows_characters</span> (line <span class="line-number">225</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Turns &quot;fancy&quot; windows-1252 character set characters into ASCII  equivalents</p>
	<ul class="tags">
				<li><span class="field">return:</span> the sanitized data</li>
				<li><span class="field">since:</span> Method available since version 3.7</li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			convert_windows_characters
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$in</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$in</span><span class="var-description">: the data to be sanitize</span>			</li>
				</ul>
		
			
	</div>
<a name="methodescape_data_for_html" id="escape_data_for_html"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">escape_data_for_html</span> (line <span class="line-number">204</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sanitizes the data in $this-&gt;data via htmlspecialchars()</p>
	<ul class="tags">
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">uses:</span> <a href="../CalendarSolution/CalendarSolution.html#var$data">CalendarSolution::$data</a> - as the data to sanitize</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			escape_data_for_html
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodescape_for_icalendar" id="escape_for_icalendar"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">escape_for_icalendar</span> (line <span class="line-number">290</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sanitizes the input for iCalendar formats</p>
<p class="description"><p>The steps are: <ul><li>Break hyperlinks down into anchor text and URI text</li><li>Strip HTML tags</li><li>Escape iCalendar special characters</li><li>Wrap text at 75 characters</li></ul></p></p>
	<ul class="tags">
				<li><span class="field">return:</span> the sanitized data</li>
				<li><span class="field">since:</span> Method available since version 3.3</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution.html#methodget_event_formatted_icalendar">CalendarSolution::get_event_formatted_icalendar()</a> - to sanitize the data</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			escape_for_icalendar
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$text</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$text</span><span class="var-description">: the string to be escaped</span>			</li>
				</ul>
		
			
	</div>
<a name="methodflush_cache" id="flush_cache"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">flush_cache</span> (line <span class="line-number">313</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Flushes the system's cache</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">uses:</span> <a href="../CalendarSolution/CalendarSolution_Cache.html#methodflush">CalendarSolution_Cache::flush()</a> - to perform the flush</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">bool</span>
		<span class="method-name">
			flush_cache
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodformat_date" id="format_date"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">format_date</span> (line <span class="line-number">335</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Formats a date/time string</p>
<p class="description"><p>This route is necessary because of the need to provide portability  across different database management systems.</p></p>
	<ul class="tags">
				<li><span class="field">return:</span> the formatted date</li>
				<li><span class="field">see:</span> <a href="http://php.net/date">http://php.net/date</a></li>
				<li><span class="field">access:</span> protected</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			format_date
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$in</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$format</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$in</span><span class="var-description">: the date to format</span>			</li>
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$format</span><span class="var-description">: the format to use (for PHP's date() function).                         Use the DATE_FORMAT_* constants in this class                         or use a format of your choosing.</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_admin_navigation" id="get_admin_navigation"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">get_admin_navigation</span> (line <span class="line-number">346</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Generates the HTML needed to access administrative functions</p>
	<ul class="tags">
				<li><span class="field">return:</span> the HTML with the admin links</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_admin_navigation
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodget_credit" id="get_credit"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">get_credit</span> (line <span class="line-number">364</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Produces the HTML with a link to the Calendar Solution's home page</p>
	<ul class="tags">
				<li><span class="field">return:</span> the HTML with the credit link</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_credit
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodget_css" id="get_css"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">get_css</span> (line <span class="line-number">374</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Provides the Cascading Style Sheet data, for use between &lt;style&gt; tags</p>
	<ul class="tags">
				<li><span class="field">return:</span> the CSS</li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_css
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodget_date_from_request" id="get_date_from_request"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">get_date_from_request</span> (line <span class="line-number">392</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Looks for a date value in $_REQUEST[$name]</p>
	<ul class="tags">
				<li><span class="field">return:</span> the date in YYYY-MM-DD format, NULL if the REQUEST                 element is not set, NULL if $_GET['remove_limit'] is set,                 or FALSE if the input is invalid</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_List.html#methodset_to">CalendarSolution_List::set_to()</a> - to determine the
       user's intention</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_List.html#methodset_from">CalendarSolution_List::set_from()</a> - to determine the
       user's intention</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			get_date_from_request
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: the $_REQUEST array's key to examine</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_errors" id="get_errors"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">get_errors</span> (line <span class="line-number">414</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Produces an HTML list explaining the errors found by is_valid()</p>
	<ul class="tags">
				<li><span class="field">return:</span> the HTML containing the list of problems</li>
				<li><span class="field">see:</span> <a href="../CalendarSolution/CalendarSolution_Detail_Form.html#methodis_valid">CalendarSolution_Detail_Form::is_valid()</a></li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_errors
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodget_event_formatted_icalendar" id="get_event_formatted_icalendar"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">get_event_formatted_icalendar</span> (line <span class="line-number">439</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Formats event data for iCalendar output</p>
	<ul class="tags">
				<li><span class="field">return:</span> the iCalendar formatted event</li>
				<li><span class="field">since:</span> Method available since version 3.3</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_List_Icalendar.html#methodget_event_formatted">CalendarSolution_List_Icalendar::get_event_formatted()</a> - for formatting</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_Detail_Icalendar.html#methodget_rendering">CalendarSolution_Detail_Icalendar::get_rendering()</a> - for formatting</li>
				<li><span class="field">uses:</span> <a href="../CalendarSolution/CalendarSolution.html#methodescape_for_icalendar">CalendarSolution::escape_for_icalendar()</a> - to sanitize the data</li>
				<li><span class="field">uses:</span> <a href="../CalendarSolution/CalendarSolution.html#var$http_host">CalendarSolution::$http_host</a> - as the UID's domain</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get_event_formatted_icalendar
		</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_int_array_from_request" id="get_int_array_from_request"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">get_int_array_from_request</span> (line <span class="line-number">558</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Extracts an integer or an array of integers in $_REQUEST[$name]</p>
	<ul class="tags">
				<li><span class="field">return:</span> the array of integers, NULL if the REQUEST                 element is not set, NULL if $_GET['remove_limit'] is set,                 or FALSE if the input is invalid</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_List.html#methodset_frequent_event_id_not">CalendarSolution_List::set_frequent_event_id_not()</a> - to determine the
       user's intention</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_List.html#methodset_category_id">CalendarSolution_List::set_category_id()</a> - to determine the
       user's intention</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_List.html#methodset_category_id_not">CalendarSolution_List::set_category_id_not()</a> - to determine the
       user's intention</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			get_int_array_from_request
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: the $_REQUEST array's key to examine</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_int_from_request" id="get_int_from_request"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">get_int_from_request</span> (line <span class="line-number">534</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Looks for an integer value in $_REQUEST[$name]</p>
	<ul class="tags">
				<li><span class="field">return:</span> the integer, NULL if the REQUEST                 element is not set, NULL if $_GET['remove_limit'] is set,                 or FALSE if the input is invalid</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_List.html#methodset_frequent_event_id">CalendarSolution_List::set_frequent_event_id()</a> - to determine the
       user's intention</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_List.html#methodset_limit">CalendarSolution_List::set_limit()</a> - to determine the
       user's intention</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_FrequentEvent.html#methodrun_query">CalendarSolution_FrequentEvent::run_query()</a> - to determine the
       user's intention</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_FeaturedPage.html#methodrun_query">CalendarSolution_FeaturedPage::run_query()</a> - to determine the
       user's intention</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_Category.html#methodrun_query">CalendarSolution_Category::run_query()</a> - to determine the
       user's intention</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_Detail.html#methodrun_query">CalendarSolution_Detail::run_query()</a> - to determine the
       user's intention</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			get_int_from_request
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: the $_REQUEST array's key to examine</span>			</li>
				</ul>
		
			
	</div>
<a name="methodget_string_from_request" id="get_string_from_request"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">get_string_from_request</span> (line <span class="line-number">593</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Looks for a string value in $_REQUEST[$name]</p>
	<ul class="tags">
				<li><span class="field">return:</span> the string, NULL if the REQUEST                 element is not set, NULL if $_GET['remove_limit'] is set,                 or FALSE if the input is invalid</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_List.html#methodset_is_own_event">CalendarSolution_List::set_is_own_event()</a> - to determine the
       user's intention</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">mixed</span>
		<span class="method-name">
			get_string_from_request
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$name</span><span class="var-description">: the $_REQUEST array's key to examine</span>			</li>
				</ul>
		
			
	</div>
<a name="methodis_admin" id="is_admin"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">is_admin</span> (line <span class="line-number">610</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Is the current view from the admin section or not?</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">
			is_admin
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodis_cache_available" id="is_cache_available"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">is_cache_available</span> (line <span class="line-number">626</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Is caching available?</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">
			is_cache_available
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodset_data_empty" id="set_data_empty"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">set_data_empty</span> (line <span class="line-number">638</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Populates $this-&gt;data with the requisite keys and sets values to NULL</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">uses:</span> CalendarSolution::$fields - as the list of field names</li>
				<li><span class="field">uses:</span> <a href="../CalendarSolution/CalendarSolution.html#var$data">CalendarSolution::$data</a> - to hold the data</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_data_empty
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodset_data_from_post" id="set_data_from_post"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">set_data_from_post</span> (line <span class="line-number">665</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Populates $this-&gt;data with the information from $_POST</p>
<p class="description"><p>The following transformations also occur: <ul><li>Missing keys are created and their values set to NULL.</li><li>Non-scalar entries get set to NULL (see below for exceptions).</li><li>Values are passed through trim().</li><li>Empty strings are converted to NULL.</li></ul>  Fields expected to be arrays (i.e. fields listed in &quot;$fields_bitwise&quot;)  have their array values passed through the process listed above.</p></p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
				<li><span class="field">uses:</span> CalendarSolution::$fields_bitwise - to know which fields to
       handle differently</li>
				<li><span class="field">uses:</span> CalendarSolution::$fields - as the list of field names</li>
				<li><span class="field">uses:</span> <a href="../CalendarSolution/CalendarSolution.html#var$data">CalendarSolution::$data</a> - to hold the data</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_data_from_post
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodset_uri" id="set_uri"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">set_uri</span> (line <span class="line-number">713</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Breaks up the REQUEST_URI into usable parts</p>
	<ul class="tags">
				<li><span class="field">since:</span> Method moved to CalendarSolution class in version 3.3</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_List.html#method__construct">CalendarSolution_List::__construct()</a> - to set the &quot;$uri&quot; property</li>
				<li><span class="field">uses:</span> <a href="../CalendarSolution/CalendarSolution.html#var$uri">CalendarSolution::$uri</a> - to store the data</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			set_uri
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodvalidate_csrf_token" id="validate_csrf_token"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">validate_csrf_token</span> (line <span class="line-number">730</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Checks the Cross Site Request Forgery token to improve security</p>
	<ul class="tags">
				<li><span class="field">throws:</span> CalendarSolution_Exception  if the proper CSRF token is missing</li>
				<li><span class="field">access:</span> protected</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_FeaturedPage_Form.html#methodupdate">CalendarSolution_FeaturedPage_Form::update()</a> - to check the CSRF token</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_FeaturedPage_Form.html#methodinsert">CalendarSolution_FeaturedPage_Form::insert()</a> - to check the CSRF token</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_FrequentEvent_Form.html#methodinsert">CalendarSolution_FrequentEvent_Form::insert()</a> - to check the CSRF token</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_FrequentEvent_Form.html#methodupdate">CalendarSolution_FrequentEvent_Form::update()</a> - to check the CSRF token</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_FeaturedPage_Form.html#methoddelete">CalendarSolution_FeaturedPage_Form::delete()</a> - to check the CSRF token</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_FrequentEvent_Form.html#methoddelete">CalendarSolution_FrequentEvent_Form::delete()</a> - to check the CSRF token</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_Detail_Form.html#methodinsert">CalendarSolution_Detail_Form::insert()</a> - to check the CSRF token</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_Category_Form.html#methoddelete">CalendarSolution_Category_Form::delete()</a> - to check the CSRF token</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_Category_Form.html#methodinsert">CalendarSolution_Category_Form::insert()</a> - to check the CSRF token</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_Category_Form.html#methodupdate">CalendarSolution_Category_Form::update()</a> - to check the CSRF token</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_Detail_Form.html#methoddelete">CalendarSolution_Detail_Form::delete()</a> - to check the CSRF token</li>
				<li><span class="field">usedby:</span> <a href="../CalendarSolution/CalendarSolution_Detail_Form.html#methodupdate">CalendarSolution_Detail_Form::update()</a> - to check the CSRF token</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			validate_csrf_token
		</span>
				()
			</div>
	
		
			
	</div>
						
		</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-descendents">Descendants</a> |
										<a href="#sec-var-summary">Constants</a> (<span class="disabled">details</span>)
						
			
												<a href="#sec-var-summary">Vars</a> (<a href="#sec-vars">details</a>)
														| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="constDATE_FORMAT_FULL" id="DATE_FORMAT_FULL"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">DATE_FORMAT_FULL</span>
			 = <span class="const-default"> 'l, F jS, Y'</span>
			(line <span class="line-number">40</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Format for PHP's date() function, to be used by our format_date() method</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../CalendarSolution/CalendarSolution.html#methodformat_date">CalendarSolution::format_date()</a></li>
			</ul>
	
	
</div>
<a name="constDATE_FORMAT_ICALENDAR" id="DATE_FORMAT_ICALENDAR"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">DATE_FORMAT_ICALENDAR</span>
			 = <span class="const-default"> 'Ymd'</span>
			(line <span class="line-number">45</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Format for PHP's date() function, to be used by our format_date() method</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../CalendarSolution/CalendarSolution.html#methodformat_date">CalendarSolution::format_date()</a></li>
			</ul>
	
	
</div>
<a name="constDATE_FORMAT_LONG" id="DATE_FORMAT_LONG"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">DATE_FORMAT_LONG</span>
			 = <span class="const-default"> 'D, M jS'</span>
			(line <span class="line-number">41</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Format for PHP's date() function, to be used by our format_date() method</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../CalendarSolution/CalendarSolution.html#methodformat_date">CalendarSolution::format_date()</a></li>
			</ul>
	
	
</div>
<a name="constDATE_FORMAT_MEDIUM" id="DATE_FORMAT_MEDIUM"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">DATE_FORMAT_MEDIUM</span>
			 = <span class="const-default"> 'D, n/j'</span>
			(line <span class="line-number">43</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Format for PHP's date() function, to be used by our format_date() method</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../CalendarSolution/CalendarSolution.html#methodformat_date">CalendarSolution::format_date()</a></li>
			</ul>
	
	
</div>
<a name="constDATE_FORMAT_NAME_NUMBER" id="DATE_FORMAT_NAME_NUMBER"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">DATE_FORMAT_NAME_NUMBER</span>
			 = <span class="const-default"> 'l jS'</span>
			(line <span class="line-number">42</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Format for PHP's date() function, to be used by our format_date() method</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../CalendarSolution/CalendarSolution.html#methodformat_date">CalendarSolution::format_date()</a></li>
			</ul>
	
	
</div>
<a name="constDATE_FORMAT_SHORT" id="DATE_FORMAT_SHORT"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">DATE_FORMAT_SHORT</span>
			 = <span class="const-default"> 'n/j'</span>
			(line <span class="line-number">44</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Format for PHP's date() function, to be used by our format_date() method</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../CalendarSolution/CalendarSolution.html#methodformat_date">CalendarSolution::format_date()</a></li>
			</ul>
	
	
</div>
<a name="constDATE_FORMAT_TIME_12AP" id="DATE_FORMAT_TIME_12AP"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">DATE_FORMAT_TIME_12AP</span>
			 = <span class="const-default"> 'g:i\&amp;\n\b\s\p\;a'</span>
			(line <span class="line-number">46</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Format for PHP's date() function, to be used by our format_date() method</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../CalendarSolution/CalendarSolution.html#methodformat_date">CalendarSolution::format_date()</a></li>
			</ul>
	
	
</div>
<a name="constDATE_FORMAT_TIME_24" id="DATE_FORMAT_TIME_24"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">DATE_FORMAT_TIME_24</span>
			 = <span class="const-default"> 'H:i'</span>
			(line <span class="line-number">47</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Format for PHP's date() function, to be used by our format_date() method</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../CalendarSolution/CalendarSolution.html#methodformat_date">CalendarSolution::format_date()</a></li>
			</ul>
	
	
</div>
<a name="constDATE_FORMAT_TIME_ICALENDAR" id="DATE_FORMAT_TIME_ICALENDAR"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">DATE_FORMAT_TIME_ICALENDAR</span>
			 = <span class="const-default"> 'Ymd\THis'</span>
			(line <span class="line-number">48</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Format for PHP's date() function, to be used by our format_date() method</p>
	<ul class="tags">
				<li><span class="field">see:</span> <a href="../CalendarSolution/CalendarSolution.html#methodformat_date">CalendarSolution::format_date()</a></li>
			</ul>
	
	
</div>
<a name="constLINK_TO_CALENDAR_URI" id="LINK_TO_CALENDAR_URI"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">LINK_TO_CALENDAR_URI</span>
			 = <span class="const-default"> 4</span>
			(line <span class="line-number">57</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ID numbers used by the &quot;list_link_goes_to_id&quot; field</p>
	
	
</div>
<a name="constLINK_TO_DETAIL_PAGE" id="LINK_TO_DETAIL_PAGE"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">LINK_TO_DETAIL_PAGE</span>
			 = <span class="const-default"> 2</span>
			(line <span class="line-number">55</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ID numbers used by the &quot;list_link_goes_to_id&quot; field</p>
	
	
</div>
<a name="constLINK_TO_FREQUENT_EVENT_URI" id="LINK_TO_FREQUENT_EVENT_URI"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">LINK_TO_FREQUENT_EVENT_URI</span>
			 = <span class="const-default"> 3</span>
			(line <span class="line-number">56</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ID numbers used by the &quot;list_link_goes_to_id&quot; field</p>
	
	
</div>
<a name="constLINK_TO_NONE" id="LINK_TO_NONE"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">LINK_TO_NONE</span>
			 = <span class="const-default"> 1</span>
			(line <span class="line-number">54</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ID numbers used by the &quot;list_link_goes_to_id&quot; field</p>
	
	
</div>
<a name="constSTATUS_CANCELLED" id="STATUS_CANCELLED"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">STATUS_CANCELLED</span>
			 = <span class="const-default"> 3</span>
			(line <span class="line-number">65</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ID numbers used by the &quot;status_id&quot; field</p>
	
	
</div>
<a name="constSTATUS_FULL" id="STATUS_FULL"><!-- --></A>
<div class="evenrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">STATUS_FULL</span>
			 = <span class="const-default"> 2</span>
			(line <span class="line-number">64</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ID numbers used by the &quot;status_id&quot; field</p>
	
	
</div>
<a name="constSTATUS_OPEN" id="STATUS_OPEN"><!-- --></A>
<div class="oddrow">

	<div class="const-header">
		<span class="const-title">
			<span class="const-name">STATUS_OPEN</span>
			 = <span class="const-default"> 1</span>
			(line <span class="line-number">63</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">ID numbers used by the &quot;status_id&quot; field</p>
	
	
</div>
						
		</div>
	</div>

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