TwitterAccount::isAuthorised() - Code Metrics - SomarDesignStudios/silverstripe-twitter - Measure and Improve Code Quality continuously with Scrutinizer

TwitterAccount::isAuthorised() A
last analyzed 2017-07-21 05:37 UTC

↳ Parent: TwitterAccount

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	2
cts	2
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	1

<?php

class TwitterAccount extends DataObject
namespace YourVendor;

class YourClass { }
{
    public static $dependencies = [
        'twitterService' => '%$TwitterService',
    ];

    /**
     * @var TwitterService
     */
    public $twitterService;

    /**
     * @var array
     */
    private static $db = [

        'Title' => 'Varchar',
        'AccessToken' => 'Text',
    ];

    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $fields = parent::getCMSFields();

        $fields->removeByName('AccessToken');

        if ($this->isAuthorised()) {
            $usernameField = LiteralField::create(
                'Title',
                '<p class="message good">' .
                    _t('Twitter.AccountAuthorisedMessage', 'This account has been authorised.') .
                '</p>' .
                '<div class="field">' .
                    '<label class="left">' .
                        _t('Twitter.FieldLabelTitle', 'Username') .
                    '</label>' .
                    '<div class="middleColumn" style="padding-top:8px;">' .
                        '<a ' .
                            "href='https://www.twitter.com/{$this->Title}' " .
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                            'title="View on Twitter" ' .
                            'target="_blank">' .
                            $this->Title .
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                        '</a>' .
                    '</div>' .
                '</div>'
            );
        } else {
            $usernameField = Textfield::create('Title', _t('Twitter.FieldLabelTitle', 'Username'));
            $usernameField->setDescription(
                _t(
                    'Twitter.FieldDescriptionTitle',
                    'The Twitter account you want to pull media from.'
                )
            );
        }

        $fields->addFieldToTab('Root.Main', $usernameField);

        $this->extend('updateCMSFields', $fields);

        return $fields;
    }

    /**
     * @return FieldList
     */
    public function getCMSActions()
    {
        $actions = parent::getCMSActions();

        if (!$this->getField('ID') || $this->isAuthorised()) {
            $this->extend('updateCMSActions', $actions);
            return $actions;
        }

        $token = $this->twitterService->getOAuthToken();

        // Set the token in session so it can be accessed throughout the OAuth flow.
        $this->twitterService->setSessionOAuthToken($token);

        $actions->push(
            LiteralField::create(
                'OAuthLink',
                '<a class="ss-ui-button" href="' . $this->twitterService->getAuthoriseUrl($token) . '">' .
                    _t('Twitter.ButtonLabelAuthoriseAccount', 'Authorise account') .
                '</a>'
            )
        );

        $this->extend('updateCMSActions', $actions);

        return $actions;
    }

    /**
     * @return RequiredFields
     */
    public function getCMSValidator()
    {
        return new RequiredFields('Title');
    }

    /**
     * Sets an OAuth token for the TwitterAccount.
     *
     * @param array $token
     */
    public function setAccessToken($token)
    {
        $this->setField('AccessToken', serialize($token));
    }

    /**
     * Gets the TwitterAccount's OAuth token.
     *
     * @return array
     */
    public function getAccessToken()
    {
        return unserialize($this->getField('AccessToken'));
    }

    /**
     * Checks if the TwitterAccount has been authorised via OAuth.
     *
     * @return boolean
     */
    public function isAuthorised()
    {
        return (bool) $this->getField('AccessToken');
    }
}


1		<?php
2
3		class TwitterAccount extends DataObject
		0 ignored issues – show Coding Style Compatibility introduced 2017-04-03 23:01 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
4		{
5		public static $dependencies = [
6		'twitterService' => '%$TwitterService',
7		];
8
9		/**
10		* @var TwitterService
11		*/
12		public $twitterService;
13
14		/**
15		* @var array
16		*/
17		private static $db = [
		0 ignored issues – show Comprehensibility introduced 2017-04-03 23:01 UTC by Report Bug Copy Issue Report Consider using a different property name as you override a private property of the parent class. Loading history... Unused Code introduced 2017-04-03 23:01 UTC by Report Bug Copy Issue Report The property `$db` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
18		'Title' => 'Varchar',
19		'AccessToken' => 'Text',
20		];
21
22		/**
23		* @return FieldList
24		*/
25		public function getCMSFields()
26		{
27		$fields = parent::getCMSFields();
28
29		$fields->removeByName('AccessToken');
30
31		if ($this->isAuthorised()) {
32		$usernameField = LiteralField::create(
33		'Title',
34		'<p class="message good">' .
35		_t('Twitter.AccountAuthorisedMessage', 'This account has been authorised.') .
36		'</p>' .
37		'<div class="field">' .
38		'<label class="left">' .
39		_t('Twitter.FieldLabelTitle', 'Username') .
40		'</label>' .
41		'<div class="middleColumn" style="padding-top:8px;">' .
42		'<a ' .
43		"href='https://www.twitter.com/{$this->Title}' " .
		0 ignored issues – show Documentation introduced 2017-04-03 23:01 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<TwitterAccount>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
44		'title="View on Twitter" ' .
45		'target="_blank">' .
46		$this->Title .
		0 ignored issues – show Documentation introduced 2017-04-03 23:01 UTC by Report Bug Copy Issue Report The property `Title` does not exist on `object<TwitterAccount>`. Since you implemented `__get`, maybe consider adding a @property annotation. Since your code implements the magic getter `_get`, this function will be called for any read access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } If the property has read access only, you can use the @property-read annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
47		'</a>' .
48		'</div>' .
49		'</div>'
50		);
51		} else {
52		$usernameField = Textfield::create('Title', _t('Twitter.FieldLabelTitle', 'Username'));
53		$usernameField->setDescription(
54		_t(
55		'Twitter.FieldDescriptionTitle',
56		'The Twitter account you want to pull media from.'
57		)
58		);
59		}
60
61		$fields->addFieldToTab('Root.Main', $usernameField);
62
63		$this->extend('updateCMSFields', $fields);
64
65		return $fields;
66		}
67
68		/**
69		* @return FieldList
70		*/
71		public function getCMSActions()
72		{
73		$actions = parent::getCMSActions();
74
75		if (!$this->getField('ID') \|\| $this->isAuthorised()) {
76		$this->extend('updateCMSActions', $actions);
77		return $actions;
78		}
79
80		$token = $this->twitterService->getOAuthToken();
81
82		// Set the token in session so it can be accessed throughout the OAuth flow.
83		$this->twitterService->setSessionOAuthToken($token);
84
85		$actions->push(
86		LiteralField::create(
87		'OAuthLink',
88		'<a class="ss-ui-button" href="' . $this->twitterService->getAuthoriseUrl($token) . '">' .
89		_t('Twitter.ButtonLabelAuthoriseAccount', 'Authorise account') .
90		'</a>'
91		)
92		);
93
94		$this->extend('updateCMSActions', $actions);
95
96		return $actions;
97		}
98
99		/**
100		* @return RequiredFields
101		*/
102		public function getCMSValidator()
103		{
104		return new RequiredFields('Title');
105		}
106
107		/**
108		* Sets an OAuth token for the TwitterAccount.
109		*
110		* @param array $token
111		*/
112	1	public function setAccessToken($token)
113		{
114	1	$this->setField('AccessToken', serialize($token));
115	1	}
116
117		/**
118		* Gets the TwitterAccount's OAuth token.
119		*
120		* @return array
121		*/
122	1	public function getAccessToken()
123		{
124	1	return unserialize($this->getField('AccessToken'));
125		}
126
127		/**
128		* Checks if the TwitterAccount has been authorised via OAuth.
129		*
130		* @return boolean
131		*/
132	1	public function isAuthorised()
133		{
134	1	return (bool) $this->getField('AccessToken');
135		}
136		}
137

SomarDesignStudios / silverstripe-twitter

TwitterAccount::isAuthorised() A last analyzed 2017-07-21 05:37 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

TwitterAccount::isAuthorised() A
last analyzed 2017-07-21 05:37 UTC