BaguettePHP/mastodon-api

View on GitHub
docs/class-Baguette.Mastodon.Service.Authorization.html

Summary

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

    <title>Class Baguette\Mastodon\Service\Authorization | ξ ^ω^)ξ 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 class="active">
                    <a href="namespace-Baguette.html">
                        Baguette<span></span>
                    </a>

                        <ul>
                <li class="active">
                    <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="active 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>
                    <a href="namespace-Teto.html">
                        Teto<span></span>
                    </a>

                        <ul>
                <li>
                    <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-Baguette.Mastodon.Service.AuthFactory.html">AuthFactory</a></li>
                <li class="active"><a href="class-Baguette.Mastodon.Service.Authorization.html">Authorization</a></li>
                <li><a href="class-Baguette.Mastodon.Service.Scope.html">Scope</a></li>
                <li><a href="class-Baguette.Mastodon.Service.SessionStorage.html">SessionStorage</a></li>
                <li><a href="class-Baguette.Mastodon.Service.Toot.html">Toot</a></li>
            </ul>



            <h3>Exceptions</h3>
            <ul>
                <li><a href="class-Baguette.Mastodon.Service.AuthorizationException.html">AuthorizationException</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-Baguette.Mastodon.Service.html" title="Summary of Baguette\Mastodon\Service"><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 Authorization</h1>


    <div class="description">
    <p>Mastodon Anthorization object</p>
    </div>

    <dl class="tree">
        <dd style="padding-left:0px">
<b><span>Baguette\Mastodon\Service\Authorization</span></b>            
            
             uses 
                    <a href="class-Teto.Object.PrivateGetter.html"><span>Teto\Object\PrivateGetter</span></a>
            
        </dd>
    </dl>








    <div class="info">
        
        
        <b>Namespace:</b> <a href="namespace-Baguette.html">Baguette</a>\<a href="namespace-Baguette.Mastodon.html">Mastodon</a>\<a href="namespace-Baguette.Mastodon.Service.html">Service</a><br>
        

                <b>Copyright:</b>
                2017 Baguette HQ<br>
                <b>License:</b>
                <a href="https://www.gnu.org/licenses/gpl-3.0.html">GPL-3.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-Baguette.Mastodon.Service.Authorization.html#5-62" title="Go to source code">Service/Authorization.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-Baguette.Mastodon.Service.Authorization.html#29-47" title="Go to source code">__construct</a>( <span>string <var>$access_token</var></span>, <span>string <var>$token_type</var> = <span class="php-quote">'bearer'</span></span>, <span><code><a href="class-Baguette.Mastodon.Service.Scope.html">Baguette\Mastodon\Service\Scope</a></code> <var>$scope</var> = <span class="php-keyword1">null</span></span>, <span>integer <var>$created_at</var> = <span class="php-keyword1">null</span> </span> )</code>

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

        <div class="description detailed hidden">
            


                <h4>Parameters</h4>
                <div class="list"><dl>
                    <dt><var>$access_token</var></dt>
                    <dd></dd>
                    <dt><var>$token_type</var></dt>
                    <dd></dd>
                    <dt><var>$scope</var></dt>
                    <dd></dd>
                    <dt><var>$created_at</var></dt>
                    <dd></dd>
                </dl></div>





        </div>
        </div></td>
    </tr>
    <tr data-order="fromObject" id="_fromObject">

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

            static
            
            </code>
        </td>

        <td class="name"><div>
        <a class="anchor" href="#_fromObject">#</a>
        <code><a href="source-class-Baguette.Mastodon.Service.Authorization.html#49-61" title="Go to source code">fromObject</a>( <span>object <var>$obj</var></span> )</code>

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

        <div class="description detailed hidden">
            


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

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




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


    <table class="summary used">
    <caption>Methods used from <a href="class-Teto.Object.PrivateGetter.html#methods">Teto\Object\PrivateGetter</a></caption>
    <tr>
        <td><code>
            <a href="class-Teto.Object.PrivateGetter.html#___get">__get()</a>, 
            <a href="class-Teto.Object.PrivateGetter.html#___isset">__isset()</a>
        </code></td>
    </tr>
    </table>













    <table class="summary properties" id="magicProperties">
    <caption>Magic properties summary</caption>
    <tr data-order="access_token" id="m$access_token">
        <td class="attributes"><code>
            public  read-only
            string
        </code></td>

        <td class="name">
                <a href="source-class-Baguette.Mastodon.Service.Authorization.html#11" title="Go to source code"><var>$access_token</var></a>

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

            <div class="description detailed hidden">
                

            </div>
        </td>
    </tr>
    <tr data-order="token_type" id="m$token_type">
        <td class="attributes"><code>
            public  read-only
            string
        </code></td>

        <td class="name">
                <a href="source-class-Baguette.Mastodon.Service.Authorization.html#12" title="Go to source code"><var>$token_type</var></a>

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

            <div class="description detailed hidden">
                

            </div>
        </td>
    </tr>
    <tr data-order="scope" id="m$scope">
        <td class="attributes"><code>
            public  read-only
            <code><a href="class-Baguette.Mastodon.Service.Scope.html">Baguette\Mastodon\Service\Scope</a></code>
        </code></td>

        <td class="name">
                <a href="source-class-Baguette.Mastodon.Service.Authorization.html#13" title="Go to source code"><var>$scope</var></a>

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

            <div class="description detailed hidden">
                

            </div>
        </td>
    </tr>
    <tr data-order="created_at" id="m$created_at">
        <td class="attributes"><code>
            public  read-only
            DateTimeImmutable
        </code></td>

        <td class="name">
                <a href="source-class-Baguette.Mastodon.Service.Authorization.html#14" title="Go to source code"><var>$created_at</var></a>

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

            <div class="description detailed hidden">
                

            </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>