PluginTrait::getReports() - Code Metrics - Inspection of "Merge branch 'develop'" - dukt/facebook - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 5962e4...cbacc1 )

by Benjamin

created 2021-03-10 21:17 UTC

PluginTrait::getReports() A

↳ Parent: PluginTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	1
c	1
b	0
f	0
nc	1
nop	0
dl	0
loc	4
rs	10

<?php
/**
 * @link      https://dukt.net/facebook/
 * @copyright Copyright (c) 2021, Dukt
 * @license   https://github.com/dukt/facebook/blob/master/LICENSE.md
 */

namespace dukt\facebook\base;

use Craft;
use dukt\facebook\Plugin as Facebook;

/**
 * PluginTrait implements the common methods and properties for plugin classes.
 *
 * @property \dukt\facebook\services\Api            $api            The api service
 * @property \dukt\facebook\services\Cache          $cache          The cache service
 * @property \dukt\facebook\services\Oauth          $oauth          The oauth service
 * @property \dukt\facebook\services\Reports        $reports        The reports service
 *
 * @author Dukt <[email protected]>
 * @since  2.0
 */
trait PluginTrait
{
    /**
     * Returns the accounts service.
     *
     * @return \dukt\facebook\services\Accounts The accounts service
     */
    public function getAccounts()
    {
        /** @var Facebook $this */
        return $this->get('accounts');

    }

    /**
     * Returns the api service.
     *
     * @return \dukt\facebook\services\Api The api service
     */
    public function getApi()
    {
        /** @var Facebook $this */
        return $this->get('api');

    }

    /**
     * Returns the cache service.
     *
     * @return \dukt\facebook\services\Cache The cache service
     */
    public function getCache()
    {
        /** @var Facebook $this */
        return $this->get('cache');

    }

    /**
     * Returns the oauth service.
     *
     * @return \dukt\facebook\services\Oauth The oauth service
     */
    public function getOauth()
    {
        /** @var Facebook $this */
        return $this->get('oauth');

    }

    /**
     * Returns the reports service.
     *
     * @return \dukt\facebook\services\Reports The reports service
     */
    public function getReports()
    {
        /** @var Facebook $this */
        return $this->get('reports');

    }

    /**
     * Returns `true` if client ID, client secret and token are defined.
     *
     * @return bool
     */
    public function isConfigured()
    {
        $oauthClientId = $this->getClientId();
        $oauthClientSecret = $this->getClientSecret();

        if(!empty($oauthClientId) && !empty($oauthClientSecret))
        {
            $token = Facebook::$plugin->getOauth()->getToken();

            if($token)
            {
                return true;
            }
        }

        return false;
    }

    /**
     * Gets the OAuth client ID
     *
     * @param bool $parse
     * @return bool|mixed|string|null
     */
    public function getClientId(bool $parse = true)
    {
        $clientId = Facebook::$plugin->getSettings()->oauthClientId;

        if (!$clientId) {
            return null;
        }

        return $parse ? Craft::parseEnv($clientId) : $clientId;
    }

    /**
     * Gets the OAuth client secret
     *
     * @param bool $parse
     * @return bool|mixed|string|null
     */
    public function getClientSecret(bool $parse = true)
    {
        $clientSecret = Facebook::$plugin->getSettings()->oauthClientSecret;

        if (!$clientSecret) {
            return null;
        }

        return $parse ? Craft::parseEnv($clientSecret) : $clientSecret;
    }
}


1			<?php
2			/**
3			* @link https://dukt.net/facebook/
4			* @copyright Copyright (c) 2021, Dukt
5			* @license https://github.com/dukt/facebook/blob/master/LICENSE.md
6			*/
7
8			namespace dukt\facebook\base;
9
10			use Craft;
11			use dukt\facebook\Plugin as Facebook;
12
13			/**
14			* PluginTrait implements the common methods and properties for plugin classes.
15			*
16			* @property \dukt\facebook\services\Api $api The api service
17			* @property \dukt\facebook\services\Cache $cache The cache service
18			* @property \dukt\facebook\services\Oauth $oauth The oauth service
19			* @property \dukt\facebook\services\Reports $reports The reports service
20			*
21			* @author Dukt <[email protected]>
22			* @since 2.0
23			*/
24			trait PluginTrait
25			{
26			/**
27			* Returns the accounts service.
28			*
29			* @return \dukt\facebook\services\Accounts The accounts service
30			*/
31			public function getAccounts()
32			{
33			/** @var Facebook $this */
34			return $this->get('accounts');
			0 ignored issues – show Bug Best Practice introduced 2021-03-09 23:42 UTC by Report Bug Copy Issue Report The expression `return $this->get('accounts')` also could return the type `mixed` which is incompatible with the documented return type `dukt\facebook\services\Accounts`. Loading history...
35			}
36
37			/**
38			* Returns the api service.
39			*
40			* @return \dukt\facebook\services\Api The api service
41			*/
42			public function getApi()
43			{
44			/** @var Facebook $this */
45			return $this->get('api');
			0 ignored issues – show Bug Best Practice introduced 2018-05-24 18:18 UTC by Report Bug Copy Issue Report The expression `return $this->get('api')` also could return the type `mixed` which is incompatible with the documented return type `dukt\facebook\services\Api`. Loading history...
46			}
47
48			/**
49			* Returns the cache service.
50			*
51			* @return \dukt\facebook\services\Cache The cache service
52			*/
53			public function getCache()
54			{
55			/** @var Facebook $this */
56			return $this->get('cache');
			0 ignored issues – show Bug Best Practice introduced 2018-05-24 18:18 UTC by Report Bug Copy Issue Report The expression `return $this->get('cache')` also could return the type `mixed` which is incompatible with the documented return type `dukt\facebook\services\Cache`. Loading history...
57			}
58
59			/**
60			* Returns the oauth service.
61			*
62			* @return \dukt\facebook\services\Oauth The oauth service
63			*/
64			public function getOauth()
65			{
66			/** @var Facebook $this */
67			return $this->get('oauth');
			0 ignored issues – show Bug Best Practice introduced 2018-05-24 18:18 UTC by Report Bug Copy Issue Report The expression `return $this->get('oauth')` also could return the type `mixed` which is incompatible with the documented return type `dukt\facebook\services\Oauth`. Loading history...
68			}
69
70			/**
71			* Returns the reports service.
72			*
73			* @return \dukt\facebook\services\Reports The reports service
74			*/
75			public function getReports()
76			{
77			/** @var Facebook $this */
78			return $this->get('reports');
			0 ignored issues – show Bug Best Practice introduced 2018-05-24 18:18 UTC by Report Bug Copy Issue Report The expression `return $this->get('reports')` also could return the type `mixed` which is incompatible with the documented return type `dukt\facebook\services\Reports`. Loading history...
79			}
80
81			/**
82			* Returns `true` if client ID, client secret and token are defined.
83			*
84			* @return bool
85			*/
86			public function isConfigured()
87			{
88			$oauthClientId = $this->getClientId();
89			$oauthClientSecret = $this->getClientSecret();
90
91			if(!empty($oauthClientId) && !empty($oauthClientSecret))
92			{
93			$token = Facebook::$plugin->getOauth()->getToken();
94
95			if($token)
96			{
97			return true;
98			}
99			}
100
101			return false;
102			}
103
104			/**
105			* Gets the OAuth client ID
106			*
107			* @param bool $parse
108			* @return bool\|mixed\|string\|null
109			*/
110			public function getClientId(bool $parse = true)
111			{
112			$clientId = Facebook::$plugin->getSettings()->oauthClientId;
113
114			if (!$clientId) {
115			return null;
116			}
117
118			return $parse ? Craft::parseEnv($clientId) : $clientId;
119			}
120
121			/**
122			* Gets the OAuth client secret
123			*
124			* @param bool $parse
125			* @return bool\|mixed\|string\|null
126			*/
127			public function getClientSecret(bool $parse = true)
128			{
129			$clientSecret = Facebook::$plugin->getSettings()->oauthClientSecret;
130
131			if (!$clientSecret) {
132			return null;
133			}
134
135			return $parse ? Craft::parseEnv($clientSecret) : $clientSecret;
136			}
137			}
138

dukt / facebook

Push — master ( 5962e4...cbacc1 )

PluginTrait::getReports() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like