atelierspierrot/reflectors

View on GitHub
phpdoc/Reflectors/ReflectorTrait.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8" />
    <meta name="robots" content="index, follow, all" />
    <title>Reflectors\ReflectorTrait | Reflectors (atelierspierrot/reflectors)</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:Reflectors_ReflectorTrait" 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">Reflectors (atelierspierrot/reflectors)</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">trait</span></li>
                                                            <li><a href="../Reflectors.html">Reflectors</a></li>
    
                <li>ReflectorTrait</li>
            </ol>
        </div>
                <div id="page-content">
                
    <div class="page-header">
        <h1>ReflectorTrait</h1>
    </div>

    <p>    trait
    <strong>ReflectorTrait</strong>
</p>

            <div class="description">
            <p>Basic implementation of the <code>\Reflector::export()</code> method</p>            <p>This trait defines a global <code>export()</code> method for objects
that implement the <a href="http://php.net/Reflector"><code>\Reflector</code> interface</a>.
The method will basically try to call current class constructor passing it
the first argument received and then returns or echoes its representation.</p>        </div>
    
    
    
    
            <h2>Methods</h2>

            <div class="container-fluid underlined">
                    <div class="row">
                <div class="col-md-2 type">
                    static&nbsp;
    string|null
                </div>
                <div class="col-md-8 type">
                    <a href="#method_export">export</a>(
    mixed $argument, 
    bool $return = false)
                                            <p>Creation of a new instance of the mother class on-the-fly</p>                </div>
                <div class="col-md-2"></div>
            </div>
            </div>


        <h2>Details</h2>

            <div id="method-details">
                    <div class="method-item">
                    <h3 id="method_export">
        <div class="location">at line 54</div>
        <code>        static            
    string|null
    <strong>export</strong>(
    mixed $argument, 
    bool $return = false)</code>
    </h3>
    <div class="details">
                    <div class="method-description">
                                    <p>Creation of a new instance of the mother class on-the-fly</p>                    <p>Keep in mind that this method only consider the FIRST argument passed
to transmit to the constructor. If your mother class requires more than
one argument, you will have to over-write this method (or to not use the
trait).</p>            </div>
                <div class="tags">
                            <h4>Parameters</h4>

                    <table class="table table-condensed">
                    <tr>
                <td>
    mixed</td>
                <td>$argument</td>
                <td>
</td>
            </tr>
                    <tr>
                <td>
    bool</td>
                <td>$return</td>
                <td>
</td>
            </tr>
            </table>

            
                            <h4>Return Value</h4>

                    <table class="table table-condensed">
        <tr>
            <td>
    string|null</td>
            <td>
</td>
        </tr>
    </table>

            
                            <h4>Exceptions</h4>

                    <table class="table table-condensed">
                    <tr>
                <td><a target="_blank" href="http://php.net/ErrorException"><abbr title="ErrorException">ErrorException</abbr></a></td>
                <td>if the mother class does not implement the <code>\Reflector</code> interface</td>
            </tr>
                    <tr>
                <td><a target="_blank" href="http://php.net/ErrorException"><abbr title="ErrorException">ErrorException</abbr></a></td>
                <td>if the mother class constructor is not callable</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>