BaguettePHP/mastodon-api

View on GitHub
docs/class-Teto.Object.ObjectArray.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8">

    <title>Class Teto\Object\ObjectArray | ξ ^ω^)ξ Baguette PHP Mastodon API Client / SDK</title>

    <link rel="stylesheet" href="resources/style.css?c2f33731c1948fbed7c333554678bfa68d4817da">

</head>

<body>
<div id="left">
    <div id="menu">
        <a href="index.html" title="Overview"><span>Overview</span></a>


        <div id="groups">
                <h3>Namespaces</h3>
            <ul>
                <li>
                    <a href="namespace-Baguette.html">
                        Baguette<span></span>
                    </a>

                        <ul>
                <li>
                    <a href="namespace-Baguette.Mastodon.html">
                        Mastodon<span></span>
                    </a>

                        <ul>
                <li class="main">
                    <a href="namespace-Baguette.Mastodon.Config.html">
                        Config                    </a>

                        </li>
                <li class="main">
                    <a href="namespace-Baguette.Mastodon.Entity.html">
                        Entity                    </a>

                        </li>
                <li class="main">
                    <a href="namespace-Baguette.Mastodon.Grant.html">
                        Grant                    </a>

                        </li>
                <li class="main">
                    <a href="namespace-Baguette.Mastodon.Service.html">
                        Service                    </a>

                        </li>
                            </ul></li></ul></li>
                <li>
                    <a href="namespace-GuzzleHttp.html">
                        GuzzleHttp<span></span>
                    </a>

                        <ul>
                <li>
                    <a href="namespace-GuzzleHttp.Cookie.html">
                        Cookie                    </a>

                        </li>
                <li>
                    <a href="namespace-GuzzleHttp.Exception.html">
                        Exception                    </a>

                        </li>
                <li>
                    <a href="namespace-GuzzleHttp.Handler.html">
                        Handler                    </a>

                        </li>
                <li>
                    <a href="namespace-GuzzleHttp.Promise.html">
                        Promise                    </a>

                        </li>
                            </ul></li>
                <li>
                    <a href="namespace-Psr.html">
                        Psr<span></span>
                    </a>

                        <ul>
                <li>
                    <a href="namespace-Psr.Http.html">
                        Http<span></span>
                    </a>

                        <ul>
                <li>
                    <a href="namespace-Psr.Http.Message.html">
                        Message                    </a>

                        </li>
                            </ul></li></ul></li>
                <li class="active">
                    <a href="namespace-Teto.html">
                        Teto<span></span>
                    </a>

                        <ul>
                <li class="active">
                    <a href="namespace-Teto.Object.html">
                        Object                    </a>

                        </li>
                            </ul></li>
            </ul>
        </div>

        <hr>


        <div id="elements">
            <h3>Classes</h3>
            <ul>
                <li><a href="class-Teto.Object.Helper.html">Helper</a></li>
                <li class="active"><a href="class-Teto.Object.ObjectArray.html">ObjectArray</a></li>
                <li><a href="class-Teto.Object.TypeDefinition.html">TypeDefinition</a></li>
            </ul>

            <h3>Interfaces</h3>
            <ul>
                <li><a href="class-Teto.Object.ToArrayInterface.html">ToArrayInterface</a></li>
            </ul>

            <h3>Traits</h3>
            <ul>
                <li><a href="class-Teto.Object.MethodAlias.html">MethodAlias</a></li>
                <li><a href="class-Teto.Object.PrivateGetter.html">PrivateGetter</a></li>
                <li><a href="class-Teto.Object.PrivateStrictGetter.html">PrivateStrictGetter</a></li>
                <li><a href="class-Teto.Object.PropertyLikeMethod.html">PropertyLikeMethod</a></li>
                <li><a href="class-Teto.Object.ReadOnly.html">ReadOnly</a></li>
                <li><a href="class-Teto.Object.TypeAssert.html">TypeAssert</a></li>
                <li><a href="class-Teto.Object.TypedProperty.html">TypedProperty</a></li>
            </ul>



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

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
    <form id="search">
        <input type="hidden" name="cx" value="">
        <input type="hidden" name="ie" value="UTF-8">
        <input type="text" name="q" class="text" placeholder="Search">
    </form>

    <div id="navigation">
        <ul>
            <li>
                <a href="index.html" title="Overview"><span>Overview</span></a>
            </li>
            <li>
                <a href="namespace-Teto.Object.html" title="Summary of Teto\Object"><span>Namespace</span></a>
            </li>
            <li class="active">
<span>Class</span>            </li>
        </ul>
        <ul>
        </ul>
        <ul>
        </ul>
    </div>

<div id="content" class="class">
    <h1>Class ObjectArray</h1>


    <div class="description">
    <p>Interface for array compatible object</p>
    </div>

    <dl class="tree">
        <dd style="padding-left:0px">
<b><span>Teto\Object\ObjectArray</span></b>            
             implements 
<span>ArrayAccess</span>, 
            
<span>Countable</span>, 
            
<span>IteratorAggregate</span>, 
            
                <a href="class-Teto.Object.ToArrayInterface.html"><span>Teto\Object\ToArrayInterface</span></a>
            
            
        </dd>
    </dl>








    <div class="info">
        
        
        <b>Namespace:</b> <a href="namespace-Teto.html">Teto</a>\<a href="namespace-Teto.Object.html">Object</a><br>
        

                <b>Copyright:</b>
                2016 Baguette HQ<br>
                <b>License:</b>
                <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a><br>
                <b>Author:</b>
                USAMI Kenta <a href="&#x6d;&#97;&#105;&#x6c;&#x74;&#111;:&#x74;&#97;&#100;&#x73;&#x61;&#110;&#64;&#x7a;&#111;&#110;&#x75;&#x2e;&#109;&#101;">&#x74;&#97;&#100;&#x73;&#x61;&#110;&#64;&#x7a;&#111;&#110;&#x75;&#x2e;&#109;&#101;</a><br>
            <b>Located at</b> <a href="source-class-Teto.Object.ObjectArray.html#5-152" title="Go to source code">Object/ObjectArray.php</a>
        <br>
    </div>



    <table class="summary methods" id="methods">
    <caption>Methods summary</caption>
    <tr data-order="__construct" id="___construct">

        <td class="attributes"><code>
             public 

            
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#___construct">#</a>
        <code><a href="source-class-Teto.Object.ObjectArray.html#16-22" title="Go to source code">__construct</a>( )</code>

        <div class="description short">
            
        </div>

        <div class="description detailed hidden">
            







        </div>
        </div></td>
    </tr>
    <tr data-order="fromArray" id="_fromArray">

        <td class="attributes"><code>
             public static

            <code><a href="class-Teto.Object.ObjectArray.html">Teto\Object\ObjectArray</a></code>
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#_fromArray">#</a>
        <code><a href="source-class-Teto.Object.ObjectArray.html#24-41" title="Go to source code">fromArray</a>( <span><code><a href="class-Teto.Object.ObjectArray.html">Teto\Object\ObjectArray</a></code>|object[] <var>$objects</var></span> )</code>

        <div class="description short">
            
        </div>

        <div class="description detailed hidden">
            


                <h4>Parameters</h4>
                <div class="list"><dl>
                    <dt><var>$objects</var></dt>
                    <dd></dd>
                </dl></div>

                <h4>Returns</h4>
                <div class="list">
                    <code><a href="class-Teto.Object.ObjectArray.html">Teto\Object\ObjectArray</a></code>
                </div>

                <h4>Throws</h4>
                <div class="list">
                    InvalidArgumentException
                </div>



        </div>
        </div></td>
    </tr>
    <tr data-order="toArray" id="_toArray">

        <td class="attributes"><code>
             public 

            array
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#_toArray">#</a>
        <code><a href="source-class-Teto.Object.ObjectArray.html#43-54" title="Go to source code">toArray</a>( )</code>

        <div class="description short">
            
        </div>

        <div class="description detailed hidden">
            



                <h4>Returns</h4>
                <div class="list">
                    array
                </div>




                <h4>Implementation of</h4>
                <div class="list"><code><a href="class-Teto.Object.ToArrayInterface.html#_toArray">Teto\Object\ToArrayInterface::toArray()</a></code></div>
        </div>
        </div></td>
    </tr>
    <tr data-order="toArrayRec" id="_toArrayRec">

        <td class="attributes"><code>
             public static

            
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#_toArrayRec">#</a>
        <code><a href="source-class-Teto.Object.ObjectArray.html#56-83" title="Go to source code">toArrayRec</a>( <span>mixed <var>$object</var></span>, <span>integer <var>$rec</var> = <span class="php-num">5</span></span> )</code>

        <div class="description short">
            <p>Convert elements to recursive array</p>
        </div>

        <div class="description detailed hidden">
            <p>Convert elements to recursive array</p>


                <h4>Parameters</h4>
                <div class="list"><dl>
                    <dt><var>$object</var></dt>
                    <dd></dd>
                    <dt><var>$rec</var></dt>
                    <dd>ネストの深さ</dd>
                </dl></div>





        </div>
        </div></td>
    </tr>
    <tr data-order="getObjects" id="_getObjects">

        <td class="attributes"><code>
             public 

            
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#_getObjects">#</a>
        <code><a href="source-class-Teto.Object.ObjectArray.html#85-88" title="Go to source code">getObjects</a>( )</code>

        <div class="description short">
            
        </div>

        <div class="description detailed hidden">
            







        </div>
        </div></td>
    </tr>
    <tr data-order="count" id="_count">

        <td class="attributes"><code>
             public 

            integer
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#_count">#</a>
        <code><a href="source-class-Teto.Object.ObjectArray.html#90-96" title="Go to source code">count</a>( )</code>

        <div class="description short">
            
        </div>

        <div class="description detailed hidden">
            



                <h4>Returns</h4>
                <div class="list">
                    integer
                </div>




                <h4>Implementation of</h4>
                <div class="list"><code>Countable::count()</code></div>
        </div>
        </div></td>
    </tr>
    <tr data-order="offsetExists" id="_offsetExists">

        <td class="attributes"><code>
             public 

            boolean
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#_offsetExists">#</a>
        <code><a href="source-class-Teto.Object.ObjectArray.html#98-105" title="Go to source code">offsetExists</a>( <span>mixed <var>$offset</var></span> )</code>

        <div class="description short">
            
        </div>

        <div class="description detailed hidden">
            


                <h4>Parameters</h4>
                <div class="list"><dl>
                    <dt><var>$offset</var></dt>
                    <dd>offset</dd>
                </dl></div>

                <h4>Returns</h4>
                <div class="list">
                    boolean
                </div>




                <h4>Implementation of</h4>
                <div class="list"><code>ArrayAccess::offsetExists()</code></div>
        </div>
        </div></td>
    </tr>
    <tr data-order="offsetGet" id="_offsetGet">

        <td class="attributes"><code>
             public 

            mixed
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#_offsetGet">#</a>
        <code><a href="source-class-Teto.Object.ObjectArray.html#107-119" title="Go to source code">offsetGet</a>( <span>mixed <var>$offset</var></span> )</code>

        <div class="description short">
            
        </div>

        <div class="description detailed hidden">
            


                <h4>Parameters</h4>
                <div class="list"><dl>
                    <dt><var>$offset</var></dt>
                    <dd>offset</dd>
                </dl></div>

                <h4>Returns</h4>
                <div class="list">
                    mixed
                </div>

                <h4>Throws</h4>
                <div class="list">
                    OutOfBoundsException
                </div>



                <h4>Implementation of</h4>
                <div class="list"><code>ArrayAccess::offsetGet()</code></div>
        </div>
        </div></td>
    </tr>
    <tr data-order="offsetSet" id="_offsetSet">

        <td class="attributes"><code>
             public 

            
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#_offsetSet">#</a>
        <code><a href="source-class-Teto.Object.ObjectArray.html#121-134" title="Go to source code">offsetSet</a>( <span>mixed <var>$offset</var></span>, <span>mixed <var>$value</var></span> )</code>

        <div class="description short">
            
        </div>

        <div class="description detailed hidden">
            


                <h4>Parameters</h4>
                <div class="list"><dl>
                    <dt><var>$offset</var></dt>
                    <dd>offset</dd>
                    <dt><var>$value</var></dt>
                    <dd>value</dd>
                </dl></div>


                <h4>Throws</h4>
                <div class="list">
                    OutOfBoundsException
                </div>



                <h4>Implementation of</h4>
                <div class="list"><code>ArrayAccess::offsetSet()</code></div>
        </div>
        </div></td>
    </tr>
    <tr data-order="offsetUnset" id="_offsetUnset">

        <td class="attributes"><code>
             public 

            
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#_offsetUnset">#</a>
        <code><a href="source-class-Teto.Object.ObjectArray.html#136-143" title="Go to source code">offsetUnset</a>( <span>mixed <var>$offset</var></span> )</code>

        <div class="description short">
            
        </div>

        <div class="description detailed hidden">
            


                <h4>Parameters</h4>
                <div class="list"><dl>
                    <dt><var>$offset</var></dt>
                    <dd>offset</dd>
                </dl></div>





                <h4>Implementation of</h4>
                <div class="list"><code>ArrayAccess::offsetUnset()</code></div>
        </div>
        </div></td>
    </tr>
    <tr data-order="getIterator" id="_getIterator">

        <td class="attributes"><code>
             public 

            ArrayIterator
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#_getIterator">#</a>
        <code><a href="source-class-Teto.Object.ObjectArray.html#145-151" title="Go to source code">getIterator</a>( )</code>

        <div class="description short">
            
        </div>

        <div class="description detailed hidden">
            



                <h4>Returns</h4>
                <div class="list">
                    ArrayIterator
                </div>




                <h4>Implementation of</h4>
                <div class="list"><code>IteratorAggregate::getIterator()</code></div>
        </div>
        </div></td>
    </tr>
    </table>


















</div>

    <div id="footer">
        ξ ^ω^)ξ Baguette PHP Mastodon API Client / SDK API documentation generated by <a href="http://apigen.org">ApiGen</a>
    </div>
</div>
</div>
<script src="resources/combined.js"></script>
<script src="elementlist.js"></script>
</body>
</html>