Overview

Namespaces

  • JohnRivs
    • Wunderlist

Classes

  • JohnRivs\Wunderlist\Wunderlist

Traits

  • JohnRivs\Wunderlist\Authorization
  • JohnRivs\Wunderlist\Avatar
  • JohnRivs\Wunderlist\Comment
  • JohnRivs\Wunderlist\File
  • JohnRivs\Wunderlist\Folder
  • JohnRivs\Wunderlist\Lists
  • JohnRivs\Wunderlist\Note
  • JohnRivs\Wunderlist\Reminder
  • JohnRivs\Wunderlist\Subtask
  • JohnRivs\Wunderlist\Task
  • JohnRivs\Wunderlist\User
  • JohnRivs\Wunderlist\Webhook
  • 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: 
<?php namespace JohnRivs\Wunderlist;

use Exception;
use GuzzleHttp\json_decode;
use GuzzleHttp\Client as HttpClient;

class Wunderlist {

    use Authorization,
        Avatar,
        File,
        Folder,
        Lists,
        Note,
        Reminder,
        Subtask,
        Task,
        Comment,
        User,
        Webhook;

    /**
     * Base URL for the Wunderlist API.
     *
     * @var string
     */
    protected $baseUrl = 'http://a.wunderlist.com/api/v1/';

    /**
     * HTTP status code returned by each request.
     *
     * @var int
     */
    protected $statusCode;

    /**
     * HTTP Client.
     *
     * @var \Guzzlehttp\Client
     */
    protected $http;

    /**
     * The Wunderlist app client id.
     *
     * @var string
     */
    public $clientId;

    /**
     * The Wunderlist app client secret.
     *
     * @var string
     */
    public $clientSecret;

    /**
     * The Wunderlist app access token.
     *
     * @var string
     */
    protected $accessToken;

    /**
     * Whether or not the package should throw exceptions
     * when parameters are missing.
     *
     * @var bool
     */
    protected $useExceptions;

    public function __construct($clientId, $clientSecret, $accessToken, $useExceptions = true)
    {
        $this->clientSecret  = $clientSecret;
        $this->accessToken   = $accessToken;
        $this->useExceptions = $useExceptions;

        $this->http = $this->getHttpClient();
    }

    /**
     * Master call. It makes the requests to the Wunderlist API endpoints.
     *
     * @param  string $httpMethod
     * @param  string $endpoint
     * @param  array  $parameters
     * @return array
     */
    public function call($httpMethod, $endpoint, array $parameters = [])
    {
        // Every request to the Wunderlist API
        // must provide the app client id
        // and access token.
        $parameters = array_merge($parameters, [
            'headers' => $this->getHeaders(),
        ]);

        // We send the request
        // passing any parameter (if any).
        $response = $this->http->request($httpMethod, $this->baseUrl . $endpoint, $parameters);

        // We store the returned HTTP status code
        // in case it's needed.
        $this->statusCode = $response->getStatusCode();

        // Finally, we return the contents of the response.
        return json_decode($response->getBody(), true);
    }

    /**
     * Get the HTTP status code from the last response.
     *
     * @return int
     */
    public function getStatusCode()
    {
        if (empty($this->statusCode)) throw new Exception('An HTTP status code has not been set. Make sure you ask for this AFTER you make a request to the API.');

        return (int) $this->statusCode;
    }

    /**
     * Get a fresh instance of the Guzzle HTTP client.
     *
     * @return \GuzzleHttp\Client
     */
    protected function getHttpClient()
    {
        return new HttpClient;
    }

    /**
     * The headers needed for (almost) every request
     * to the Wunderlist API.
     *
     * @return array
     */
    protected function getHeaders()
    {
        return [
            'X-Client-ID'    => $this->clientId,
            'X-Access-Token' => $this->accessToken,
            'Content-Type'   => 'application/json'
        ];
    }

    /**
     * Checks if the provided attributes contain certain fields.
     *
     * @param  array  $requirements A list of required attributes.
     * @param  array  $attributes   The provided attributes
     * @param  bool   $exception    Call exception or return boolean.
     * @return \Exception|bool
     */
    protected function requires(array $requirements, array $attributes)
    {
        foreach ($requirements as $required) {
            if ( ! array_key_exists($required, $attributes) && $this->useExceptions) {
                throw new Exception("The '{$required}' attribute is required.");
            }
        }
    }
}
API documentation generated by ApiGen