atelierspierrot/mvc-fundamental

View on GitHub
phpdoc/MVCFundamental/Interfaces/AppKernelInterface.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8" />
    <meta name="robots" content="index, follow, all" />
    <title>MVCFundamental\Interfaces\AppKernelInterface | 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_Interfaces_AppKernelInterface" 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">interface</span></li>
                                                            <li><a href="../../MVCFundamental.html">MVCFundamental</a></li>
                                        <li><a href="../../MVCFundamental/Interfaces.html">Interfaces</a></li>
    
                <li>AppKernelInterface</li>
            </ol>
        </div>
                <div id="page-content">
                
    <div class="page-header">
        <h1>AppKernelInterface</h1>
    </div>

    <p>    interface
    <strong>AppKernelInterface</strong>        implements
        <abbr title="Patterns\Interfaces\SingletonInterface">SingletonInterface</abbr>, <a href="../../MVCFundamental/Interfaces/ServiceContainerProviderInterface.html"><abbr title="MVCFundamental\Interfaces\ServiceContainerProviderInterface">ServiceContainerProviderInterface</abbr></a>, <a href="../../MVCFundamental/Interfaces/FrontControllerAwareInterface.html"><abbr title="MVCFundamental\Interfaces\FrontControllerAwareInterface">FrontControllerAwareInterface</abbr></a>
</p>

            <div class="description">
            <p>Interface AppKernelInterface</p>                    </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&nbsp;
    <a href="../../MVCFundamental/Interfaces/ServiceContainerProviderInterface.html#method___call"><abbr title="MVCFundamental\Interfaces\ServiceContainerProviderInterface">ServiceContainerProviderInterface</abbr></a></small></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    static&nbsp;
    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&nbsp;
    <a href="../../MVCFundamental/Interfaces/ServiceContainerProviderInterface.html#method___callStatic"><abbr title="MVCFundamental\Interfaces\ServiceContainerProviderInterface">ServiceContainerProviderInterface</abbr></a></small></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    static&nbsp;
    
                </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"><small>from&nbsp;
    <a href="../../MVCFundamental/Interfaces/FrontControllerAwareInterface.html#method_setFrontController"><abbr title="MVCFundamental\Interfaces\FrontControllerAwareInterface">FrontControllerAwareInterface</abbr></a></small></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    static&nbsp;
    <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"><small>from&nbsp;
    <a href="../../MVCFundamental/Interfaces/FrontControllerAwareInterface.html#method_getFrontController"><abbr title="MVCFundamental\Interfaces\FrontControllerAwareInterface">FrontControllerAwareInterface</abbr></a></small></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    static&nbsp;
    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>This must be called when the system boots</p>                </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    static&nbsp;
    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&nbsp;
    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&nbsp;
    void
                </div>
                <div class="col-md-8 type">
                    <a href="#method_log">log</a>(
    mixed $level, 
    string $message, 
    array $context = array())
                                            <p>This must handle a logging system</p>                </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    static&nbsp;
    void
                </div>
                <div class="col-md-8 type">
                    <a href="#method_handleException">handleException</a>(
    <abbr title="MVCFundamental\Interfaces\Exception">Exception</abbr> $e)
                                            <p>This must handle caught exceptions</p>                </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    static&nbsp;
    void
                </div>
                <div class="col-md-8 type">
                    <a href="#method_handleError">handleError</a>(
    int $errno, 
    string $errstr = &#039;&#039;, 
    string $errfile = &#039;&#039;, 
    int $errline, 
    array $errcontext = array())
                                            <p>This must handle caught errors</p>                </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    static&nbsp;
    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>


        <h2>Details</h2>

            <div id="method-details">
                    <div class="method-item">
                    <h3 id="method___call">
        <div class="location">in 
    <a href="../../MVCFundamental/Interfaces/ServiceContainerProviderInterface.html#method___call"><abbr title="MVCFundamental\Interfaces\ServiceContainerProviderInterface">ServiceContainerProviderInterface</abbr></a> at line 43</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>                    <p>Usage:</p>

<pre><code> $obj-&gt;get('request') == $obj-&gt;getService('request')
 $obj-&gt;getRequest() == $obj-&gt;getService('request')
</code></pre>
</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/Interfaces/ServiceContainerProviderInterface.html#method___callStatic"><abbr title="MVCFundamental\Interfaces\ServiceContainerProviderInterface">ServiceContainerProviderInterface</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>                    <p>Usage:</p>

<pre><code> $obj::get('request') == $obj::getInstance()-&gt;getService('request')
 $obj::getRequest() == $obj::getInstance()-&gt;getService('request')
</code></pre>
</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_setFrontController">
        <div class="location">in 
    <a href="../../MVCFundamental/Interfaces/FrontControllerAwareInterface.html#method_setFrontController"><abbr title="MVCFundamental\Interfaces\FrontControllerAwareInterface">FrontControllerAwareInterface</abbr></a> at line 34</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">in 
    <a href="../../MVCFundamental/Interfaces/FrontControllerAwareInterface.html#method_getFrontController"><abbr title="MVCFundamental\Interfaces\FrontControllerAwareInterface">FrontControllerAwareInterface</abbr></a> at line 39</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 40</div>
        <code>        static            
    mixed
    <strong>boot</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 boots</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_terminate">
        <div class="location">at line 48</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 56</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_log">
        <div class="location">at line 66</div>
        <code>        static            
    void
    <strong>log</strong>(
    mixed $level, 
    string $message, 
    array $context = array())</code>
    </h3>
    <div class="details">
                    <div class="method-description">
                                    <p>This must handle a logging system</p>                                </div>
                <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 class="method-item">
                    <h3 id="method_handleException">
        <div class="location">at line 74</div>
        <code>        static            
    void
    <strong>handleException</strong>(
    <abbr title="MVCFundamental\Interfaces\Exception">Exception</abbr> $e)</code>
    </h3>
    <div class="details">
                    <div class="method-description">
                                    <p>This must handle caught exceptions</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_handleError">
        <div class="location">at line 86</div>
        <code>        static            
    void
    <strong>handleError</strong>(
    int $errno, 
    string $errstr = &#039;&#039;, 
    string $errfile = &#039;&#039;, 
    int $errline, 
    array $errcontext = array())</code>
    </h3>
    <div class="details">
                    <div class="method-description">
                                    <p>This must handle caught errors</p>                                </div>
                <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>

            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_handleShutdown">
        <div class="location">at line 93</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>

    
            </div>
                <div id="footer">
        Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.
    </div>

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

</html>