allejo\Socrata\SodaClient

Complexity

Total Complexity

10

Size/Duplication

Total Lines	216
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	9	1
A	enableAssociativeArrays()	0	4	1
A	disableAssociativeArrays()	0	4	1
A	associativeArrayEnabled()	0	4	1
A	getDomain()	0	4	1
A	getEmail()	0	4	1
A	getToken()	0	4	1
A	getPassword()	0	4	1
A	getOAuth2Token()	0	4	1
A	setOAuth2Token()	0	4	1

<?php

/**
 * This file contains the SodaClient class
 *
 * @copyright 2015 Vladimir Jimenez
 * @license   https://github.com/allejo/PhpSoda/blob/master/LICENSE.md MIT
 */

namespace allejo\Socrata;

/**
 * An object provided to handle tokens, authentication, and configuration for interacting with the the Socrata API.
 *
 * @package allejo\Socrata
 * @since   0.1.0
 */
class SodaClient
{
    /**
     * The URL or domain of where the data set will be received from
     *
     * @var string
     */
    private $domain;

    /**
     * The AppToken used to read private data and to allow the application to work with less throttling
     *
     * @var string
     */
    private $token;

    /**
     * The user email for the account that will be adding, deleting, or modifying data
     *
     * @var string
     */
    private $email;

    /**
     * The password for said account
     *
     * @var string
     */
    private $password;

    /**
     * The OAuth 2.0 Access Token to be used with requests
     *
     * @var string
     */
    private $oAuth2Token;

    /**
     * Whether or not to return the decoded JSON as an associative array. When set to false, it will return stdClass
     * objects
     *
     * @var bool
     */
    private $associativeArray;

    /**
     * Create a client object to connect to the Socrata API
     *
     * @param string $url      The URL or domain of the Socrata data set
     * @param string $token    The AppToken used to access this information
     * @param string $email    Username for authentication
     * @param string $password Password for authentication
     *
     * @since 0.1.0
     */
    public function __construct ($url, $token = "", $email = "", $password = "")
    {
        $this->domain           = rtrim(preg_replace('/http(s)?:\/\//', "", $url), '/');
        $this->token            = $token;
        $this->email            = $email;
        $this->password         = $password;
        $this->oAuth2Token      = "";
        $this->associativeArray = true;
    }

    /**
     * When fetching a data set, the returned data will be in an array of associative arrays.
     *
     * ```
     * Array
     * (
     *     [foo] => Test data
     *     [bar] => Array
     *     (
     *         [baaz] => Testing
     *         [fooz] => Array
     *         (
     *             [baz] => Testing again
     *         )
     *
     *     )
     *     [foox] => Just test
     * )
     * ```
     *
     * When returned in this format, all of the children elements are array elements and are accessed as such.
     *
     * ```php
     *     $myVariable = $results['bar']['baz']; // Testing
     * ```
     *
     * @since 0.1.0
     */
    public function enableAssociativeArrays ()
    {
        $this->associativeArray = true;
    }

    /**
     * When fetching a data set, the returned data will be in an array of stdClass objects. When AssociativeArrays is
     * disabled, the returned data will in the follow format:
     *
     * ```
     * stdClass Object
     * (
     *     [foo] => Test data
     *     [bar] => stdClass Object
     *     (
     *         [baz] => Testing
     *         [foz] => stdClass Object
     *         (
     *             [baz] => Testing again
     *         )
     *     )
     *     [fox] => Just test
     * )
     * ```
     *
     * When returned in this format, all of the children elements are objects and are accessed as such.
     *
     * ```php
     *     $myVariable = $results->bar->baz; // Testing
     * ```
     *
     * @since 0.1.0
     */
    public function disableAssociativeArrays ()
    {
        $this->associativeArray = false;
    }

    /**
     * Get whether or not the returned data should be associative arrays or as stdClass objects
     *
     * @since 0.1.0
     *
     * @return bool True if the data is returned as associative arrays
     */
    public function associativeArrayEnabled ()
    {
        return $this->associativeArray;
    }

    /**
     * Get the domain of the API endpoint. This function will **always** return just the domain without the protocol
     * in order to let this library use the appropriate protocol
     *
     * @since 0.1.0
     *
     * @return string The domain of the API endpoint
     */
    public function getDomain ()
    {
        return $this->domain;
    }

    /**
     * Get the email of the account that will be used for authenticated actions
     *
     * @since 0.1.0
     *
     * @return string The user's email address. Returns an empty string if not set.
     */
    public function getEmail ()
    {
        return $this->email;
    }

    /**
     * Get the app token used by the library to bypass throttling and appear as a registered application
     *
     * @since 0.1.0
     *
     * @return string The app token used. Returns an empty string if not set.
     */
    public function getToken ()
    {
        return $this->token;
    }

    /**
     * Get the password of the account that will be used for authenticated actions
     *
     * @since 0.1.0
     *
     * @return string The password used. Returns an empty string if not set.
     */
    public function getPassword ()
    {
        return $this->password;
    }

    /**
     * Get the access token being used for OAuth 2.0
     *
     * @return string The access token being used
     *
     * @since 0.1.1
     */
    public function getOAuth2Token ()
    {
        return $this->oAuth2Token;
    }

    /**
     * Set the OAuth 2.0 access token
     *
     * @param string $token The access token to be used in queries
     *
     * @since 0.1.1
     */
    public function setOAuth2Token ($token)
    {
        $this->oAuth2Token = $token;
    }
}