Location: PHPKode > projects > Noti > doc/core/noti/Page.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 Page</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 Page</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-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">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The Page class provides functions web pages handling like:</p>
<p class="description"><p><ul><li>display URLs, CSS, templates, etc</li><li>redirections</li><li>abstract page parameters management</li><li>access to the authentication layer (via the Auth class)</li></ul>  Templates must always use this class, when the needed functionality is  provided.</p></p>
	<ul class="tags">
				<li><span class="field">since:</span> Noti 0.5.0</li>
				<li><span class="field">version:</span> $Revision: 1.5 $</li>
				<li><span class="field">license:</span> <a href="http://www.gnu.org/licenses/gpl.txt">GPL</a></li>
				<li><span class="field">author:</span> Pablo Hoffman &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Page_class.html">/Page.class</a> (line <span class="field">42</span>)
		</p>
		
				
		<pre></pre>
	
			</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> |
						<span class="disabled">Vars</span> (<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="var-summary">
								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$auth" title="details" class="var-name">$auth</a>
				</div>
								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$error" title="details" class="var-name">$error</a>
				</div>
								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$feedable" title="details" class="var-name">$feedable</a>
				</div>
								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$module" title="details" class="var-name">$module</a>
				</div>
								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$name" title="details" class="var-name">$name</a>
				</div>
								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$params" title="details" class="var-name">$params</a>
				</div>
								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$title" title="details" class="var-name">$title</a>
				</div>
								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$user" title="details" class="var-name">$user</a>
				</div>
								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$_rawoutput" title="details" class="var-name">$_rawoutput</a>
				</div>
								<div class="var-title">
					<span class="var-type">mixed</span>
					<a href="#$_tplvars" title="details" class="var-name">$_tplvars</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-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">Page</span>
										<a href="#Page" title="details" class="method-name">Page</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$module</span>, [<span class="var-type">optional</span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">""</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">""</span>])
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#css" title="details" class="method-name">css</a>
											([<span class="var-type">optional</span>&nbsp;<span class="var-name">$module</span> = <span class="var-default">""</span>])
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#cssUrl" title="details" class="method-name">cssUrl</a>
											(<span class="var-type">optional</span>&nbsp;<span class="var-name">0</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#customTemplate" title="details" class="method-name">customTemplate</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$template</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#dateUrl" title="details" class="method-name">dateUrl</a>
											([<span class="var-type">optional</span>&nbsp;<span class="var-name">$module</span> = <span class="var-default">""</span>], [<span class="var-type">optional</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">""</span>], [<span class="var-type">optional</span>&nbsp;<span class="var-name">$full</span> = <span class="var-default">false</span>], [<span class="var-type">optional</span>&nbsp;<span class="var-name">$rawsep</span> = <span class="var-default">false</span>])
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#display" title="details" class="method-name">display</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#get" title="details" class="method-name">get</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#getName" title="details" class="method-name">getName</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#module" title="details" class="method-name">module</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#newsUrl" title="details" class="method-name">newsUrl</a>
											([<span class="var-type">optional</span>&nbsp;<span class="var-name">$item</span> = <span class="var-default">""</span>], [<span class="var-type">optional</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">""</span>])
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#process" title="details" class="method-name">process</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$module</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#redirect" title="details" class="method-name">redirect</a>
											([<span class="var-type">optional</span>&nbsp;<span class="var-name">$module</span> = <span class="var-default">""</span>], [<span class="var-type">optional</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">""</span>])
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#rss2Url" title="details" class="method-name">rss2Url</a>
											([<span class="var-type">optional</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
									</div>
								
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#selfUrl" title="details" class="method-name">selfUrl</a>
											([<span class="var-type">optional</span>&nbsp;<span class="var-name">$module</span> = <span class="var-default">""</span>], [<span class="var-type">optional</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">""</span>])
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setRawOutput" title="details" class="method-name">setRawOutput</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#setTplVar" title="details" class="method-name">setTplVar</a>
											(<span class="var-type">strin</span>&nbsp;<span class="var-name">$varname</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$varcontent</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#siteUrl" title="details" class="method-name">siteUrl</a>
										()
									</div>
								
				<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#template" title="details" class="method-name">template</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$module</span>)
									</div>
								
				<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#url" title="details" class="method-name">url</a>
											([<span class="var-type">optional</span>&nbsp;<span class="var-name">$module</span> = <span class="var-default">""</span>], [<span class="var-type">optional</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">""</span>], [<span class="var-type">optional</span>&nbsp;<span class="var-name">$full</span> = <span class="var-default">false</span>], [<span class="var-type">optional</span>&nbsp;<span class="var-name">$rawsep</span> = <span class="var-default">false</span>])
									</div>
							</div>
		</div>
	</div>		

	<a name="sec-vars"></a>
	<div class="info-box">
		<div class="info-box-title">Variables</div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
										<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
						
			
										| 
									<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
							
					</div>
		<div class="info-box-body">
			<a name="var$auth" id="$auth"><!-- --></A>
<div class="oddrow">

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$auth</span>
						(line <span class="line-number">53</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
		
		

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

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$error</span>
						(line <span class="line-number">59</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
		
		

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

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$feedable</span>
						(line <span class="line-number">65</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
		
		

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

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$module</span>
						(line <span class="line-number">50</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
		
		

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

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$name</span>
			 = <span class="var-default"> &quot;&quot;</span>			(line <span class="line-number">47</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
		
		

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

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$params</span>
						(line <span class="line-number">62</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
		
		

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

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$title</span>
						(line <span class="line-number">44</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
		
		

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

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$user</span>
						(line <span class="line-number">56</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
		
		

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

	<div class="var-header">
		<span class="var-title">
			<span class="var-type">mixed</span>
			<span class="var-name">$_rawoutput</span>
			 = <span class="var-default"> false</span>			(line <span class="line-number">68</span>)
		</span>
	</div>

	<!-- ========== Info from phpDoc block ========= -->
	
	
		
		

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

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

	<!-- ========== Info from phpDoc block ========= -->
	
	
		
		

</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-var-summary">Vars</a> (<a href="#sec-vars">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="methodPage" id="Page"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">Constructor Page</span> (line <span class="line-number">83</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Constructor - creates a new web page taking the proper security  measures and all other necessary steps.</p>
<p class="description"><p>Creates a page instance of the given web module</p></p>
	
	<div class="method-signature">
		<span class="method-result">Page</span>
		<span class="method-name">
			Page
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$module</span>, [<span class="var-type">optional</span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">""</span>], [<span class="var-type">mixed</span>&nbsp;<span class="var-name">$name</span> = <span class="var-default">""</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$module</span><span class="var-description">: The web module to create</span>			</li>
					<li>
				<span class="var-type">optional</span>
				<span class="var-name">$title</span><span class="var-description">: array   $title    The page title</span>			</li>
				</ul>
		
		
	</div>
<a name="methodcss" id="css"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">css</span> (line <span class="line-number">386</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return CSS for the given module</p>
	<ul class="tags">
				<li><span class="field">static:</span> </li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			css
		</span>
					([<span class="var-type">optional</span>&nbsp;<span class="var-name">$module</span> = <span class="var-default">""</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">optional</span>
				<span class="var-name">$module</span><span class="var-description">: string $module   The template CSS to be displayed</span>			</li>
				</ul>
		
		
	</div>
<a name="methodcssUrl" id="cssUrl"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">cssUrl</span> (line <span class="line-number">248</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns CSS public URL for the given web module  If module is not given, just return the common CSS.</p>
	<ul class="tags">
				<li><span class="field">static:</span> </li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			cssUrl
		</span>
					(<span class="var-type">optional</span>&nbsp;<span class="var-name">0</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">optional</span>
				<span class="var-name">0</span><span class="var-description">: string $module   The web module whose CSS is to be                                   returned</span>			</li>
				</ul>
		
		
	</div>
<a name="methodcustomTemplate" id="customTemplate"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">customTemplate</span> (line <span class="line-number">361</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Display the given configuration template (if exists). See config/README  for more information.</p>
	<ul class="tags">
				<li><span class="field">static:</span> </li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			customTemplate
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$template</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$template</span><span class="var-description">: The template name</span>			</li>
				</ul>
		
		
	</div>
<a name="methoddateUrl" id="dateUrl"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">dateUrl</span> (line <span class="line-number">197</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns public URL for the given web module keeping the active  date (d) parameter</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			dateUrl
		</span>
					([<span class="var-type">optional</span>&nbsp;<span class="var-name">$module</span> = <span class="var-default">""</span>], [<span class="var-type">optional</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">""</span>], [<span class="var-type">optional</span>&nbsp;<span class="var-name">$full</span> = <span class="var-default">false</span>], [<span class="var-type">optional</span>&nbsp;<span class="var-name">$rawsep</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">optional</span>
				<span class="var-name">$module</span><span class="var-description">: string  $module   See Page::url() for info</span>			</li>
					<li>
				<span class="var-type">optional</span>
				<span class="var-name">$params</span><span class="var-description">: array   $params   See Page::url() for info</span>			</li>
					<li>
				<span class="var-type">optional</span>
				<span class="var-name">$full</span><span class="var-description">: boolean $full     See Page::url() for info</span>			</li>
					<li>
				<span class="var-type">optional</span>
				<span class="var-name">$rawsep</span><span class="var-description">: boolean $rawsep   See Page::url() for info</span>			</li>
				</ul>
		
		
	</div>
<a name="methoddisplay" id="display"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">display</span> (line <span class="line-number">303</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Display the current page</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">
			display
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodget" id="get"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">get</span> (line <span class="line-number">317</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the current page module as a string</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			get
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodgetName" id="getName"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getName</span> (line <span class="line-number">437</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return page name (if available), otherwise return page title</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">
			getName
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodmodule" id="module"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">module</span> (line <span class="line-number">110</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns a the page module name</p>
	<ul class="tags">
				<li><span class="field">return:</span> the name of the module</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			module
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodnewsUrl" id="newsUrl"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">newsUrl</span> (line <span class="line-number">263</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the news page URL for the given item (area, site, category,  user or subscription)</p>
	<ul class="tags">
				<li><span class="field">static:</span> </li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			newsUrl
		</span>
					([<span class="var-type">optional</span>&nbsp;<span class="var-name">$item</span> = <span class="var-default">""</span>], [<span class="var-type">optional</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">""</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">optional</span>
				<span class="var-name">$item</span><span class="var-description">: string $item   The item whose news page is to be                                 returned</span>			</li>
					<li>
				<span class="var-type">optional</span>
				<span class="var-name">$params</span><span class="var-description">: string $params Additional parameters (optional)</span>			</li>
				</ul>
		
		
	</div>
<a name="methodprocess" id="process"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">process</span> (line <span class="line-number">406</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Process a web module</p>
	<ul class="tags">
				<li><span class="field">static:</span> </li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			process
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$module</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$module</span><span class="var-description">: Module to be processed</span>			</li>
				</ul>
		
		
	</div>
<a name="methodredirect" id="redirect"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">redirect</span> (line <span class="line-number">222</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Redirects browser to the given module  If the module is omitted, redirectsi to the home page.</p>
<p class="description"><p>This function can be used statically (via Page::) or through  a real class method (in which case the current parameters will  be passed to the new module)</p></p>
	<ul class="tags">
				<li><span class="field">static:</span> </li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			redirect
		</span>
					([<span class="var-type">optional</span>&nbsp;<span class="var-name">$module</span> = <span class="var-default">""</span>], [<span class="var-type">optional</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">""</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">optional</span>
				<span class="var-name">$module</span><span class="var-description">: string  $module   The web module</span>			</li>
					<li>
				<span class="var-type">optional</span>
				<span class="var-name">$params</span><span class="var-description">: array   $params   Optional module parameters as an                                    associative array of $key =&gt; $value</span>			</li>
				</ul>
		
		
	</div>
<a name="methodrss2Url" id="rss2Url"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">rss2Url</span> (line <span class="line-number">289</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the RSS2 feed URL. If params are not given, and the function  is not called statically then the current page parameters are used.</p>
	<ul class="tags">
				<li><span class="field">static:</span> </li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			rss2Url
		</span>
					([<span class="var-type">optional</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">array()</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">optional</span>
				<span class="var-name">$params</span><span class="var-description">: string $type   The type of the feed. Only rss2 is                                 supported at this time.</span>			</li>
				</ul>
		
		
	</div>
<a name="methodselfUrl" id="selfUrl"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">selfUrl</span> (line <span class="line-number">177</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns URL based on the active web module and its parameters</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			selfUrl
		</span>
					([<span class="var-type">optional</span>&nbsp;<span class="var-name">$module</span> = <span class="var-default">""</span>], [<span class="var-type">optional</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">""</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">optional</span>
				<span class="var-name">$module</span><span class="var-description">: string  $module   The web module. If omitted current                                    web module is used.</span>			</li>
					<li>
				<span class="var-type">optional</span>
				<span class="var-name">$params</span><span class="var-description">: array   $params   Module parameters. If omitted,                                    current parameterse are passed.</span>			</li>
				</ul>
		
		
	</div>
<a name="methodsetRawOutput" id="setRawOutput"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setRawOutput</span> (line <span class="line-number">428</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set raw output for this page. Must be called before any output is shown</p>
	<ul class="tags">
				<li><span class="field">static:</span> </li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setRawOutput
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodsetTplVar" id="setTplVar"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setTplVar</span> (line <span class="line-number">374</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Adds the given variable to the local template variables</p>
	<ul class="tags">
				<li><span class="field">static:</span> </li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			setTplVar
		</span>
					(<span class="var-type">strin</span>&nbsp;<span class="var-name">$varname</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$varcontent</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">strin</span>
				<span class="var-name">$varname</span><span class="var-description">: The variable name</span>			</li>
					<li>
				<span class="var-type">mixed</span>
				<span class="var-name">$varcontent</span><span class="var-description">: The variable content</span>			</li>
				</ul>
		
		
	</div>
<a name="methodsiteUrl" id="siteUrl"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">siteUrl</span> (line <span class="line-number">234</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the public site full URL</p>
	<ul class="tags">
				<li><span class="field">static:</span> </li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			siteUrl
		</span>
				()
			</div>
	
		
		
	</div>
<a name="methodtemplate" id="template"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">template</span> (line <span class="line-number">335</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Display the template for the given page module</p>
	<ul class="tags">
				<li><span class="field">static:</span> </li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">void</span>
		<span class="method-name">
			template
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$module</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$module</span><span class="var-description">: The module to be displayed</span>			</li>
				</ul>
		
		
	</div>
<a name="methodurl" id="url"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">url</span> (line <span class="line-number">134</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns public URL for the given web module  If the module is omitted, returns the home page URL</p>
	<ul class="tags">
				<li><span class="field">static:</span> </li>
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">string</span>
		<span class="method-name">
			url
		</span>
					([<span class="var-type">optional</span>&nbsp;<span class="var-name">$module</span> = <span class="var-default">""</span>], [<span class="var-type">optional</span>&nbsp;<span class="var-name">$params</span> = <span class="var-default">""</span>], [<span class="var-type">optional</span>&nbsp;<span class="var-name">$full</span> = <span class="var-default">false</span>], [<span class="var-type">optional</span>&nbsp;<span class="var-name">$rawsep</span> = <span class="var-default">false</span>])
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">optional</span>
				<span class="var-name">$module</span><span class="var-description">: string  $module   The web module</span>			</li>
					<li>
				<span class="var-type">optional</span>
				<span class="var-name">$params</span><span class="var-description">: array   $params   Optional module parameters as an                                    associative array of $key =&gt; $value                                    If $params is not an array, then the                                    internal parameters (set when the                                    page was displayed) are used.</span>			</li>
					<li>
				<span class="var-type">optional</span>
				<span class="var-name">$full</span><span class="var-description">: boolean $full     Return full URL instead of relative                                    one (ie. include hostname)</span>			</li>
					<li>
				<span class="var-type">optional</span>
				<span class="var-name">$rawsep</span><span class="var-description">: boolean $rawsep   Use &amp; instead of &amp;amp; as                                    URL parameter separator</span>			</li>
				</ul>
		
		
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Sat, 18 Mar 2006 04:40:17 -0300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC3</a>
	</p>
	</div></body>
</html>
Return current item: Noti