TwitterService

Complexity

Total Complexity

15

Size/Duplication

Total Lines	177
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getClient()	0	21	3
A	getOAuthCallback()	0	13	2
A	getOAuthToken()	0	20	2
A	getAuthoriseUrl()	0	11	2
A	setSessionOAuthToken()	0	10	2
A	getSessionOAuthToken()	0	3	1
A	clearSessionOAuthToken()	0	4	1
A	getAccessToken()	0	14	2

<?php

use Abraham\TwitterOAuth\TwitterOAuth;
use Abraham\TwitterOAuth\TwitterOAuthException;

class TwitterService

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{
    /**
     * @config
     *
     * @var string
     */
    private static $consumer_key;

The property $consumer_key is not used and could be removed.

    /**
     * @config
     *
     * @var string
     */
    private static $consumer_secret;

The property $consumer_secret is not used and could be removed.

    /**
     * @config
     *
     * @var string
     */
    private static $oauth_callback;

The property $oauth_callback is not used and could be removed.

    /**
     * Create a Twitter API interface.
     *
     * @param string $token
     *
     * @param string $secret
     *
     * @return Abraham\TwitterOAuth\TwitterOAuth
     */
    public function getClient($token = null, $secret = null)
    {
        $consumer_key = Config::inst()->get('TwitterService', 'consumer_key');
        $consumer_secret = Config::inst()->get('TwitterService', 'consumer_secret');

        if (!$consumer_key) {
            user_error(
                'Add a consumer_key to config (TwitterService::consumer_key)',
                E_USER_ERROR
            );
        }

        if (!$consumer_secret) {
            user_error(
                'Add a consumer_secret to config (TwitterService::consumer_secret)',
                E_USER_ERROR
            );
        }

        return new TwitterOAuth($consumer_key, $consumer_secret, $token, $secret);
    }

    /**
     * Gets the OAuth callback URL.
     *
     * @return string
     */
    public function getOAuthCallback()
    {
        $oauth_callback = Config::inst()->get('TwitterService', 'oauth_callback');

        if (!$oauth_callback) {
            user_error(
                'Add a oauth_callback to config (TwitterService::oauth_callback)',
                E_USER_ERROR
            );
        }

        return Director::absoluteBaseURL() . $oauth_callback;
    }

    /**
     * Gets a temporary request token to kick off the OAuth flow.
     *
     * @return array
     */
    public function getOAuthToken()
    {
        $requestToken = [
            'oauth_token' => '',
            'oauth_token_secret' => '',
        ];

        $client = $this->getClient();

        try {
            $response = $client->oauth('oauth/request_token', ['oauth_callback' => $this->getOAuthCallback()]);

            $requestToken['oauth_token'] = $response['oauth_token'];
            $requestToken['oauth_token_secret'] = $response['oauth_token_secret'];
        } catch (TwitterOAuthException $e) {
            user_error($e->getMessage(), E_USER_WARNING);
        }

        return $requestToken;
    }

    /**
     * Gets the login URL for users to authenticate with.
     *
     * @param array $token
     *
     * @return string
     */
    public function getAuthoriseUrl($token)
    {
        $authoriseUrl = '';
        $client = $this->getClient();

        if (array_key_exists('oauth_token', $token)) {
            $authoriseUrl = $client->url('oauth/authorize', ['oauth_token' => $token['oauth_token']]);
        }

        return $authoriseUrl;
    }

    /**
     * Sets the temporary request token in session.
     *
     * @param array $token
     */
    public function setSessionOAuthToken($token)
    {
        $sessionRequestToken = Session::get('TwitterOAuthToken');
        $sessionRequestToken = $sessionRequestToken ? $sessionRequestToken : [];

        $sessionRequestToken['oauth_token'] = $token['oauth_token'];
        $sessionRequestToken['oauth_token_secret'] = $token['oauth_token_secret'];

        Session::set('TwitterOAuthToken', $sessionRequestToken);

$sessionRequestToken is of type array<string,?,{"oauth_token_secret":"?"}>, but the function expects a string.

    }

    /**
     * Gets the temporary request token from session.
     *
     * @return array
     */
    public function getSessionOAuthToken() {
        return Session::get('TwitterOAuthToken');
    }

    /**
     * Clears the temporary token from session.
     */
    public function clearSessionOAuthToken()
    {
        Session::clear('TwitterOAuthToken');
    }

    /**
     * Gets an access token used for making authenticated requests to the Twitter API.
     *
     * @param string $token
     *
     * @param string $secret
     *
     * @param string $verifier
     *
     * @return array|null
     */
    public function getAccessToken($token, $secret, $verifier)
    {
        $accessToken = null;

        $client = $this->getClient($token, $secret);

        try {
            $accessToken = $client->oauth('oauth/access_token', ['oauth_verifier' => $verifier]);
        } catch (TwitterOAuthException $e) {
            user_error($e->getMessage(), E_USER_WARNING);
        }

        return $accessToken;
    }
}