Report::get() - Code Metrics - Inspection of "API core changes" - gplcart/ga_report - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 8f8265...347a3f )

by Iurii

created 2017-12-14 06:32 UTC

Report::get() B

↳ Parent: Report

Complexity

Conditions	7
Paths	6

Size

Total Lines	52
Code Lines	31

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	52
rs	7.2396
cc	7
eloc	31
nc	6
nop	2

How to fix Long Method

<?php

/**
 * @package Google Analytics Report
 * @author Iurii Makukh <[email protected]>
 * @copyright Copyright (c) 2015, Iurii Makukh
 * @license https://www.gnu.org/licenses/gpl.html GNU/GPLv3
 */

namespace gplcart\modules\ga_report\models;

use gplcart\core\Cache,
    gplcart\core\Hook;
use gplcart\core\models\Oauth as OauthModel,
    gplcart\core\models\Translation as TranslationModel;
use gplcart\core\exceptions\OauthAuthorization as OauthAuthorizationException;

/**
 * Manages basic behaviors and data related to Google Analytics Report
 */
class Report
{

    /**
     * Hook class instance
     * @var \gplcart\core\Hook $hook
     */
    protected $hook;

    /**
     * Translation UI model instance
     * @var \gplcart\core\models\Translation $translation
     */
    protected $translation;

    /**
     * Oauth model instance
     * @var \gplcart\core\models\Oauth $oauth
     */
    protected $oauth;

    /**
     * Cache class instance
     * @var \gplcart\core\Cache $cache
     */
    protected $cache;

    /**
     * @param Hook $hook
     * @param Cache $cache
     * @param OauthModel $oauth
     * @param TranslationModel $translation
     */
    public function __construct(Hook $hook, Cache $cache, OauthModel $oauth, TranslationModel $translation)
    {
        $this->hook = $hook;
        $this->cache = $cache;
        $this->oauth = $oauth;
        $this->translation = $translation;
    }

    /**
     * Returns reporting data
     * @param string $handler_id
     * @param string|array $data
     * @return array
     */
    public function get($handler_id, $data)
    {
        $data += array(
            'cache' => 0,
            'store_id' => 1,
            'query' => array()
        );

        $handler = $this->getHandler($handler_id);

        if (empty($handler)) {
            return array('error' => $this->translation->text('Invalid Oauth provider'));
        }

        $cache_key = "ga_report.$handler_id.{$data['store_id']}";

        $provider = $this->oauth->getProvider('ga');
        $report = array('handler' => $handler, 'provider' => $provider);
        $cache = $this->cache->get($cache_key, array('lifespan' => $data['cache']));

        if (!empty($data['cache']) && isset($cache)) {
            return $report + array(
                'data' => $cache,
                'updated' => $this->cache->getFileMtime()
            );
        }

        try {
            $token = $this->oauth->exchangeTokenServer($provider, $provider['settings']);
        } catch (OauthAuthorizationException $ex) {

            return $report + array('error' => $ex->getMessage());
        }

        if (empty($token['access_token'])) {
            return $report + array('error' => $this->translation->text('Failed to get access token'));
        }

        $data['query']['access_token'] = $token['access_token'];
        $results = $this->oauth->process($provider, array_merge($handler['query'], $data['query']));

        if (isset($results['error']['message'])) {
            return $report + array('error' => $results['error']['message']);
        }

        $report += array(
            'data' => $results,
            'updated' => GC_TIME
        );

        $this->cache->set($cache_key, $results);
        return $report;
    }

    /**
     * Clear cached report data
     * @param string|null $handler_id
     * @param integer|string|null $store_id
     */
    public function clearCache($handler_id = null, $store_id = null)
    {
        $pattern = 'ga_report.';

        if (isset($handler_id)) {
            $pattern .= "$handler_id.";
        }

        if (isset($store_id)) {
            $pattern .= "$store_id";
        }

        $this->cache->clear('', array('pattern' => "$pattern*"));
    }

    /**
     * Returns a handler data
     * @param string $handler_id
     * @return array
     */
    public function getHandler($handler_id)
    {
        $handlers = $this->getHandlers();
        return empty($handlers[$handler_id]) ? array() : $handlers[$handler_id];
    }

    /**
     * Returns an array of handlers
     * @return array
     */
    public function getHandlers()
    {
        $handlers = &gplcart_static(__METHOD__);

        if (isset($handlers)) {
            return $handlers;
        }

        $handlers = $this->getDefaultHandlers();

        $default = array(
            'end-date' => date('Y-m-d'),
            'start-date' => date('Y-m-d', strtotime('-1 month'))
        );

        foreach ($handlers as $id => &$handler) {
            $handler += array('template' => "ga_report|panels/$id");
            $handler['query'] += $default;
            $handler['id'] = $id;
        }

        $this->hook->attach('module.ga.report.handlers', $handlers);
        return $handlers;
    }

    /**
     * Returns an array of default handlers
     * @return array
     */
    protected function getDefaultHandlers()
    {
        $handlers = gplcart_config_get(__DIR__ . '/../config/handlers.php');
        foreach ($handlers as &$handler) {
            $handler['name'] = $this->translation->text($handler['name']);
        }

        return $handlers;
    }

}


1			<?php
2
3			/**
4			* @package Google Analytics Report
5			* @author Iurii Makukh <[email protected]>
6			* @copyright Copyright (c) 2015, Iurii Makukh
7			* @license https://www.gnu.org/licenses/gpl.html GNU/GPLv3
8			*/
9
10			namespace gplcart\modules\ga_report\models;
11
12			use gplcart\core\Cache,
13			gplcart\core\Hook;
14			use gplcart\core\models\Oauth as OauthModel,
15			gplcart\core\models\Translation as TranslationModel;
16			use gplcart\core\exceptions\OauthAuthorization as OauthAuthorizationException;
17
18			/**
19			* Manages basic behaviors and data related to Google Analytics Report
20			*/
21			class Report
22			{
23
24			/**
25			* Hook class instance
26			* @var \gplcart\core\Hook $hook
27			*/
28			protected $hook;
29
30			/**
31			* Translation UI model instance
32			* @var \gplcart\core\models\Translation $translation
33			*/
34			protected $translation;
35
36			/**
37			* Oauth model instance
38			* @var \gplcart\core\models\Oauth $oauth
39			*/
40			protected $oauth;
41
42			/**
43			* Cache class instance
44			* @var \gplcart\core\Cache $cache
45			*/
46			protected $cache;
47
48			/**
49			* @param Hook $hook
50			* @param Cache $cache
51			* @param OauthModel $oauth
52			* @param TranslationModel $translation
53			*/
54			public function __construct(Hook $hook, Cache $cache, OauthModel $oauth, TranslationModel $translation)
55			{
56			$this->hook = $hook;
57			$this->cache = $cache;
58			$this->oauth = $oauth;
59			$this->translation = $translation;
60			}
61
62			/**
63			* Returns reporting data
64			* @param string $handler_id
65			* @param string\|array $data
66			* @return array
67			*/
68			public function get($handler_id, $data)
69			{
70			$data += array(
71			'cache' => 0,
72			'store_id' => 1,
73			'query' => array()
74			);
75
76			$handler = $this->getHandler($handler_id);
77
78			if (empty($handler)) {
79			return array('error' => $this->translation->text('Invalid Oauth provider'));
80			}
81
82			$cache_key = "ga_report.$handler_id.{$data['store_id']}";
83
84			$provider = $this->oauth->getProvider('ga');
85			$report = array('handler' => $handler, 'provider' => $provider);
86			$cache = $this->cache->get($cache_key, array('lifespan' => $data['cache']));
87
88			if (!empty($data['cache']) && isset($cache)) {
89			return $report + array(
90			'data' => $cache,
91			'updated' => $this->cache->getFileMtime()
92			);
93			}
94
95			try {
96			$token = $this->oauth->exchangeTokenServer($provider, $provider['settings']);
97			} catch (OauthAuthorizationException $ex) {
			0 ignored issues – show Bug introduced 2017-08-04 18:52 UTC by Report Bug Copy Issue Report The class `gplcart\core\exceptions\OauthAuthorization` does not exist. Did you forget a USE statement, or did you not list all dependencies? Scrutinizer analyzes your `composer.json`/`composer.lock` file if available to determine the classes, and functions that are defined by your dependencies. It seems like the listed class was neither found in your dependencies, nor was it found in the analyzed files in your repository. If you are using some other form of dependency management, you might want to disable this analysis. Loading history...
98			return $report + array('error' => $ex->getMessage());
99			}
100
101			if (empty($token['access_token'])) {
102			return $report + array('error' => $this->translation->text('Failed to get access token'));
103			}
104
105			$data['query']['access_token'] = $token['access_token'];
106			$results = $this->oauth->process($provider, array_merge($handler['query'], $data['query']));
107
108			if (isset($results['error']['message'])) {
109			return $report + array('error' => $results['error']['message']);
110			}
111
112			$report += array(
113			'data' => $results,
114			'updated' => GC_TIME
115			);
116
117			$this->cache->set($cache_key, $results);
118			return $report;
119			}
120
121			/**
122			* Clear cached report data
123			* @param string\|null $handler_id
124			* @param integer\|string\|null $store_id
125			*/
126			public function clearCache($handler_id = null, $store_id = null)
127			{
128			$pattern = 'ga_report.';
129
130			if (isset($handler_id)) {
131			$pattern .= "$handler_id.";
132			}
133
134			if (isset($store_id)) {
135			$pattern .= "$store_id";
136			}
137
138			$this->cache->clear('', array('pattern' => "$pattern*"));
139			}
140
141			/**
142			* Returns a handler data
143			* @param string $handler_id
144			* @return array
145			*/
146			public function getHandler($handler_id)
147			{
148			$handlers = $this->getHandlers();
149			return empty($handlers[$handler_id]) ? array() : $handlers[$handler_id];
150			}
151
152			/**
153			* Returns an array of handlers
154			* @return array
155			*/
156			public function getHandlers()
157			{
158			$handlers = &gplcart_static(__METHOD__);
159
160			if (isset($handlers)) {
161			return $handlers;
162			}
163
164			$handlers = $this->getDefaultHandlers();
165
166			$default = array(
167			'end-date' => date('Y-m-d'),
168			'start-date' => date('Y-m-d', strtotime('-1 month'))
169			);
170
171			foreach ($handlers as $id => &$handler) {
172			$handler += array('template' => "ga_report\|panels/$id");
173			$handler['query'] += $default;
174			$handler['id'] = $id;
175			}
176
177			$this->hook->attach('module.ga.report.handlers', $handlers);
178			return $handlers;
179			}
180
181			/**
182			* Returns an array of default handlers
183			* @return array
184			*/
185			protected function getDefaultHandlers()
186			{
187			$handlers = gplcart_config_get(__DIR__ . '/../config/handlers.php');
188			foreach ($handlers as &$handler) {
189			$handler['name'] = $this->translation->text($handler['name']);
190			}
191
192			return $handlers;
193			}
194
195			}
196

gplcart / ga_report

Push — master ( 8f8265...347a3f )

Report::get() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like