atelierspierrot/service-container

View on GitHub
phpdoc/doc-index.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8" />
    <meta name="robots" content="index, follow, all" />
    <title>Index | Service Container</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="doc-index" data-name="" 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">Service Container</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 id="page-content">
                
    <div class="page-header">
        <h1>Index</h1>
    </div>

    <ul class="pagination">
                                    <li><a href="#letterA">A</a></li>
                                                <li class="disabled"><a href="#letterB">B</a></li>
                                                <li class="disabled"><a href="#letterC">C</a></li>
                                                <li class="disabled"><a href="#letterD">D</a></li>
                                                <li class="disabled"><a href="#letterE">E</a></li>
                                                <li class="disabled"><a href="#letterF">F</a></li>
                                                <li><a href="#letterG">G</a></li>
                                                <li><a href="#letterH">H</a></li>
                                                <li><a href="#letterI">I</a></li>
                                                <li class="disabled"><a href="#letterJ">J</a></li>
                                                <li class="disabled"><a href="#letterK">K</a></li>
                                                <li class="disabled"><a href="#letterL">L</a></li>
                                                <li class="disabled"><a href="#letterM">M</a></li>
                                                <li class="disabled"><a href="#letterN">N</a></li>
                                                <li class="disabled"><a href="#letterO">O</a></li>
                                                <li class="disabled"><a href="#letterP">P</a></li>
                                                <li class="disabled"><a href="#letterQ">Q</a></li>
                                                <li class="disabled"><a href="#letterR">R</a></li>
                                                <li><a href="#letterS">S</a></li>
                                                <li class="disabled"><a href="#letterT">T</a></li>
                                                <li><a href="#letterU">U</a></li>
                                                <li class="disabled"><a href="#letterV">V</a></li>
                                                <li class="disabled"><a href="#letterW">W</a></li>
                                                <li class="disabled"><a href="#letterX">X</a></li>
                                                <li class="disabled"><a href="#letterY">Y</a></li>
                                                <li class="disabled"><a href="#letterZ">Z</a></li>
                        </ul>

    <h2 id="letterA">A</h2>
        <dl id="index"><dt><a href="ServiceContainer/ApiServiceContainer.html"><abbr title="ServiceContainer\ApiServiceContainer">ApiServiceContainer</abbr></a> &mdash; <em>Class in namespace <a href="ServiceContainer.html">ServiceContainer</a></em></dt>
                    <dd>A service container with constructors based on an API declaration and validation</dd><dt>
    <a href="ServiceContainer/ApiServiceContainer.html#method_apiFactory"><abbr title="ServiceContainer\ApiServiceContainer">ApiServiceContainer</abbr>::apiFactory</a>() &mdash; <em>Method in class <a href="ServiceContainer/ApiServiceContainer.html"><abbr title="ServiceContainer\ApiServiceContainer">ApiServiceContainer</abbr></a></em></dt>
                    <dd>Usage:</dd>        </dl><h2 id="letterB">B</h2>
        <dl id="index"><dt>
    <a href="ServiceContainer/ServiceProviderInterface.html#method_boot"><abbr title="ServiceContainer\ServiceProviderInterface">ServiceProviderInterface</abbr>::boot</a>() &mdash; <em>Method in class <a href="ServiceContainer/ServiceProviderInterface.html"><abbr title="ServiceContainer\ServiceProviderInterface">ServiceProviderInterface</abbr></a></em></dt>
                    <dd>Launch actions when the service is created</dd>        </dl><h2 id="letterG">G</h2>
        <dl id="index"><dt>
    <a href="ServiceContainer/ServiceContainer.html#method_getProvider"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr>::getProvider</a>() &mdash; <em>Method in class <a href="ServiceContainer/ServiceContainer.html"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr></a></em></dt>
                    <dd>Get a service constructor if it exists</dd><dt>
    <a href="ServiceContainer/ServiceContainer.html#method_getService"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr>::getService</a>() &mdash; <em>Method in class <a href="ServiceContainer/ServiceContainer.html"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr></a></em></dt>
                    <dd>Get a service called <code>$name</code> throwing an error by default if it does not exist yet and can not be created</dd><dt>
    <a href="ServiceContainer/ServiceContainerInterface.html#method_getService"><abbr title="ServiceContainer\ServiceContainerInterface">ServiceContainerInterface</abbr>::getService</a>() &mdash; <em>Method in class <a href="ServiceContainer/ServiceContainerInterface.html"><abbr title="ServiceContainer\ServiceContainerInterface">ServiceContainerInterface</abbr></a></em></dt>
                    <dd>Get a service called <code>$name</code> throwing an error by default if it does not exist yet and can not be created</dd>        </dl><h2 id="letterH">H</h2>
        <dl id="index"><dt>
    <a href="ServiceContainer/ServiceContainer.html#method_hasProvider"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr>::hasProvider</a>() &mdash; <em>Method in class <a href="ServiceContainer/ServiceContainer.html"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr></a></em></dt>
                    <dd>Test if a constructor exists for a service</dd><dt>
    <a href="ServiceContainer/ServiceContainer.html#method_hasService"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr>::hasService</a>() &mdash; <em>Method in class <a href="ServiceContainer/ServiceContainer.html"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr></a></em></dt>
                    <dd>Test if a service exists in the container</dd><dt>
    <a href="ServiceContainer/ServiceContainerInterface.html#method_hasService"><abbr title="ServiceContainer\ServiceContainerInterface">ServiceContainerInterface</abbr>::hasService</a>() &mdash; <em>Method in class <a href="ServiceContainer/ServiceContainerInterface.html"><abbr title="ServiceContainer\ServiceContainerInterface">ServiceContainerInterface</abbr></a></em></dt>
                    <dd>Test if a service exists in the container</dd>        </dl><h2 id="letterI">I</h2>
        <dl id="index"><dt>
    <a href="ServiceContainer/ServiceContainer.html#method_init"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr>::init</a>() &mdash; <em>Method in class <a href="ServiceContainer/ServiceContainer.html"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr></a></em></dt>
                    <dd>Initialize the service container system</dd><dt>
    <a href="ServiceContainer/ServiceContainer.html#method_isProtected"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr>::isProtected</a>() &mdash; <em>Method in class <a href="ServiceContainer/ServiceContainer.html"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr></a></em></dt>
                    <dd>Test if a service is protected</dd>        </dl><h2 id="letterR">R</h2>
        <dl id="index"><dt>
    <a href="ServiceContainer/ServiceProviderInterface.html#method_register"><abbr title="ServiceContainer\ServiceProviderInterface">ServiceProviderInterface</abbr>::register</a>() &mdash; <em>Method in class <a href="ServiceContainer/ServiceProviderInterface.html"><abbr title="ServiceContainer\ServiceProviderInterface">ServiceProviderInterface</abbr></a></em></dt>
                    <dd>Launch actions when the service is registered in the container</dd>        </dl><h2 id="letterS">S</h2>
        <dl id="index"><dt><a href="ServiceContainer/ServiceContainer.html"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr></a> &mdash; <em>Class in namespace <a href="ServiceContainer.html">ServiceContainer</a></em></dt>
                    <dd>A simple service container with constructors</dd><dt>
    <a href="ServiceContainer/ServiceContainer.html#method_setProvider"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr>::setProvider</a>() &mdash; <em>Method in class <a href="ServiceContainer/ServiceContainer.html"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr></a></em></dt>
                    <dd>Define a service constructor like <code>array( name , callback , protected )</code> or a closure</dd><dt>
    <a href="ServiceContainer/ServiceContainer.html#method_setProtected"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr>::setProtected</a>() &mdash; <em>Method in class <a href="ServiceContainer/ServiceContainer.html"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr></a></em></dt>
                    <dd>Define a service as protected</dd><dt>
    <a href="ServiceContainer/ServiceContainer.html#method_setService"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr>::setService</a>() &mdash; <em>Method in class <a href="ServiceContainer/ServiceContainer.html"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr></a></em></dt>
                    <dd>Register a new service called <code>$name</code> declared as NOT protected by default</dd><dt><a href="ServiceContainer/ServiceContainerInterface.html"><abbr title="ServiceContainer\ServiceContainerInterface">ServiceContainerInterface</abbr></a> &mdash; <em>Class in namespace <a href="ServiceContainer.html">ServiceContainer</a></em></dt>
                    <dd>A simple service container interface</dd><dt>
    <a href="ServiceContainer/ServiceContainerInterface.html#method_setProvider"><abbr title="ServiceContainer\ServiceContainerInterface">ServiceContainerInterface</abbr>::setProvider</a>() &mdash; <em>Method in class <a href="ServiceContainer/ServiceContainerInterface.html"><abbr title="ServiceContainer\ServiceContainerInterface">ServiceContainerInterface</abbr></a></em></dt>
                    <dd>Define a service constructor like <code>array( name , callback , protected )</code> or a closure</dd><dt>
    <a href="ServiceContainer/ServiceContainerInterface.html#method_setService"><abbr title="ServiceContainer\ServiceContainerInterface">ServiceContainerInterface</abbr>::setService</a>() &mdash; <em>Method in class <a href="ServiceContainer/ServiceContainerInterface.html"><abbr title="ServiceContainer\ServiceContainerInterface">ServiceContainerInterface</abbr></a></em></dt>
                    <dd>Register a new service called <code>$name</code> declared as NOT protected by default</dd><dt><a href="ServiceContainer/ServiceProviderInterface.html"><abbr title="ServiceContainer\ServiceProviderInterface">ServiceProviderInterface</abbr></a> &mdash; <em>Class in namespace <a href="ServiceContainer.html">ServiceContainer</a></em></dt>
                    <dd>Interface ServiceProviderInterface</dd>        </dl><h2 id="letterT">T</h2>
        <dl id="index"><dt>
    <a href="ServiceContainer/ServiceProviderInterface.html#method_terminate"><abbr title="ServiceContainer\ServiceProviderInterface">ServiceProviderInterface</abbr>::terminate</a>() &mdash; <em>Method in class <a href="ServiceContainer/ServiceProviderInterface.html"><abbr title="ServiceContainer\ServiceProviderInterface">ServiceProviderInterface</abbr></a></em></dt>
                    <dd>Launch actions when the service is destructed</dd>        </dl><h2 id="letterU">U</h2>
        <dl id="index"><dt>
    <a href="ServiceContainer/ServiceContainer.html#method_unsetService"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr>::unsetService</a>() &mdash; <em>Method in class <a href="ServiceContainer/ServiceContainer.html"><abbr title="ServiceContainer\ServiceContainer">ServiceContainer</abbr></a></em></dt>
                    <dd>Unset a service if it is not protected</dd><dt>
    <a href="ServiceContainer/ServiceContainerInterface.html#method_unsetService"><abbr title="ServiceContainer\ServiceContainerInterface">ServiceContainerInterface</abbr>::unsetService</a>() &mdash; <em>Method in class <a href="ServiceContainer/ServiceContainerInterface.html"><abbr title="ServiceContainer\ServiceContainerInterface">ServiceContainerInterface</abbr></a></em></dt>
                    <dd>Unset a service if it is not protected</dd>        </dl>            </div>
                <div id="footer">
        Generated by <a href="http://sami.sensiolabs.org/">Sami, the API Documentation Generator</a>.
    </div>

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

</html>