atelierspierrot/patterns

View on GitHub
phpdoc/Patterns/Abstracts/AbstractStaticCreator.html

Summary

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

    <p>    class
    <strong>AbstractStaticCreator</strong>        implements
        <a href="../../Patterns/Interfaces/StaticCreatorInterface.html"><abbr title="Patterns\Interfaces\StaticCreatorInterface">StaticCreatorInterface</abbr></a>
</p>

            <div class="description">
            <p>This class allows to create objects that can be statically created "on-the-fly" to allow
method chaining constructing them like:</p>            <p>$obj = ObjectStaticCreator::create( arguments )
        ->method();</p>

<p>This logic is implemented through a required <code>init()</code> method in children class that will be called
on static creation (in non-static environment) and by constructor.</p>        </div>
    
    
    
    
            <h2>Methods</h2>

            <div class="container-fluid underlined">
                    <div class="row">
                <div class="col-md-2 type">
                    
    
                </div>
                <div class="col-md-8 type">
                    <a href="#method_init">init</a>()
                                            <p>Force any descendant to implement a special constructor <code>init()</code> as it will be called by the <code>create()</code> static method</p>                </div>
                <div class="col-md-2"></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>Magic default constructor for non-static use</p>                </div>
                <div class="col-md-2"></div>
            </div>
                    <div class="row">
                <div class="col-md-2 type">
                    static&nbsp;
    <a href="../../Patterns/Interfaces/StaticCreatorInterface.html"><abbr title="Patterns\Interfaces\StaticCreatorInterface">StaticCreatorInterface</abbr></a>
                </div>
                <div class="col-md-8 type">
                    <a href="#method_create">create</a>()
                                            <p>Static creation of the object</p>                </div>
                <div class="col-md-2"></div>
            </div>
            </div>


        <h2>Details</h2>

            <div id="method-details">
                    <div class="method-item">
                    <h3 id="method_init">
        <div class="location">at line 46</div>
        <code>    abstract                
    
    <strong>init</strong>()</code>
    </h3>
    <div class="details">
                    <div class="method-description">
                                    <p>Force any descendant to implement a special constructor <code>init()</code> as it will be called by the <code>create()</code> static method</p>                                </div>
                <div class="tags">
            
            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method___construct">
        <div class="location">at line 53</div>
        <code>                    
    
    <strong>__construct</strong>()</code>
    </h3>
    <div class="details">
                    <div class="method-description">
                                    <p>Magic default constructor for non-static use</p>                    <p>This may use the same arguments as the <code>init()</code> method.</p>            </div>
                <div class="tags">
            
            
            
                    </div>
    </div>

            </div>
                    <div class="method-item">
                    <h3 id="method_create">
        <div class="location">at line 65</div>
        <code>        static            
    <a href="../../Patterns/Interfaces/StaticCreatorInterface.html"><abbr title="Patterns\Interfaces\StaticCreatorInterface">StaticCreatorInterface</abbr></a>
    <strong>create</strong>()</code>
    </h3>
    <div class="details">
                    <div class="method-description">
                                    <p>Static creation of the object</p>                    <p>This may use the same arguments as the <code>init()</code> method.</p>            </div>
                <div class="tags">
            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    <a href="../../Patterns/Interfaces/StaticCreatorInterface.html"><abbr title="Patterns\Interfaces\StaticCreatorInterface">StaticCreatorInterface</abbr></a></td>
            <td>Must return a new instance of the object created with function arguments</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>