PluginTrait::getInfo() - Code Metrics - Inspection of "Merge branch 'release/4.0.0'" - dukt/analytics - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 758032...380927 )

by Benjamin

created 2018-05-29 16:11 UTC

PluginTrait::getInfo() A

↳ Parent: PluginTrait

Complexity

Conditions	4
Paths	4

Size

Total Lines	21
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	11
nc	4
nop	0
dl	0
loc	21
rs	9.0534
c	0
b	0
f	0

<?php
/**
 * @link      https://dukt.net/craft/analytics/
 * @copyright Copyright (c) 2018, Dukt
 * @license   https://dukt.net/craft/analytics/docs/license
 */

namespace dukt\analytics\base;

use Craft;
use craft\db\Query;
use craft\helpers\Db;
use dukt\analytics\models\Info;
use dukt\analytics\Plugin as Analytics;

/**
 * PluginTrait implements the common methods and properties for plugin classes.
 *
 * @property \dukt\analytics\services\Analytics                 $analytics                  The analytics service
 * @property \dukt\analytics\services\Apis                      $apis                       The apis service
 * @property \dukt\analytics\services\Cache                     $cache                      The cache service
 * @property \dukt\analytics\services\Metadata                  $metadata                   The metadata service
 * @property \dukt\analytics\services\Oauth                     $oauth                      The oauth service
 * @property \dukt\analytics\services\Reports                   $reports                    The reports service
 * @property \dukt\analytics\services\Views                     $views                    The views service
 */
trait PluginTrait
{
    // Properties
    // =========================================================================

    /**
     * @var
     */
    private $_info;

    /**
     * @var
     */
    private $_isInstalled;

    // Public Methods
    // =========================================================================

    /**
     * Returns the analytics service.
     *
     * @return \dukt\analytics\services\Analytics The analytics service
     * @throws \yii\base\InvalidConfigException
     */
    public function getAnalytics()
    {
        /** @var Analytics $this */
        return $this->get('analytics');

    }

    /**
     * Returns the apis service.
     *
     * @return \dukt\analytics\services\Apis The apis service
     * @throws \yii\base\InvalidConfigException
     */
    public function getApis()
    {
        /** @var Analytics $this */
        return $this->get('apis');

    }

    /**
     * Returns the cache service.
     *
     * @return \dukt\analytics\services\Cache The cache service
     * @throws \yii\base\InvalidConfigException
     */
    public function getCache()
    {
        /** @var Analytics $this */
        return $this->get('cache');

    }

    /**
     * Returns the metadata service.
     *
     * @return \dukt\analytics\services\Metadata The metadata service
     * @throws \yii\base\InvalidConfigException
     */
    public function getMetadata()
    {
        /** @var Analytics $this */
        return $this->get('metadata');

    }

    /**
     * Returns the oauth service.
     *
     * @return \dukt\analytics\services\Oauth The oauth service
     * @throws \yii\base\InvalidConfigException
     */
    public function getOauth()
    {
        /** @var Analytics $this */
        return $this->get('oauth');

    }

    /**
     * Returns the reports service.
     *
     * @return \dukt\analytics\services\Reports The reports service
     * @throws \yii\base\InvalidConfigException
     */
    public function getReports()
    {
        /** @var Analytics $this */
        return $this->get('reports');

    }

    /**
     * Returns the views service.
     *
     * @return \dukt\analytics\services\Views The views service
     * @throws \yii\base\InvalidConfigException
     */
    public function getViews()
    {
        /** @var Analytics $this */
        return $this->get('views');

    }

    /**
     * Updates the info row.
     *
     * @param Info $info
     *
     * @return bool
     * @throws \yii\db\Exception
     */
    public function saveInfo(Info $info): bool
    {
        $attributes = Db::prepareValuesForDb($info);

        if (array_key_exists('id', $attributes) && $attributes['id'] === null) {
            unset($attributes['id']);
        }
        echo 'a';
        if ($this->getIsInstalled()) {
            echo 'b';

            Craft::$app->getDb()->createCommand()
                ->update('{{%analytics_info}}', $attributes)
                ->execute();
        } else {
            echo 'c';

            Craft::$app->getDb()->createCommand()
                ->insert('{{%analytics_info}}', $attributes)
                ->execute();

            if (Craft::$app->getIsInstalled()) {
                // Set the new id
                $info->id = Craft::$app->getDb()->getLastInsertID('{{%analytics_info}}');

            }
        }

        $this->_info = $info;

        return true;
    }

    /**
     * Returns the info model, or just a particular attribute.
     *
     * @return Info
     * @throws ServerErrorHttpException if the info table is missing its row
     */
    public function getInfo(): Info
    {
        /** @var WebApplication|ConsoleApplication $this */
        if ($this->_info !== null) {
            return $this->_info;
        }

        if (!$this->getIsInstalled()) {
            return new Info();
        }

        $row = (new Query())
            ->from(['{{%analytics_info}}'])
            ->one();

        if (!$row) {
            $tableName = $this->getDb()->getSchema()->getRawTableName('{{%analytics_info}}');
            throw new ServerErrorHttpException("The {$tableName} table is missing its row");
filter:
    dependency_paths: ["lib/*"]
        }

        return $this->_info = new Info($row);
    }

    /**
     * Returns whether Craft is installed.
     *
     * @return bool
     */
    public function getIsInstalled(): bool
    {
        /** @var WebApplication|ConsoleApplication $this */
        if ($this->_isInstalled !== null) {
            return $this->_isInstalled;
        }

        $infoRowExists = false;

        if(Craft::$app->getDb()->tableExists('{{%analytics_info}}', false)) {
            $infoRowExists = (new Query())
                ->from(['{{%analytics_info}}'])
                ->one();
        }

        return $this->_isInstalled = (
            Craft::$app->getIsDbConnectionValid() &&
            $infoRowExists
        );
    }
}


1			<?php
2			/**
3			* @link https://dukt.net/craft/analytics/
4			* @copyright Copyright (c) 2018, Dukt
5			* @license https://dukt.net/craft/analytics/docs/license
6			*/
7
8			namespace dukt\analytics\base;
9
10			use Craft;
11			use craft\db\Query;
12			use craft\helpers\Db;
13			use dukt\analytics\models\Info;
14			use dukt\analytics\Plugin as Analytics;
15
16			/**
17			* PluginTrait implements the common methods and properties for plugin classes.
18			*
19			* @property \dukt\analytics\services\Analytics $analytics The analytics service
20			* @property \dukt\analytics\services\Apis $apis The apis service
21			* @property \dukt\analytics\services\Cache $cache The cache service
22			* @property \dukt\analytics\services\Metadata $metadata The metadata service
23			* @property \dukt\analytics\services\Oauth $oauth The oauth service
24			* @property \dukt\analytics\services\Reports $reports The reports service
25			* @property \dukt\analytics\services\Views $views The views service
26			*/
27			trait PluginTrait
28			{
29			// Properties
30			// =========================================================================
31
32			/**
33			* @var
34			*/
35			private $_info;
36
37			/**
38			* @var
39			*/
40			private $_isInstalled;
41
42			// Public Methods
43			// =========================================================================
44
45			/**
46			* Returns the analytics service.
47			*
48			* @return \dukt\analytics\services\Analytics The analytics service
49			* @throws \yii\base\InvalidConfigException
50			*/
51			public function getAnalytics()
52			{
53			/** @var Analytics $this */
54			return $this->get('analytics');
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 UTC by Report Bug Copy Issue Report The expression `return $this->get('analytics')` also could return the type `mixed` which is incompatible with the documented return type `dukt\analytics\services\Analytics`. Loading history...
55			}
56
57			/**
58			* Returns the apis service.
59			*
60			* @return \dukt\analytics\services\Apis The apis service
61			* @throws \yii\base\InvalidConfigException
62			*/
63			public function getApis()
64			{
65			/** @var Analytics $this */
66			return $this->get('apis');
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 UTC by Report Bug Copy Issue Report The expression `return $this->get('apis')` also could return the type `mixed` which is incompatible with the documented return type `dukt\analytics\services\Apis`. Loading history...
67			}
68
69			/**
70			* Returns the cache service.
71			*
72			* @return \dukt\analytics\services\Cache The cache service
73			* @throws \yii\base\InvalidConfigException
74			*/
75			public function getCache()
76			{
77			/** @var Analytics $this */
78			return $this->get('cache');
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 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\analytics\services\Cache`. Loading history...
79			}
80
81			/**
82			* Returns the metadata service.
83			*
84			* @return \dukt\analytics\services\Metadata The metadata service
85			* @throws \yii\base\InvalidConfigException
86			*/
87			public function getMetadata()
88			{
89			/** @var Analytics $this */
90			return $this->get('metadata');
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 UTC by Report Bug Copy Issue Report The expression `return $this->get('metadata')` also could return the type `mixed` which is incompatible with the documented return type `dukt\analytics\services\Metadata`. Loading history...
91			}
92
93			/**
94			* Returns the oauth service.
95			*
96			* @return \dukt\analytics\services\Oauth The oauth service
97			* @throws \yii\base\InvalidConfigException
98			*/
99			public function getOauth()
100			{
101			/** @var Analytics $this */
102			return $this->get('oauth');
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 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\analytics\services\Oauth`. Loading history...
103			}
104
105			/**
106			* Returns the reports service.
107			*
108			* @return \dukt\analytics\services\Reports The reports service
109			* @throws \yii\base\InvalidConfigException
110			*/
111			public function getReports()
112			{
113			/** @var Analytics $this */
114			return $this->get('reports');
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 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\analytics\services\Reports`. Loading history...
115			}
116
117			/**
118			* Returns the views service.
119			*
120			* @return \dukt\analytics\services\Views The views service
121			* @throws \yii\base\InvalidConfigException
122			*/
123			public function getViews()
124			{
125			/** @var Analytics $this */
126			return $this->get('views');
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 UTC by Report Bug Copy Issue Report The expression `return $this->get('views')` also could return the type `mixed` which is incompatible with the documented return type `dukt\analytics\services\Views`. Loading history...
127			}
128
129			/**
130			* Updates the info row.
131			*
132			* @param Info $info
133			*
134			* @return bool
135			* @throws \yii\db\Exception
136			*/
137			public function saveInfo(Info $info): bool
138			{
139			$attributes = Db::prepareValuesForDb($info);
140
141			if (array_key_exists('id', $attributes) && $attributes['id'] === null) {
142			unset($attributes['id']);
143			}
144			echo 'a';
145			if ($this->getIsInstalled()) {
146			echo 'b';
147
148			Craft::$app->getDb()->createCommand()
149			->update('{{%analytics_info}}', $attributes)
150			->execute();
151			} else {
152			echo 'c';
153
154			Craft::$app->getDb()->createCommand()
155			->insert('{{%analytics_info}}', $attributes)
156			->execute();
157
158			if (Craft::$app->getIsInstalled()) {
159			// Set the new id
160			$info->id = Craft::$app->getDb()->getLastInsertID('{{%analytics_info}}');
			0 ignored issues – show Documentation Bug introduced 2018-05-29 16:03 UTC by Report Bug Copy Issue Report It seems like `Craft::app->getDb()->get...('{{%analytics_info}}')` of type `string` is incompatible with the declared type `null\|integer` of property `$id`. Our type inference engine has found an assignment to a property that is incompatible with the declared type of that property. Either this assignment is in error or the assigned type should be added to the documentation/type hint for that property.. Loading history...
161			}
162			}
163
164			$this->_info = $info;
165
166			return true;
167			}
168
169			/**
170			* Returns the info model, or just a particular attribute.
171			*
172			* @return Info
173			* @throws ServerErrorHttpException if the info table is missing its row
174			*/
175			public function getInfo(): Info
176			{
177			/** @var WebApplication\|ConsoleApplication $this */
178			if ($this->_info !== null) {
179			return $this->_info;
180			}
181
182			if (!$this->getIsInstalled()) {
183			return new Info();
184			}
185
186			$row = (new Query())
187			->from(['{{%analytics_info}}'])
188			->one();
189
190			if (!$row) {
191			$tableName = $this->getDb()->getSchema()->getRawTableName('{{%analytics_info}}');
192			throw new ServerErrorHttpException("The {$tableName} table is missing its row");
			0 ignored issues – show Bug introduced 2018-05-29 16:03 UTC by Report Bug Copy Issue Report The type `dukt\analytics\base\ServerErrorHttpException` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
193			}
194
195			return $this->_info = new Info($row);
196			}
197
198			/**
199			* Returns whether Craft is installed.
200			*
201			* @return bool
202			*/
203			public function getIsInstalled(): bool
204			{
205			/** @var WebApplication\|ConsoleApplication $this */
206			if ($this->_isInstalled !== null) {
207			return $this->_isInstalled;
208			}
209
210			$infoRowExists = false;
211
212			if(Craft::$app->getDb()->tableExists('{{%analytics_info}}', false)) {
213			$infoRowExists = (new Query())
214			->from(['{{%analytics_info}}'])
215			->one();
216			}
217
218			return $this->_isInstalled = (
219			Craft::$app->getIsDbConnectionValid() &&
220			$infoRowExists
221			);
222			}
223			}
224

dukt / analytics

Push — master ( 758032...380927 )

PluginTrait::getInfo() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like