phpdoc/MVCFundamental/Basic/Layout.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>MVCFundamental\Basic\Layout | MVC Fundamental</title>
<link rel="stylesheet" type="text/css" href="../../css/bootstrap.min.css">
<link rel="stylesheet" type="text/css" href="../../css/bootstrap-theme.min.css">
<link rel="stylesheet" type="text/css" href="../../css/sami.css">
<script src="../../js/jquery-1.11.1.min.js"></script>
<script src="../../js/bootstrap.min.js"></script>
<script src="../../js/typeahead.min.js"></script>
<script src="../../sami.js"></script>
<meta name="MobileOptimized" content="width">
<meta name="HandheldFriendly" content="true">
<meta name="viewport" content="width=device-width,initial-scale=1,maximum-scale=1">
</head>
<body id="class" data-name="class:MVCFundamental_Basic_Layout" data-root-path="../../">
<div id="content">
<div id="left-column">
<div id="control-panel">
<form id="search-form" action="../../search.html" method="GET">
<span class="glyphicon glyphicon-search"></span>
<input name="search"
class="typeahead form-control"
type="search"
placeholder="Search">
</form>
</div>
<div id="api-tree"></div>
</div>
<div id="right-column">
<nav id="site-nav" class="navbar navbar-default" role="navigation">
<div class="container-fluid">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar-elements">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">MVC Fundamental</a>
</div>
<div class="collapse navbar-collapse" id="navbar-elements">
<ul class="nav navbar-nav">
<li><a href="../../classes.html">Classes</a></li>
<li><a href="../../namespaces.html">Namespaces</a></li>
<li><a href="../../interfaces.html">Interfaces</a></li>
<li><a href="../../traits.html">Traits</a></li>
<li><a href="../../doc-index.html">Index</a></li>
<li><a href="../../search.html">Search</a></li>
</ul>
</div>
</div>
</nav>
<div class="namespace-breadcrumbs">
<ol class="breadcrumb">
<li><span class="label label-default">class</span></li>
<li><a href="../../MVCFundamental.html">MVCFundamental</a></li>
<li><a href="../../MVCFundamental/Basic.html">Basic</a></li>
<li>Layout</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>Layout</h1>
</div>
<p> class
<strong>Layout</strong> implements
<a href="../../MVCFundamental/Interfaces/LayoutInterface.html"><abbr title="MVCFundamental\Interfaces\LayoutInterface">LayoutInterface</abbr></a>
</p>
<div class="description">
<p>Class Layout</p> </div>
<h2>Traits</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-6">
<a href="../../MVCFundamental/Commons/ViewFileTrait.html"><abbr title="MVCFundamental\Commons\ViewFileTrait">MVCFundamental\Commons\ViewFileTrait</abbr></a>
</div>
<div class="col-md-6">
ViewFileTrait
</div>
</div>
<div class="row">
<div class="col-md-6">
<abbr title="Patterns\Traits\OptionableTrait">Patterns\Traits\OptionableTrait</abbr>
</div>
<div class="col-md-6">
</div>
</div>
<div class="row">
<div class="col-md-6">
<abbr title="Patterns\Traits\TemplateViewTrait">Patterns\Traits\TemplateViewTrait</abbr>
</div>
<div class="col-md-6">
</div>
</div>
</div>
<h2>Methods</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_render">render</a>(
string $view = null,
array $params = array())
<p>Building of a view content including a view file passing it parameters</p> </div>
<div class="col-md-2"><small>from
<a href="../../MVCFundamental/Commons/ViewFileTrait.html#method_render"><abbr title="MVCFundamental\Commons\ViewFileTrait">ViewFileTrait</abbr></a></small></div>
</div>
<div class="row">
<div class="col-md-2 type">
array
</div>
<div class="col-md-8 type">
<a href="#method_getDefaultViewParams">getDefaultViewParams</a>()
<p>Get the default parameters for all views</p> </div>
<div class="col-md-2"><small>from
<a href="../../MVCFundamental/Commons/ViewFileTrait.html#method_getDefaultViewParams"><abbr title="MVCFundamental\Commons\ViewFileTrait">ViewFileTrait</abbr></a></small></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_getTemplate">getTemplate</a>(
string $name)
<p>Search a view file in the current file system</p> </div>
<div class="col-md-2"><small>from
<a href="../../MVCFundamental/Commons/ViewFileTrait.html#method_getTemplate"><abbr title="MVCFundamental\Commons\ViewFileTrait">ViewFileTrait</abbr></a></small></div>
</div>
<div class="row">
<div class="col-md-2 type">
</div>
<div class="col-md-8 type">
<a href="#method___construct">__construct</a>(
array $options = array())
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method___toString">__toString</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="MVCFundamental\Interfaces\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_setLayout">setLayout</a>(
string $view)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_getLayout">getLayout</a>()
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="MVCFundamental\Interfaces\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_setChild">setChild</a>(
string $name,
string $view,
array $params = array())
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="MVCFundamental\Interfaces\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_setChildParam">setChildParam</a>(
string $name,
string $param_name,
mixed $param_value)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
<abbr title="MVCFundamental\Interfaces\$this">$this</abbr>
</div>
<div class="col-md-8 type">
<a href="#method_setChildAsString">setChildAsString</a>(
string $name,
string $content)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
mixed
</div>
<div class="col-md-8 type">
<a href="#method_getChild">getChild</a>(
string $name)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
bool
</div>
<div class="col-md-8 type">
<a href="#method_hasChild">hasChild</a>(
string $name)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_renderChild">renderChild</a>(
string $name,
array $params = array())
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
string
</div>
<div class="col-md-8 type">
<a href="#method_renderLayout">renderLayout</a>(
array $params = array())
<p>Build the global layout with all children contents</p> </div>
<div class="col-md-2"></div>
</div>
</div>
<h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method_render">
<div class="location">in
<a href="../../MVCFundamental/Commons/ViewFileTrait.html#method_render"><abbr title="MVCFundamental\Commons\ViewFileTrait">ViewFileTrait</abbr></a> at line 48</div>
<code>
string
<strong>render</strong>(
string $view = null,
array $params = array())</code>
</h3>
<div class="details">
<div class="method-description">
<p>Building of a view content including a view file passing it parameters</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$view</td>
<td>The view filename (which must exist)</td>
</tr>
<tr>
<td>
array</td>
<td>$params</td>
<td>An array of the parameters passed for the view parsing</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>Returns the view file content rendering</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><a href="../../MVCFundamental/Exception/Exception.html"><abbr title="MVCFundamental\Exception\Exception">Exception</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getDefaultViewParams">
<div class="location">in
<a href="../../MVCFundamental/Commons/ViewFileTrait.html#method_getDefaultViewParams"><abbr title="MVCFundamental\Commons\ViewFileTrait">ViewFileTrait</abbr></a> at line 78</div>
<code>
array
<strong>getDefaultViewParams</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Get the default parameters for all views</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>The array of default parameters</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getTemplate">
<div class="location">in
<a href="../../MVCFundamental/Commons/ViewFileTrait.html#method_getTemplate"><abbr title="MVCFundamental\Commons\ViewFileTrait">ViewFileTrait</abbr></a> at line 89</div>
<code>
string
<strong>getTemplate</strong>(
string $name)</code>
</h3>
<div class="details">
<div class="method-description">
<p>Search a view file in the current file system</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>The file path to search</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>The path of the file found</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method___construct">
<div class="location">at line 53</div>
<code>
<strong>__construct</strong>(
array $options = array())</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>$options</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method___toString">
<div class="location">at line 62</div>
<code>
string
<strong>__toString</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setLayout">
<div class="location">at line 95</div>
<code>
<abbr title="MVCFundamental\Interfaces\$this">$this</abbr>
<strong>setLayout</strong>(
string $view)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$view</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="MVCFundamental\Interfaces\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getLayout">
<div class="location">at line 103</div>
<code>
string
<strong>getLayout</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setChild">
<div class="location">at line 119</div>
<code>
<abbr title="MVCFundamental\Interfaces\$this">$this</abbr>
<strong>setChild</strong>(
string $name,
string $view,
array $params = array())</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>
</td>
</tr>
<tr>
<td>
string</td>
<td>$view</td>
<td>
</td>
</tr>
<tr>
<td>
array</td>
<td>$params</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="MVCFundamental\Interfaces\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setChildParam">
<div class="location">at line 133</div>
<code>
<abbr title="MVCFundamental\Interfaces\$this">$this</abbr>
<strong>setChildParam</strong>(
string $name,
string $param_name,
mixed $param_value)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>
</td>
</tr>
<tr>
<td>
string</td>
<td>$param_name</td>
<td>
</td>
</tr>
<tr>
<td>
mixed</td>
<td>$param_value</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="MVCFundamental\Interfaces\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
<h4>Exceptions</h4>
<table class="table table-condensed">
<tr>
<td><a href="../../MVCFundamental/Exception/ErrorException.html"><abbr title="MVCFundamental\Exception\ErrorException">ErrorException</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_setChildAsString">
<div class="location">at line 151</div>
<code>
<abbr title="MVCFundamental\Interfaces\$this">$this</abbr>
<strong>setChildAsString</strong>(
string $name,
string $content)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>
</td>
</tr>
<tr>
<td>
string</td>
<td>$content</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="MVCFundamental\Interfaces\$this">$this</abbr></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getChild">
<div class="location">at line 161</div>
<code>
mixed
<strong>getChild</strong>(
string $name)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_hasChild">
<div class="location">at line 170</div>
<code>
bool
<strong>hasChild</strong>(
string $name)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
bool</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_renderChild">
<div class="location">at line 180</div>
<code>
string
<strong>renderChild</strong>(
string $name,
array $params = array())</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>$name</td>
<td>
</td>
</tr>
<tr>
<td>
array</td>
<td>$params</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_renderLayout">
<div class="location">at line 200</div>
<code>
string
<strong>renderLayout</strong>(
array $params = array())</code>
</h3>
<div class="details">
<div class="method-description">
<p>Build the global layout with all children contents</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
array</td>
<td>$params</td>
<td>An array of the parameters passed for the view parsing</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
string</td>
<td>Returns the view file content rendering</td>
</tr>
</table>
</div>
</div>
</div>
</div>
</div>
<div id="footer">
Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.
</div>
</div>
</div>
</body>
</html>