BaguettePHP/mastodon-api

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

Summary

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

    <title>Trait Teto\Object\TypedProperty | ξ ^ω^)ξ 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><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 class="active"><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>Trait TypedProperty</h1>


    <div class="description">
    <p>Typed property function for class</p>
    </div>

    <dl class="tree">
        <dd style="padding-left:0px">
<b><span>Teto\Object\TypedProperty</span></b>            
            
             uses 
                    <a href="class-Teto.Object.TypeAssert.html"><span>Teto\Object\TypeAssert</span></a>
            
        </dd>
    </dl>






    <div>
        <h4>Direct Known Users</h4>
            <a href="class-Baguette.Mastodon.Entity.Account.html">Baguette\Mastodon\Entity\Account</a>, 
            <a href="class-Baguette.Mastodon.Entity.Application.html">Baguette\Mastodon\Entity\Application</a>, 
            <a href="class-Baguette.Mastodon.Entity.Tag.html">Baguette\Mastodon\Entity\Tag</a>, 
            <a href="class-Baguette.Mastodon.Entity.Attachment.html">Baguette\Mastodon\Entity\Attachment</a>, 
            <a href="class-Baguette.Mastodon.Entity.Card.html">Baguette\Mastodon\Entity\Card</a>, 
            <a href="class-Baguette.Mastodon.Entity.Context.html">Baguette\Mastodon\Entity\Context</a>, 
            <a href="class-Baguette.Mastodon.Entity.Error_.html">Baguette\Mastodon\Entity\Error_</a>, 
            <a href="class-Baguette.Mastodon.Entity.Instance.html">Baguette\Mastodon\Entity\Instance</a>, 
            <a href="class-Baguette.Mastodon.Entity.Mention.html">Baguette\Mastodon\Entity\Mention</a>, 
            <a href="class-Baguette.Mastodon.Entity.Notification.html">Baguette\Mastodon\Entity\Notification</a>, 
            <a href="class-Baguette.Mastodon.Entity.Status.html">Baguette\Mastodon\Entity\Status</a>
    </div>


    <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.TypedProperty.html#5-102" title="Go to source code">Object/TypedProperty.php</a>
        <br>
    </div>



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

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

            
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#___set">#</a>
        <code><a href="source-class-Teto.Object.TypedProperty.html#19-52" title="Go to source code">__set</a>( <span>string <var>$name</var></span>, <span>mixed <var>$value</var></span> )</code>

        <div class="description short">
            <p>Set property (magic method)</p>
        </div>

        <div class="description detailed hidden">
            <p>Set property (magic method)</p>


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


                <h4>Throws</h4>
                <div class="list">
                    OutOfRangeException<br>If you set to undefined property<br>
                    InvalidArgumentException<br>If differed from the defined type<br>
                    RangeException<br>If differed from the defined length
                </div>

                <h4>See</h4>
                <div class="list">
                        http://php.net/manual/language.oop5.magic.php<br>
                </div>


        </div>
        </div></td>
    </tr>
    <tr data-order="__get" id="___get">

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

            mixed
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#___get">#</a>
        <code><a href="source-class-Teto.Object.TypedProperty.html#54-68" title="Go to source code">__get</a>( <span>string <var>$name</var></span> )</code>

        <div class="description short">
            <p>Get property (magic method)</p>
        </div>

        <div class="description detailed hidden">
            <p>Get property (magic method)</p>


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

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


                <h4>See</h4>
                <div class="list">
                        http://php.net/manual/language.oop5.magic.php<br>
                </div>


        </div>
        </div></td>
    </tr>
    <tr data-order="__isset" id="___isset">

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

            boolean
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#___isset">#</a>
        <code><a href="source-class-Teto.Object.TypedProperty.html#70-78" title="Go to source code">__isset</a>( <span>string <var>$name</var></span> )</code>

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

        <div class="description detailed hidden">
            


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

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


                <h4>See</h4>
                <div class="list">
                        http://php.net/manual/language.oop5.magic.php<br>
                </div>


        </div>
        </div></td>
    </tr>
    <tr data-order="__unset" id="___unset">

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

            
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#___unset">#</a>
        <code><a href="source-class-Teto.Object.TypedProperty.html#80-89" title="Go to source code">__unset</a>( <span>string <var>$name</var></span> )</code>

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

        <div class="description detailed hidden">
            


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



                <h4>See</h4>
                <div class="list">
                        http://php.net/manual/language.oop5.magic.php<br>
                </div>


        </div>
        </div></td>
    </tr>
    </table>


    <table class="summary used">
    <caption>Methods used from <a href="class-Teto.Object.TypeAssert.html#methods">Teto\Object\TypeAssert</a></caption>
    <tr>
        <td><code>
            <a href="class-Teto.Object.TypeAssert.html#_assertArrayOrObject">assertArrayOrObject()</a>, 
            <a href="class-Teto.Object.TypeAssert.html#_assertInstanceOf">assertInstanceOf()</a>, 
            <a href="class-Teto.Object.TypeAssert.html#_assertInt">assertInt()</a>, 
            <a href="class-Teto.Object.TypeAssert.html#_assertString">assertString()</a>, 
            <a href="class-Teto.Object.TypeAssert.html#_assertValue">assertValue()</a>
        </code></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>