Overview

Namespaces

  • Baguette
    • Mastodon
      • Config
      • Entity
      • Grant
      • Service
  • GuzzleHttp
    • Cookie
    • Exception
    • Handler
    • Promise
  • Psr
    • Http
      • Message
  • Teto
    • Object

Classes

  • Baguette\Mastodon\Client
  • Baguette\Mastodon\Config\DotEnvStorage
  • Baguette\Mastodon\Entity\Account
  • Baguette\Mastodon\Entity\Application
  • Baguette\Mastodon\Entity\Attachment
  • Baguette\Mastodon\Entity\Card
  • Baguette\Mastodon\Entity\Context
  • Baguette\Mastodon\Entity\Entity
  • Baguette\Mastodon\Entity\Error_
  • Baguette\Mastodon\Entity\Instance
  • Baguette\Mastodon\Entity\Mention
  • Baguette\Mastodon\Entity\Notification
  • Baguette\Mastodon\Entity\Status
  • Baguette\Mastodon\Entity\Tag
  • Baguette\Mastodon\EntityCaster
  • Baguette\Mastodon\Grant\CodeGrant
  • Baguette\Mastodon\Grant\Grant
  • Baguette\Mastodon\Grant\NoopGrant
  • Baguette\Mastodon\Grant\PasswordCredential
  • Baguette\Mastodon\Mastodon
  • Baguette\Mastodon\Requester
  • Baguette\Mastodon\Service\AuthFactory
  • Baguette\Mastodon\Service\Authorization
  • Baguette\Mastodon\Service\Scope
  • Baguette\Mastodon\Service\SessionStorage
  • Baguette\Mastodon\Service\Toot

Interfaces

  • Baguette\Mastodon\Config\Storage

Exceptions

  • Baguette\Mastodon\Service\AuthorizationException

Constants

  • Baguette\Mastodon\Entity\DATETIME_FORMAT

Functions

  • Baguette\Mastodon\authorization
  • Baguette\Mastodon\credential
  • Baguette\Mastodon\Entity\map
  • Baguette\Mastodon\Entity\mapValues
  • Baguette\Mastodon\Entity\toArrayValue
  • Baguette\Mastodon\grant
  • Baguette\Mastodon\http
  • Baguette\Mastodon\request
  • Baguette\Mastodon\scope
  • Baguette\Mastodon\session
  • Baguette\Mastodon\toot
  • Overview
  • Namespace
  • Class
  1:   2:   3:   4:   5:   6:   7:   8:   9:  10:  11:  12:  13:  14:  15:  16:  17:  18:  19:  20:  21:  22:  23:  24:  25:  26:  27:  28:  29:  30:  31:  32:  33:  34:  35:  36:  37:  38:  39:  40:  41:  42:  43:  44:  45:  46:  47:  48:  49:  50:  51:  52:  53:  54:  55:  56:  57:  58:  59:  60:  61:  62:  63:  64:  65:  66:  67:  68:  69:  70:  71:  72:  73:  74:  75:  76:  77:  78:  79:  80:  81:  82:  83:  84:  85:  86:  87:  88:  89:  90:  91:  92:  93:  94:  95:  96:  97:  98:  99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 
<?php

namespace Baguette\Mastodon;

use Baguette\Mastodon\Client;
use Baguette\Mastodon\Entity;
use Baguette\Mastodon\Service\SessionStorage;
use Baguette\Mastodon\Service\Toot;
use Psr\Http\Message\ResponseInterface;
use Respect\Validation\Validator as v;

/**
 * Mastodon Anthorization object factory
 *
 * @see https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md
 * @author    USAMI Kenta <tadsan@zonu.me>
 * @copyright 2017 Baguette HQ
 * @license   https://www.gnu.org/licenses/gpl-3.0.html GPL-3.0
 */
class Requester
{
    //
    // Account API
    //

    /**
     * Fetching an account
     *
     * @see https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md#fetching-an-account
     * @param  Client         $client
     * @param  SessionStorage $session
     * @param  int            $id
     * @return Entity\Account
     */
    public static function getAccount(Client $client, SessionStorage $session, $id)
    {
        v::intVal()->min(0)->assert($id);

        return static::map(
            Entity\Account::class,
            $client->requestAPI('GET', sprintf('/api/v1/accounts/%d', $id), [], $session)
        );
    }

    /**
     * Getting the current user
     *
     * @see https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md#getting-the-current-user
     * @param  Client         $client
     * @param  SessionStorage $session
     * @return Entity\Account
     */
    public static function getAccountCurrentUser(Client $client, SessionStorage $session)
    {
        return static::map(
            Entity\Account::class,
            $client->requestAPI('GET', '/api/v1/accounts/verify_credentials', [], $session)
        );
    }

    /**
     * Updating the current user
     *
     * @see https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md#updating-the-current-user
     * @param  Client         $client
     * @param  SessionStorage $session
     * @param  array          $update_data
     * @return Entity\Account
     */
    public static function updateAccount(Client $client, SessionStorage $session, $update_data)
    {
        $form_params = [];

        if (isset($update_data['display_name'])) {
            v::stringType()->assert($update_data['display_name']);
            $form_params['display_name'] = (string)$update_data['display_name'];
        }

        if (isset($update_data['note'])) {
            v::stringType()->assert($update_data['note']);
            $form_params['note'] = (string)$update_data['note'];
        }

        return static::map(
            Entity\Account::class,
            $client->requestAPI('PATCH', '/api/v1/accounts/update_credentials', [
                'form_params' => $form_params
            ], $session)
        );
    }

    /**
     * Getting an account's followers
     *
     * @see https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md#updating-the-current-user
     * @param  Client         $client
     * @param  SessionStorage $session
     * @param  int            $account_id
     * @return Entity\Account[]
     */
    public static function getAccountFollowers(Client $client, SessionStorage $session, $account_id)
    {
        v::intVal()->assert($account_id);

        $query = [];

        return static::map(
            [Entity\Account::class],
            $client->requestAPI('GET', sprintf('/api/v1/accounts/%d/followers', $account_id), [
                'query' => $query
            ], $session)
        );
    }

    /**
     * Fetching a user's blocks
     *
     * @see https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md#updating-the-current-user
     * @param  Client         $client
     * @param  SessionStorage $session
     * @param  array          $options
     * @return Entity\Account[]
     */
    public static function getBlocks(Client $client, SessionStorage $session, $options = [])
    {
        $query = [];

        if (isset($options['max_id'])) {
            v::intVal()->min(0)->assert($options['max_id']);
            $query['max_id'] = $options['max_id'];
        }

        if (isset($options['since_id'])) {
            v::intVal()->min(0)->assert($options['since_id']);
            $query['since_id'] = $options['since_id'];
        }

        if (isset($options['limit'])) {
            v::intVal()->min(0)->assert($options['limit']);
            $query['limit'] = $options['limit'];
        }

        return static::map(
            [Entity\Account::class],
            $client->requestAPI('GET', '/api/v1/blocks', [
                'query' => $query,
            ], $session)
        );
    }

    /**
     * Fetching a user's favourites
     *
     * @see https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md#updating-the-current-user
     * @param  Client         $client
     * @param  SessionStorage $session
     * @param  array          $options
     * @return Entity\Status[]
     */
    public static function getFavourites(Client $client, SessionStorage $session, $options = [])
    {
        $query = [];

        if (isset($options['max_id'])) {
            v::intVal()->min(0)->assert($options['max_id']);
            $query['max_id'] = $options['max_id'];
        }

        if (isset($options['since_id'])) {
            v::intVal()->min(0)->assert($options['since_id']);
            $query['since_id'] = $options['since_id'];
        }

        if (isset($options['limit'])) {
            v::intVal()->min(0)->assert($options['limit']);
            $query['limit'] = $options['limit'];
        }

        return static::map(
            [Entity\Status::class],
            $client->requestAPI('GET', '/api/v1/favourites', [
                'query' => $query,
            ], $session)
        );
    }

    /**
     * Fetching a list of follow requests
     *
     * @see https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md#fetching-a-list-of-follow-requests
     * @param  Client         $client
     * @param  SessionStorage $session
     * @param  array          $options
     * @return Entity\Accounts[]
     */
    public static function getFollowRequests(Client $client, SessionStorage $session, $options = [])
    {
        $query = [];

        if (isset($options['max_id'])) {
            v::intVal()->min(0)->assert($options['max_id']);
            $query['max_id'] = $options['max_id'];
        }

        if (isset($options['since_id'])) {
            v::intVal()->min(0)->assert($options['since_id']);
            $query['since_id'] = $options['since_id'];
        }

        if (isset($options['limit'])) {
            v::intVal()->min(0)->assert($options['limit']);
            $query['limit'] = $options['limit'];
        }

        return static::map(
            [Entity\Account::class],
            $client->requestAPI('GET', '/api/v1/follow_requests', [
                'query' => $query,
            ], $session)
        );
    }

    //
    // Status API
    //

    /**
     * Posting a new status
     *
     * @see https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md#posting-a-new-status
     * @param Toot $toot
     * @return Entity\Account
     */
    public static function postStatus(Client $client, SessionStorage $session, Toot $toot)
    {
        $form_params = [
            'status' => $toot->toot_string,
        ];

        if ($toot->sensitive) {
            $form_params['sensitive'] = 'true';
        }

        if ($toot->in_reply_to_id) {
            $form_params['in_reply_to_id'] = $toot->in_reply_to_id;
        }

        if (count($toot->media_ids) > 0) {
            $form_params['media_ids'] = $toot->media_ids;
        }

        if ($toot->visibility === null) {
            $form_params['visibility'] = $toot->visibility;
        }

        return static::map(
            Entity\Status::class,
            $client->requestAPI('POST', '/api/v1/statuses', [
                'form_params' => $form_params
            ], $session)
        );
    }

    //
    // Timelines API
    //

    

    //
    // Utility method
    //

    /**
     * Getting an account's followers
     *
     * @see https://github.com/tootsuite/documentation/blob/master/Using-the-API/API.md#updating-the-current-user
     * @param  Client         $client
     * @param  SessionStorage $session
     * @param  int            $status_id
     * @return Entity\Account[]
     */
    public static function getStatus(Client $client, SessionStorage $session, $status_id)
    {
        v::intVal()->assert($status_id);

        return static::map(
            Entity\Status::class,
            $client->requestAPI('GET', sprintf('/api/v1/statuses/%d', $status_id), [], $session)
        );
    }

    /**
     * @param  string|string[]   $class
     * @param  ResponseInterface $response
     * @return Entity\Entity|Entity\Entity[]
     */
    private static function map($class, ResponseInterface $response)
    {
        return Entity\map(
            $class,
            \GuzzleHttp\json_decode($response->getBody(), true)
        );
    }
}
ξ ^ω^)ξ Baguette PHP Mastodon API Client / SDK API documentation generated by ApiGen