Location: PHPKode > projects > PHPLayouts > PHPLayouts/docs/php-layouts/Layout.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 Layout</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 Layout</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
						
					</div>
	<div class="info-box-body">
        		<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Layout Handler</p>
	<ul class="tags">
				<li><span class="field">author:</span> rodix53 &lt;<a href="mailto:hide@address.com">hide@address.com</a>&gt;</li>
				<li><span class="field">version:</span> 0.9.1-beta</li>
				<li><span class="field">license:</span> <a href="http://creativecommons.org/licenses/by-nc/2.0/fr/">Creative Commons BY-NC 2.0</a></li>
			</ul>
		<p class="notes">
			Located in <a class="field" href="_Layout.php.html">/Layout.php</a> (line <span class="field">12</span>)
		</p>
		
				
		<pre></pre>
	
			</div>
</div>




	<a name="sec-method-summary"></a>
	<div class="info-box">
		<div class="info-box-title">Method Summary</span></div>
		<div class="nav-bar">
			<a href="#sec-description">Description</a> |
												<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">Layout</span>
										<a href="#__construct" title="details" class="method-name">__construct</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$tpl_dir</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#activate" title="details" class="method-name">activate</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#addBlock" title="details" class="method-name">addBlock</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$file</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">integer</span>
										<a href="#countBlocks" title="details" class="method-name">countBlocks</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#desactivate" title="details" class="method-name">desactivate</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getBlock" title="details" class="method-name">getBlock</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$block_name</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">array</span>
										<a href="#getBlocks" title="details" class="method-name">getBlocks</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getLayout" title="details" class="method-name">getLayout</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">string</span>
										<a href="#getLayoutDir" title="details" class="method-name">getLayoutDir</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#isActivated" title="details" class="method-name">isActivated</a>
										()
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#removeBlock" title="details" class="method-name">removeBlock</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$block_name</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#setLayout" title="details" class="method-name">setLayout</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$layout</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">bool</span>
										<a href="#setLayoutDir" title="details" class="method-name">setLayoutDir</a>
											(<span class="var-type">string</span>&nbsp;<span class="var-name">$layout_dir</span>)
									</div>
																<div class="method-definition">
											<span class="method-result">void</span>
										<a href="#_setContentBlock" title="details" class="method-name">_setContentBlock</a>
											(<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$content</span>)
									</div>
								</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-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">39</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">Layout</span>
		<span class="method-name">
			__construct
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$tpl_dir</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$tpl_dir</span>			</li>
				</ul>
		
			
	</div>
<a name="methodactivate" id="activate"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">activate</span> (line <span class="line-number">56</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Enable the layout handler</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">
			activate
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodaddBlock" id="addBlock"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">addBlock</span> (line <span class="line-number">97</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Gestion des blocks pour la page finale.</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">
			addBlock
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$file</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$name</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$file</span>			</li>
				</ul>
		
			
	</div>
<a name="methodcountBlocks" id="countBlocks"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">countBlocks</span> (line <span class="line-number">144</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the number of block</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">integer</span>
		<span class="method-name">
			countBlocks
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methoddesactivate" id="desactivate"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">desactivate</span> (line <span class="line-number">64</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Disable the layout handler</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">
			desactivate
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetBlock" id="getBlock"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getBlock</span> (line <span class="line-number">126</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Returns the contents of the specified block</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">
			getBlock
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$block_name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$block_name</span><span class="var-description">: Block name</span>			</li>
				</ul>
		
			
	</div>
<a name="methodgetBlocks" id="getBlocks"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getBlocks</span> (line <span class="line-number">135</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return all blocks in an array</p>
	<ul class="tags">
				<li><span class="field">access:</span> public</li>
			</ul>
	
	<div class="method-signature">
		<span class="method-result">array</span>
		<span class="method-name">
			getBlocks
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetLayout" id="getLayout"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">getLayout</span> (line <span class="line-number">161</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return the name of the main layout</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">
			getLayout
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodgetLayoutDir" id="getLayoutDir"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">getLayoutDir</span> (line <span class="line-number">89</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Get layout directory</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">
			getLayoutDir
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodisActivated" id="isActivated"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">isActivated</span> (line <span class="line-number">48</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Return if the layout handler is activated 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">
			isActivated
		</span>
				()
			</div>
	
		
			
	</div>
<a name="methodremoveBlock" id="removeBlock"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">removeBlock</span> (line <span class="line-number">113</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Delete the specified block</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">
			removeBlock
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$block_name</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$block_name</span><span class="var-description">: Block name</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetLayout" id="setLayout"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">setLayout</span> (line <span class="line-number">170</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the name of the main layout</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">
			setLayout
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$layout</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$layout</span>			</li>
				</ul>
		
			
	</div>
<a name="methodsetLayoutDir" id="setLayoutDir"><!-- --></a>
<div class="oddrow">
	
	<div class="method-header">
		<span class="method-title">setLayoutDir</span> (line <span class="line-number">74</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set layout directory</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">
			setLayoutDir
		</span>
					(<span class="var-type">string</span>&nbsp;<span class="var-name">$layout_dir</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type">string</span>
				<span class="var-name">$layout_dir</span><span class="var-description">: Folder where the layout file is located</span>			</li>
				</ul>
		
			
	</div>
<a name="method_setContentBlock" id="_setContentBlock"><!-- --></a>
<div class="evenrow">
	
	<div class="method-header">
		<span class="method-title">_setContentBlock</span> (line <span class="line-number">152</span>)
	</div> 
	
	<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Set the content of a block of the layout</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">
			_setContentBlock
		</span>
					(<span class="var-type"></span>&nbsp;<span class="var-name">$name</span>, <span class="var-type"></span>&nbsp;<span class="var-name">$content</span>)
			</div>
	
			<ul class="parameters">
					<li>
				<span class="var-type"></span>
				<span class="var-name">$name</span>			</li>
					<li>
				<span class="var-type"></span>
				<span class="var-name">$content</span>			</li>
				</ul>
		
			
	</div>
						
		</div>
	</div>


	<p class="notes" id="credit">
		Documentation generated on Fri, 02 Apr 2010 21:55:16 +0200 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
	</p>
	</div></body>
</html>
Return current item: PHPLayouts