Views::getViews() - Code Metrics - dukt/analytics - Measure and Improve Code Quality continuously with Scrutinizer

Views::getViews() A
last analyzed 2022-02-02 16:13 UTC

↳ Parent: Views

Complexity

Conditions	2
Paths	2

Size

Total Lines	20
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	2
eloc	13
c	1
b	0
f	0
nc	2
nop	0
dl	0
loc	20
rs	9.8333

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

namespace dukt\analytics\services;

use Craft;
use dukt\analytics\errors\InvalidViewException;
use dukt\analytics\models\SiteView;
use dukt\analytics\models\View;
use dukt\analytics\records\View as ViewRecord;
use dukt\analytics\records\SiteView as SiteViewRecord;
use yii\base\Component;
use Exception;

class Views extends Component
{
    // Public Methods
    // =========================================================================

    /**
     * Get all views.
     *
     * @return array|null
     */
    public function getViews()
    {
        $results = ViewRecord::find()->all();

        $views = [];

        foreach ($results as $result) {
            $views[] = new View($result->toArray([
                'id',
                'name',
                'gaAccountId',
                'gaAccountName',
                'gaPropertyId',
                'gaPropertyName',
                'gaViewId',
                'gaViewName',
            ]));
        }

        return $views;
    }

    /**
     * Get view by ID.
     *
     * @param $id
     *
     * @return View|null
     */
    public function getViewById($id)
    {
        $result = ViewRecord::findOne($id);

        if ($result) {

            return new View($result->toArray([
                'id',
                'name',
                'gaAccountId',
                'gaAccountName',
                'gaPropertyId',
                'gaPropertyName',
                'gaViewCurrency',
                'gaViewId',
                'gaViewName',
            ]));
        }

        return null;
    }

    /**
     * Get site views.
     *
     * @return array
     */
    public function getSiteViews()
    {
        $results = SiteViewRecord::find()->all();

        $views = [];

        foreach ($results as $result) {
            $views[] = new SiteView($result->toArray([
                'siteId',
                'viewId',
            ]));
        }

        return $views;
    }

    /**
     * Get ite view by site ID.
     *
     * @param $id
     *
     * @return SiteView|null
     */
    public function getSiteViewBySiteId($id)
    {
        $result = SiteViewRecord::findOne([
            'siteId' => $id
        ]);

        if ($result) {

            return new SiteView($result->toArray([
                'id',
                'siteId',
                'viewId',
            ]));
        }

        return null;
    }

    /**
     * Saves a view.
     *
     * @param View $view          The view to be saved
     * @param bool $runValidation Whether the view should be validated
     *
     * @return bool
     * @throws InvalidViewException if $view->id is invalid
     * @throws Exception if reasons
     */
    public function saveView(View $view, bool $runValidation = true): bool
    {
        if ($runValidation && !$view->validate()) {
            Craft::info('View not saved due to validation error.', __METHOD__);

            return false;
        }

        if ($view->id) {
            $viewRecord = ViewRecord::find()
                ->where(['id' => $view->id])
                ->one();

            if (!$viewRecord) {
                throw new InvalidViewException("No view exists with the ID '{$view->id}'");
            }

            $isNewView = false;
        } else {
            $viewRecord = new ViewRecord();
            $isNewView = true;
        }

        // Shared attributes
        $viewRecord->name = $view->name;

        $viewRecord->gaAccountId = $view->gaAccountId;

        $viewRecord->gaAccountName = $view->gaAccountName;

        $viewRecord->gaPropertyId = $view->gaPropertyId;

        $viewRecord->gaPropertyName = $view->gaPropertyName;

        $viewRecord->gaViewId = $view->gaViewId;

        $viewRecord->gaViewName = $view->gaViewName;

        $viewRecord->gaViewCurrency = $view->gaViewCurrency;



        $transaction = Craft::$app->getDb()->beginTransaction();

        try {
            // Is the event giving us the go-ahead?
            $viewRecord->save(false);

            // Now that we have a view ID, save it on the model
            if ($isNewView) {
                $view->id = $viewRecord->id;

            }

            $transaction->commit();
        } catch (Exception $e) {
            $transaction->rollBack();

            throw $e;
        }

        return true;
    }

    /**
     * Delete a view by ID.
     *
     * @param int $viewId
     *
     * @return bool
     * @throws \Throwable
     * @throws \yii\db\StaleObjectException
     */
    public function deleteViewById(int $viewId): bool
    {
        $viewRecord = ViewRecord::findOne($viewId);

        if (!$viewRecord) {

            return true;
        }

        $viewRecord->delete();

        return true;
    }

    /**
     * Save a site view.
     *
     * @param SiteView $siteView
     * @param bool     $runValidation
     *
     * @return bool
     * @throws \yii\db\Exception
     */
    public function saveSiteView(SiteView $siteView, bool $runValidation = true): bool
    {
        if ($runValidation && !$siteView->validate()) {
            Craft::info('Site view not saved due to validation error.', __METHOD__);

            return false;
        }

        if ($siteView->siteId) {
            $siteViewRecord = SiteViewRecord::find()
                ->where(['siteId' => $siteView->siteId])
                ->one();

            if (!$siteViewRecord) {
                $siteViewRecord = new SiteViewRecord();
                $isNewSiteView = true;
            } else {
                $isNewSiteView = false;
            }
        } else {
            $siteViewRecord = new SiteViewRecord();
            $isNewSiteView = true;
        }

        // Shared attributes
        $siteViewRecord->siteId = $siteView->siteId;

        $siteViewRecord->viewId = $siteView->viewId;



        $transaction = Craft::$app->getDb()->beginTransaction();

        try {
            // Is the event giving us the go-ahead?
            $siteViewRecord->save(false);

            // Now that we have a view ID, save it on the model
            if ($isNewSiteView) {
                $siteView->id = $siteViewRecord->id;

            }

            $transaction->commit();
        } catch (Exception $e) {
            $transaction->rollBack();

            throw $e;
        }

        return true;
    }
}


1			<?php
2			/**
3			* @link https://dukt.net/analytics/
4			* @copyright Copyright (c) 2022, Dukt
5			* @license https://github.com/dukt/analytics/blob/master/LICENSE.md
6			*/
7
8			namespace dukt\analytics\services;
9
10			use Craft;
11			use dukt\analytics\errors\InvalidViewException;
12			use dukt\analytics\models\SiteView;
13			use dukt\analytics\models\View;
14			use dukt\analytics\records\View as ViewRecord;
15			use dukt\analytics\records\SiteView as SiteViewRecord;
16			use yii\base\Component;
17			use Exception;
18
19			class Views extends Component
20			{
21			// Public Methods
22			// =========================================================================
23
24			/**
25			* Get all views.
26			*
27			* @return array\|null
28			*/
29			public function getViews()
30			{
31			$results = ViewRecord::find()->all();
32
33			$views = [];
34
35			foreach ($results as $result) {
36			$views[] = new View($result->toArray([
37			'id',
38			'name',
39			'gaAccountId',
40			'gaAccountName',
41			'gaPropertyId',
42			'gaPropertyName',
43			'gaViewId',
44			'gaViewName',
45			]));
46			}
47
48			return $views;
49			}
50
51			/**
52			* Get view by ID.
53			*
54			* @param $id
55			*
56			* @return View\|null
57			*/
58			public function getViewById($id)
59			{
60			$result = ViewRecord::findOne($id);
61
62			if ($result) {
			0 ignored issues – show introduced 2018-10-26 09:34 UTC by Report Bug Copy Issue Report `$result` is of type `yii\db\ActiveRecord`, thus it always evaluated to `true`. Loading history...
63			return new View($result->toArray([
64			'id',
65			'name',
66			'gaAccountId',
67			'gaAccountName',
68			'gaPropertyId',
69			'gaPropertyName',
70			'gaViewCurrency',
71			'gaViewId',
72			'gaViewName',
73			]));
74			}
75
76			return null;
77			}
78
79			/**
80			* Get site views.
81			*
82			* @return array
83			*/
84			public function getSiteViews()
85			{
86			$results = SiteViewRecord::find()->all();
87
88			$views = [];
89
90			foreach ($results as $result) {
91			$views[] = new SiteView($result->toArray([
92			'siteId',
93			'viewId',
94			]));
95			}
96
97			return $views;
98			}
99
100			/**
101			* Get ite view by site ID.
102			*
103			* @param $id
104			*
105			* @return SiteView\|null
106			*/
107			public function getSiteViewBySiteId($id)
108			{
109			$result = SiteViewRecord::findOne([
110			'siteId' => $id
111			]);
112
113			if ($result) {
			0 ignored issues – show introduced 2018-10-26 09:34 UTC by Report Bug Copy Issue Report `$result` is of type `yii\db\ActiveRecord`, thus it always evaluated to `true`. Loading history...
114			return new SiteView($result->toArray([
115			'id',
116			'siteId',
117			'viewId',
118			]));
119			}
120
121			return null;
122			}
123
124			/**
125			* Saves a view.
126			*
127			* @param View $view The view to be saved
128			* @param bool $runValidation Whether the view should be validated
129			*
130			* @return bool
131			* @throws InvalidViewException if $view->id is invalid
132			* @throws Exception if reasons
133			*/
134			public function saveView(View $view, bool $runValidation = true): bool
135			{
136			if ($runValidation && !$view->validate()) {
137			Craft::info('View not saved due to validation error.', __METHOD__);
138
139			return false;
140			}
141
142			if ($view->id) {
143			$viewRecord = ViewRecord::find()
144			->where(['id' => $view->id])
145			->one();
146
147			if (!$viewRecord) {
148			throw new InvalidViewException("No view exists with the ID '{$view->id}'");
149			}
150
151			$isNewView = false;
152			} else {
153			$viewRecord = new ViewRecord();
154			$isNewView = true;
155			}
156
157			// Shared attributes
158			$viewRecord->name = $view->name;
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 UTC by Report Bug Copy Issue Report The property `name` does not exist. Although not strictly required by PHP, it is generally a best practice to declare properties explicitly. Loading history...
159			$viewRecord->gaAccountId = $view->gaAccountId;
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 UTC by Report Bug Copy Issue Report The property `gaAccountId` does not exist on `dukt\analytics\records\View`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
160			$viewRecord->gaAccountName = $view->gaAccountName;
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 UTC by Report Bug Copy Issue Report The property `gaAccountName` does not exist on `dukt\analytics\records\View`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
161			$viewRecord->gaPropertyId = $view->gaPropertyId;
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 UTC by Report Bug Copy Issue Report The property `gaPropertyId` does not exist on `dukt\analytics\records\View`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
162			$viewRecord->gaPropertyName = $view->gaPropertyName;
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 UTC by Report Bug Copy Issue Report The property `gaPropertyName` does not exist on `dukt\analytics\records\View`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
163			$viewRecord->gaViewId = $view->gaViewId;
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 UTC by Report Bug Copy Issue Report The property `gaViewId` does not exist on `dukt\analytics\records\View`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
164			$viewRecord->gaViewName = $view->gaViewName;
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 UTC by Report Bug Copy Issue Report The property `gaViewName` does not exist on `dukt\analytics\records\View`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
165			$viewRecord->gaViewCurrency = $view->gaViewCurrency;
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 UTC by Report Bug Copy Issue Report The property `gaViewCurrency` does not exist on `dukt\analytics\records\View`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
166
167
168			$transaction = Craft::$app->getDb()->beginTransaction();
169
170			try {
171			// Is the event giving us the go-ahead?
172			$viewRecord->save(false);
173
174			// Now that we have a view ID, save it on the model
175			if ($isNewView) {
176			$view->id = $viewRecord->id;
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 UTC by Report Bug Copy Issue Report The property `id` does not exist on `dukt\analytics\records\View`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
177			}
178
179			$transaction->commit();
180			} catch (Exception $e) {
181			$transaction->rollBack();
182
183			throw $e;
184			}
185
186			return true;
187			}
188
189			/**
190			* Delete a view by ID.
191			*
192			* @param int $viewId
193			*
194			* @return bool
195			* @throws \Throwable
196			* @throws \yii\db\StaleObjectException
197			*/
198			public function deleteViewById(int $viewId): bool
199			{
200			$viewRecord = ViewRecord::findOne($viewId);
201
202			if (!$viewRecord) {
			0 ignored issues – show introduced 2018-10-26 09:34 UTC by Report Bug Copy Issue Report `$viewRecord` is of type `yii\db\ActiveRecord`, thus it always evaluated to `true`. Loading history...
203			return true;
204			}
205
206			$viewRecord->delete();
207
208			return true;
209			}
210
211			/**
212			* Save a site view.
213			*
214			* @param SiteView $siteView
215			* @param bool $runValidation
216			*
217			* @return bool
218			* @throws \yii\db\Exception
219			*/
220			public function saveSiteView(SiteView $siteView, bool $runValidation = true): bool
221			{
222			if ($runValidation && !$siteView->validate()) {
223			Craft::info('Site view not saved due to validation error.', __METHOD__);
224
225			return false;
226			}
227
228			if ($siteView->siteId) {
229			$siteViewRecord = SiteViewRecord::find()
230			->where(['siteId' => $siteView->siteId])
231			->one();
232
233			if (!$siteViewRecord) {
234			$siteViewRecord = new SiteViewRecord();
235			$isNewSiteView = true;
236			} else {
237			$isNewSiteView = false;
238			}
239			} else {
240			$siteViewRecord = new SiteViewRecord();
241			$isNewSiteView = true;
242			}
243
244			// Shared attributes
245			$siteViewRecord->siteId = $siteView->siteId;
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 UTC by Report Bug Copy Issue Report The property `siteId` does not exist on `dukt\analytics\records\SiteView`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
246			$siteViewRecord->viewId = $siteView->viewId;
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 UTC by Report Bug Copy Issue Report The property `viewId` does not exist on `dukt\analytics\records\SiteView`. Since you implemented `__set`, consider adding a @property annotation. Loading history...
247
248
249			$transaction = Craft::$app->getDb()->beginTransaction();
250
251			try {
252			// Is the event giving us the go-ahead?
253			$siteViewRecord->save(false);
254
255			// Now that we have a view ID, save it on the model
256			if ($isNewSiteView) {
257			$siteView->id = $siteViewRecord->id;
			0 ignored issues – show Bug Best Practice introduced 2018-04-26 17:20 UTC by Report Bug Copy Issue Report The property `id` does not exist on `dukt\analytics\records\SiteView`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
258			}
259
260			$transaction->commit();
261			} catch (Exception $e) {
262			$transaction->rollBack();
263
264			throw $e;
265			}
266
267			return true;
268			}
269			}
270

dukt / analytics

Views::getViews() A last analyzed 2022-02-02 16:13 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Views::getViews() A
last analyzed 2022-02-02 16:13 UTC