phpdoc/MVCFundamental/AppKernel.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="robots" content="index, follow, all" />
<title>MVCFundamental\AppKernel | 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_AppKernel" 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>AppKernel</li>
</ol>
</div>
<div id="page-content">
<div class="page-header">
<h1>AppKernel</h1>
</div>
<p> class
<strong>AppKernel</strong> extends <abbr title="Library\ServiceContainer\ServiceContainer">ServiceContainer</abbr> implements
<a href="../MVCFundamental/Interfaces/AppKernelInterface.html"><abbr title="MVCFundamental\Interfaces\AppKernelInterface">AppKernelInterface</abbr></a>
</p>
<div class="description">
<p>Class AppKernel: the root core of the application</p> </div>
<h2>Traits</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-6">
<abbr title="Patterns\Traits\SingletonTrait">Patterns\Traits\SingletonTrait</abbr>
</div>
<div class="col-md-6">
</div>
</div>
<div class="row">
<div class="col-md-6">
<a href="../MVCFundamental/Commons/ServiceContainerProviderTrait.html"><abbr title="MVCFundamental\Commons\ServiceContainerProviderTrait">MVCFundamental\Commons\ServiceContainerProviderTrait</abbr></a>
</div>
<div class="col-md-6">
ServiceContainerProviderTrait
</div>
</div>
</div>
<h2>Methods</h2>
<div class="container-fluid underlined">
<div class="row">
<div class="col-md-2 type">
mixed
</div>
<div class="col-md-8 type">
<a href="#method___call">__call</a>(
string $name,
array $arguments)
<p>This must allow some shortcuts to access a service</p> </div>
<div class="col-md-2"><small>from
<a href="../MVCFundamental/Commons/ServiceContainerProviderTrait.html#method___call"><abbr title="MVCFundamental\Commons\ServiceContainerProviderTrait">ServiceContainerProviderTrait</abbr></a></small></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
mixed
</div>
<div class="col-md-8 type">
<a href="#method___callStatic">__callStatic</a>(
string $name,
array $arguments)
<p>This must allow some shortcuts to access a service</p> </div>
<div class="col-md-2"><small>from
<a href="../MVCFundamental/Commons/ServiceContainerProviderTrait.html#method___callStatic"><abbr title="MVCFundamental\Commons\ServiceContainerProviderTrait">ServiceContainerProviderTrait</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>()
<p>Avoid public construction of the object and prefer the <code>getInstance()</code> static singleton access</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
null|string
</div>
<div class="col-md-8 type">
<a href="#method_getApi">getApi</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">
static
bool
</div>
<div class="col-md-8 type">
<a href="#method_isApiValid">isApiValid</a>(
string $name,
object|callable $object)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
object
</div>
<div class="col-md-8 type">
<a href="#method_apiFactory">apiFactory</a>(
string $name,
string $class,
array $arguments = 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">
static
</div>
<div class="col-md-8 type">
<a href="#method_setFrontController">setFrontController</a>(
<abbr title="MVCFundamental\Interfaces\MVCFundamental\Interfaces\FrontControllerInterface">FrontControllerInterface</abbr> $app)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
<a href="../MVCFundamental/Interfaces/FrontControllerInterface.html"><abbr title="MVCFundamental\Interfaces\FrontControllerInterface">FrontControllerInterface</abbr></a>
</div>
<div class="col-md-8 type">
<a href="#method_getFrontController">getFrontController</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">
static
mixed
</div>
<div class="col-md-8 type">
<a href="#method_boot">boot</a>(
<abbr title="MVCFundamental\Interfaces\MVCFundamental\Interfaces\FrontControllerInterface">FrontControllerInterface</abbr> $app)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
mixed
</div>
<div class="col-md-8 type">
<a href="#method_terminate">terminate</a>(
<abbr title="MVCFundamental\Interfaces\MVCFundamental\Interfaces\FrontControllerInterface">FrontControllerInterface</abbr> $app)
<p>This must be called when the system terminates its run</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
void
</div>
<div class="col-md-8 type">
<a href="#method_abort">abort</a>(
<abbr title="MVCFundamental\Interfaces\Exception">Exception</abbr> $e)
<p>This must abort a runtime safely</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
void
</div>
<div class="col-md-8 type">
<a href="#method_handleException">handleException</a>(
<abbr title="MVCFundamental\Interfaces\Exception">Exception</abbr> $e)
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
void
</div>
<div class="col-md-8 type">
<a href="#method_handleError">handleError</a>(
int $errno,
string $errstr = '',
string $errfile = '',
int $errline,
array $errcontext = 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">
static
void
</div>
<div class="col-md-8 type">
<a href="#method_handleShutdown">handleShutdown</a>()
<p>This must handle runtime shutdown</p> </div>
<div class="col-md-2"></div>
</div>
<div class="row">
<div class="col-md-2 type">
static
void
</div>
<div class="col-md-8 type">
<a href="#method_log">log</a>(
mixed $level,
string $message,
array $context = array())
<p class="no-description">No description</p>
</div>
<div class="col-md-2"></div>
</div>
</div>
<h2>Details</h2>
<div id="method-details">
<div class="method-item">
<h3 id="method___call">
<div class="location">in
<a href="../MVCFundamental/Commons/ServiceContainerProviderTrait.html#method___call"><abbr title="MVCFundamental\Commons\ServiceContainerProviderTrait">ServiceContainerProviderTrait</abbr></a> at line 45</div>
<code>
mixed
<strong>__call</strong>(
string $name,
array $arguments)</code>
</h3>
<div class="details">
<div class="method-description">
<p>This must allow some shortcuts to access a service</p> </div>
<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>$arguments</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___callStatic">
<div class="location">in
<a href="../MVCFundamental/Commons/ServiceContainerProviderTrait.html#method___callStatic"><abbr title="MVCFundamental\Commons\ServiceContainerProviderTrait">ServiceContainerProviderTrait</abbr></a> at line 57</div>
<code> static
mixed
<strong>__callStatic</strong>(
string $name,
array $arguments)</code>
</h3>
<div class="details">
<div class="method-description">
<p>This must allow some shortcuts to access a service</p> </div>
<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>$arguments</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___construct">
<div class="location">at line 90</div>
<code>
<strong>__construct</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>Avoid public construction of the object and prefer the <code>getInstance()</code> static singleton access</p> </div>
<div class="tags">
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getApi">
<div class="location">at line 125</div>
<code> static
null|string
<strong>getApi</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>
null|string</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_isApiValid">
<div class="location">at line 136</div>
<code> static
bool
<strong>isApiValid</strong>(
string $name,
object|callable $object)</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>
object|callable</td>
<td>$object</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_apiFactory">
<div class="location">at line 153</div>
<code> static
object
<strong>apiFactory</strong>(
string $name,
string $class,
array $arguments = 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>$class</td>
<td>
</td>
</tr>
<tr>
<td>
array</td>
<td>$arguments</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
object</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_setFrontController">
<div class="location">at line 184</div>
<code> static
<strong>setFrontController</strong>(
<abbr title="MVCFundamental\Interfaces\MVCFundamental\Interfaces\FrontControllerInterface">FrontControllerInterface</abbr> $app)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="MVCFundamental\Interfaces\MVCFundamental\Interfaces\FrontControllerInterface">FrontControllerInterface</abbr></td>
<td>$app</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_getFrontController">
<div class="location">at line 192</div>
<code> static
<a href="../MVCFundamental/Interfaces/FrontControllerInterface.html"><abbr title="MVCFundamental\Interfaces\FrontControllerInterface">FrontControllerInterface</abbr></a>
<strong>getFrontController</strong>()</code>
</h3>
<div class="details">
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
<a href="../MVCFundamental/Interfaces/FrontControllerInterface.html"><abbr title="MVCFundamental\Interfaces\FrontControllerInterface">FrontControllerInterface</abbr></a></td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_boot">
<div class="location">at line 206</div>
<code> static
mixed
<strong>boot</strong>(
<abbr title="MVCFundamental\Interfaces\MVCFundamental\Interfaces\FrontControllerInterface">FrontControllerInterface</abbr> $app)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="MVCFundamental\Interfaces\MVCFundamental\Interfaces\FrontControllerInterface">FrontControllerInterface</abbr></td>
<td>$app</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</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_terminate">
<div class="location">at line 285</div>
<code> static
mixed
<strong>terminate</strong>(
<abbr title="MVCFundamental\Interfaces\MVCFundamental\Interfaces\FrontControllerInterface">FrontControllerInterface</abbr> $app)</code>
</h3>
<div class="details">
<div class="method-description">
<p>This must be called when the system terminates its run</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="MVCFundamental\Interfaces\MVCFundamental\Interfaces\FrontControllerInterface">FrontControllerInterface</abbr></td>
<td>$app</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_abort">
<div class="location">at line 297</div>
<code> static
void
<strong>abort</strong>(
<abbr title="MVCFundamental\Interfaces\Exception">Exception</abbr> $e)</code>
</h3>
<div class="details">
<div class="method-description">
<p>This must abort a runtime safely</p> </div>
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="MVCFundamental\Interfaces\Exception">Exception</abbr></td>
<td>$e</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_handleException">
<div class="location">at line 306</div>
<code> static
void
<strong>handleException</strong>(
<abbr title="MVCFundamental\Interfaces\Exception">Exception</abbr> $e)</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
<abbr title="MVCFundamental\Interfaces\Exception">Exception</abbr></td>
<td>$e</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</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_handleError">
<div class="location">at line 331</div>
<code> static
void
<strong>handleError</strong>(
int $errno,
string $errstr = '',
string $errfile = '',
int $errline,
array $errcontext = array())</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
int</td>
<td>$errno</td>
<td>
</td>
</tr>
<tr>
<td>
string</td>
<td>$errstr</td>
<td>
</td>
</tr>
<tr>
<td>
string</td>
<td>$errfile</td>
<td>
</td>
</tr>
<tr>
<td>
int</td>
<td>$errline</td>
<td>
</td>
</tr>
<tr>
<td>
array</td>
<td>$errcontext</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</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_handleShutdown">
<div class="location">at line 344</div>
<code> static
void
<strong>handleShutdown</strong>()</code>
</h3>
<div class="details">
<div class="method-description">
<p>This must handle runtime shutdown</p> </div>
<div class="tags">
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</td>
<td>
</td>
</tr>
</table>
</div>
</div>
</div>
<div class="method-item">
<h3 id="method_log">
<div class="location">at line 355</div>
<code> static
void
<strong>log</strong>(
mixed $level,
string $message,
array $context = array())</code>
</h3>
<div class="details">
<div class="tags">
<h4>Parameters</h4>
<table class="table table-condensed">
<tr>
<td>
mixed</td>
<td>$level</td>
<td>
</td>
</tr>
<tr>
<td>
string</td>
<td>$message</td>
<td>
</td>
</tr>
<tr>
<td>
array</td>
<td>$context</td>
<td>
</td>
</tr>
</table>
<h4>Return Value</h4>
<table class="table table-condensed">
<tr>
<td>
void</td>
<td>
</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>