Issues in GoogleAnalyticsDataCollectCommand.php - All Issues - Inspection of "[MediaBundle] Code improvement found by static cod..." - Kunstmaan/KunstmaanBundlesCMS - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( aba493...5356ed )

by Ruud

created 2019-06-11 15:20 UTC

Command/GoogleAnalyticsDataCollectCommand.php (1 issue)

Labels

Duplication 1

Severity

Informational 1

Peter Zentjens 1

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

namespace Kunstmaan\DashboardBundle\Command;

use Kunstmaan\DashboardBundle\Command\Helper\Analytics\ChartDataCommandHelper;
use Kunstmaan\DashboardBundle\Command\Helper\Analytics\GoalCommandHelper;
use Kunstmaan\DashboardBundle\Command\Helper\Analytics\MetricsCommandHelper;
use Kunstmaan\DashboardBundle\Command\Helper\Analytics\UsersCommandHelper;
use Kunstmaan\DashboardBundle\Entity\AnalyticsOverview;
use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;
use Doctrine\ORM\EntityManagerInterface;
use Kunstmaan\DashboardBundle\Helper\Google\Analytics\ServiceHelper;

/**
 * @final since 5.1
 * NEXT_MAJOR extend from `Command` and remove `$this->getContainer` usages
 */
class GoogleAnalyticsDataCollectCommand extends ContainerAwareCommand
{
    /** @var EntityManagerInterface $em */
    private $em;

    /** @var OutputInterface $output */
    private $output;

    /** @var int $errors */
    private $errors = 0;

    /** @var ServiceHelper */
    private $serviceHelper;

    /**
     * @param EntityManagerInterface|null $em
     * @param ServiceHelper               $serviceHelper
     */
    public function __construct(/* EntityManagerInterface */ $em = null, ServiceHelper $serviceHelper = null)

    {
        parent::__construct();

        if (!$em instanceof EntityManagerInterface) {
            @trigger_error(sprintf('Passing a command name as the first argument of "%s" is deprecated since version symfony 3.4 and will be removed in symfony 4.0. If the command was registered by convention, make it a service instead. ', __METHOD__), E_USER_DEPRECATED);

            $this->setName(null === $em ? 'kuma:dashboard:widget:googleanalytics:data:collect' : $em);

            return;
        }

        $this->em = $em;
        $this->serviceHelper = $serviceHelper;
    }

    /**
     * Configures the current command.
     */
    protected function configure()
    {
        $this
            ->setName('kuma:dashboard:widget:googleanalytics:data:collect')
            ->setDescription('Collect the Google Analytics dashboard widget data')
            ->addOption(
                'config',
                null,
                InputOption::VALUE_OPTIONAL,
                'Specify to only update one config',
                false
            )
            ->addOption(
                'segment',
                null,
                InputOption::VALUE_OPTIONAL,
                'Specify to only update one segment',
                false
            )
            ->addOption(
                'overview',
                null,
                InputOption::VALUE_OPTIONAL,
                'Specify to only update one overview',
                false
            );
    }

    /**
     * @param InputInterface  $input
     * @param OutputInterface $output
     *
     * @return int|null|void
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        if (null === $this->em) {
            $this->em = $this->getContainer()->get('doctrine.orm.entity_manager');
        }

        if (null === $this->serviceHelper) {
            $this->serviceHelper = $this->getContainer()->get('kunstmaan_dashboard.helper.google.analytics.service');
        }

        $this->output = $output;

        // check if token is set
        $configHelper = $this->getContainer()->get('kunstmaan_dashboard.helper.google.analytics.config');
        if (!$configHelper->tokenIsSet()) {
            $this->output->writeln('You haven\'t configured a Google account yet');

            return;
        }

        // get params
        $configId = false;
        $segmentId = false;
        $overviewId = false;

        try {
            $configId = $input->getOption('config');
            $segmentId = $input->getOption('segment');
            $overviewId = $input->getOption('overview');
        } catch (\Exception $e) {
        }

        // get the overviews
        try {
            $overviews = [];

            if ($overviewId) {
                $overviews[] = $this->getSingleOverview($overviewId);
            } elseif ($segmentId) {
                $overviews = $this->getOverviewsOfSegment($segmentId);
            } elseif ($configId) {
                $overviews = $this->getOverviewsOfConfig($configId);
            } else {
                $overviews = $this->getAllOverviews();
            }

            // update the overviews
            $this->updateData($overviews);
            $result = '<fg=green>Google Analytics data updated with <fg=red>'.$this->errors.'</fg=red> error';
            $result .= $this->errors != 1 ? 's</fg=green>' : '</fg=green>';
            $this->output->writeln($result); // done
        } catch (\Exception $e) {
            $this->output->writeln($e->getMessage());
        }
    }

    /**
     * get a single overview
     *
     * @param int $overviewId
     *
     * @return AnalyticsOverview
     */
    private function getSingleOverview($overviewId)
    {
        // get specified overview
        $overviewRepository = $this->em->getRepository('KunstmaanDashboardBundle:AnalyticsOverview');
        $overview = $overviewRepository->find($overviewId);

        if (!$overview) {
            throw new \Exception('Unkown overview ID');
        }

        return $overview;
    }

    /**
     * get all overviews of a segment
     *
     * @param int $segmentId
     *
     * @return array
     */
    private function getOverviewsOfSegment($segmentId)
    {
        // get specified segment
        $segmentRepository = $this->em->getRepository('KunstmaanDashboardBundle:AnalyticsSegment');
        $segment = $segmentRepository->find($segmentId);

        if (!$segment) {
            throw new \Exception('Unkown segment ID');
        }

        // init the segment
        $segmentRepository->initSegment($segment);

        // get the overviews
        return $segment->getOverviews();
    }

    /**
     * get all overviews of a config
     *
     * @param int $configId
     *
     * @return array
     */
    private function getOverviewsOfConfig($configId)
    {
        $configRepository = $this->em->getRepository('KunstmaanDashboardBundle:AnalyticsConfig');
        $segmentRepository = $this->em->getRepository('KunstmaanDashboardBundle:AnalyticsSegment');
        $overviewRepository = $this->em->getRepository('KunstmaanDashboardBundle:AnalyticsOverview');
        // get specified config
        $config = $configRepository->find($configId);

        if (!$config) {
            throw new \Exception('Unkown config ID');
        }

        // create default overviews for this config if none exist yet
        if (!\count($config->getOverviews())) {
            $overviewRepository->addOverviews($config);
        }

        // init all the segments for this config
        $segments = $config->getSegments();
        foreach ($segments as $segment) {
            $segmentRepository->initSegment($segment);
        }

        // get the overviews
        return $config->getOverviews();
    }

    /**
     * get all overviews
     *
     * @return array
     */
    private function getAllOverviews()
    {
        $configRepository = $this->em->getRepository('KunstmaanDashboardBundle:AnalyticsConfig');
        $overviewRepository = $this->em->getRepository('KunstmaanDashboardBundle:AnalyticsOverview');
        $segmentRepository = $this->em->getRepository('KunstmaanDashboardBundle:AnalyticsSegment');
        $configs = $configRepository->findAll();

        foreach ($configs as $config) {
            // add overviews if none exist yet
            if (\count($config->getOverviews()) == 0) {
                $overviewRepository->addOverviews($config);
            }

            // init all the segments for this config
            $segments = $config->getSegments();
            foreach ($segments as $segment) {
                $segmentRepository->initSegment($segment);
            }
        }

        // get all overviews
        return $overviewRepository->findAll();
    }

    /**
     * update the overviews
     *
     * @param array $overviews collection of all overviews which need to be updated
     */
    public function updateData($overviews)
    {
        // helpers
        $queryHelper = $this->getContainer()->get('kunstmaan_dashboard.helper.google.analytics.query');
        $configHelper = $this->getContainer()->get('kunstmaan_dashboard.helper.google.analytics.config');
        $metrics = new MetricsCommandHelper($configHelper, $queryHelper, $this->output, $this->em);
        $chartData = new ChartDataCommandHelper($configHelper, $queryHelper, $this->output, $this->em);
        $goals = new GoalCommandHelper($configHelper, $queryHelper, $this->output, $this->em);
        $visitors = new UsersCommandHelper($configHelper, $queryHelper, $this->output, $this->em);

        // get data per overview
        foreach ($overviews as $overview) {
            $configHelper->init($overview->getConfig()->getId());
            /* @var AnalyticsOverview $overview */
            $this->output->writeln('Fetching data for overview "<fg=green>' . $overview->getTitle() . '</fg=green>"');

            try {
                // metric data
                $metrics->getData($overview);
                if ($overview->getSessions()) { // if there are any visits
                    // day-specific data
                    $chartData->getData($overview);

                    // get goals
                    $goals->getData($overview);

                    // visitor types
                    $visitors->getData($overview);
                } else {
                    // reset overview
                    $this->reset($overview);
                    $this->output->writeln("\t" . 'No visitors');
                }
                // persist entity back to DB
                $this->output->writeln("\t" . 'Persisting..');
                $this->em->persist($overview);
                $this->em->flush();

                $this->em->getRepository('KunstmaanDashboardBundle:AnalyticsConfig')->setUpdated($overview->getConfig()->getId());
            } catch (\Google_ServiceException $e) {
                $error = explode(')', $e->getMessage());
                $error = $error[1];
                $this->output->writeln("\t" . '<fg=red>Invalid segment: </fg=red>' .$error);
                ++$this->errors;
            }
        }
    }

    /**
     * Reset the data for the overview
     *
     * @param AnalyticsOverview $overview The overview
     */
    private function reset(AnalyticsOverview $overview)
    {
        // reset overview
        $overview->setNewUsers(0);
        $overview->setReturningUsers(0);
    }
}


1		<?php
2
3		namespace Kunstmaan\DashboardBundle\Command;
4
5		use Kunstmaan\DashboardBundle\Command\Helper\Analytics\ChartDataCommandHelper;
6		use Kunstmaan\DashboardBundle\Command\Helper\Analytics\GoalCommandHelper;
7		use Kunstmaan\DashboardBundle\Command\Helper\Analytics\MetricsCommandHelper;
8		use Kunstmaan\DashboardBundle\Command\Helper\Analytics\UsersCommandHelper;
9		use Kunstmaan\DashboardBundle\Entity\AnalyticsOverview;
10		use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand;
11		use Symfony\Component\Console\Input\InputInterface;
12		use Symfony\Component\Console\Input\InputOption;
13		use Symfony\Component\Console\Output\OutputInterface;
14		use Doctrine\ORM\EntityManagerInterface;
15		use Kunstmaan\DashboardBundle\Helper\Google\Analytics\ServiceHelper;
16
17		/**
18		* @final since 5.1
19		* NEXT_MAJOR extend from `Command` and remove `$this->getContainer` usages
20		*/
21		class GoogleAnalyticsDataCollectCommand extends ContainerAwareCommand
22		{
23		/** @var EntityManagerInterface $em */
24		private $em;
25
26		/** @var OutputInterface $output */
27		private $output;
28
29		/** @var int $errors */
30		private $errors = 0;
31
32		/** @var ServiceHelper */
33		private $serviceHelper;
34
35		/**
36		* @param EntityManagerInterface\|null $em
37		* @param ServiceHelper $serviceHelper
38		*/
39	View Code Duplication	public function __construct(/* EntityManagerInterface */ $em = null, ServiceHelper $serviceHelper = null)
		0 ignored issues – show Duplication introduced 2019-01-11 11:25 UTC by Report Bug Copy Issue Report Show Similar Issues like this This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
40		{
41		parent::__construct();
42
43		if (!$em instanceof EntityManagerInterface) {
44		@trigger_error(sprintf('Passing a command name as the first argument of "%s" is deprecated since version symfony 3.4 and will be removed in symfony 4.0. If the command was registered by convention, make it a service instead. ', __METHOD__), E_USER_DEPRECATED);
45
46		$this->setName(null === $em ? 'kuma:dashboard:widget:googleanalytics:data:collect' : $em);
47
48		return;
49		}
50
51		$this->em = $em;
52		$this->serviceHelper = $serviceHelper;
53		}
54
55		/**
56		* Configures the current command.
57		*/
58		protected function configure()
59		{
60		$this
61		->setName('kuma:dashboard:widget:googleanalytics:data:collect')
62		->setDescription('Collect the Google Analytics dashboard widget data')
63		->addOption(
64		'config',
65		null,
66		InputOption::VALUE_OPTIONAL,
67		'Specify to only update one config',
68		false
69		)
70		->addOption(
71		'segment',
72		null,
73		InputOption::VALUE_OPTIONAL,
74		'Specify to only update one segment',
75		false
76		)
77		->addOption(
78		'overview',
79		null,
80		InputOption::VALUE_OPTIONAL,
81		'Specify to only update one overview',
82		false
83		);
84		}
85
86		/**
87		* @param InputInterface $input
88		* @param OutputInterface $output
89		*
90		* @return int\|null\|void
91		*/
92		protected function execute(InputInterface $input, OutputInterface $output)
93		{
94		if (null === $this->em) {
95		$this->em = $this->getContainer()->get('doctrine.orm.entity_manager');
96		}
97
98		if (null === $this->serviceHelper) {
99		$this->serviceHelper = $this->getContainer()->get('kunstmaan_dashboard.helper.google.analytics.service');
100		}
101
102		$this->output = $output;
103
104		// check if token is set
105		$configHelper = $this->getContainer()->get('kunstmaan_dashboard.helper.google.analytics.config');
106		if (!$configHelper->tokenIsSet()) {
107		$this->output->writeln('You haven\'t configured a Google account yet');
108
109		return;
110		}
111
112		// get params
113		$configId = false;
114		$segmentId = false;
115		$overviewId = false;
116
117		try {
118		$configId = $input->getOption('config');
119		$segmentId = $input->getOption('segment');
120		$overviewId = $input->getOption('overview');
121		} catch (\Exception $e) {
122		}
123
124		// get the overviews
125		try {
126		$overviews = [];
127
128		if ($overviewId) {
129		$overviews[] = $this->getSingleOverview($overviewId);
130		} elseif ($segmentId) {
131		$overviews = $this->getOverviewsOfSegment($segmentId);
132		} elseif ($configId) {
133		$overviews = $this->getOverviewsOfConfig($configId);
134		} else {
135		$overviews = $this->getAllOverviews();
136		}
137
138		// update the overviews
139		$this->updateData($overviews);
140		$result = '<fg=green>Google Analytics data updated with <fg=red>'.$this->errors.'</fg=red> error';
141		$result .= $this->errors != 1 ? 's</fg=green>' : '</fg=green>';
142		$this->output->writeln($result); // done
143		} catch (\Exception $e) {
144		$this->output->writeln($e->getMessage());
145		}
146		}
147
148		/**
149		* get a single overview
150		*
151		* @param int $overviewId
152		*
153		* @return AnalyticsOverview
154		*/
155		private function getSingleOverview($overviewId)
156		{
157		// get specified overview
158		$overviewRepository = $this->em->getRepository('KunstmaanDashboardBundle:AnalyticsOverview');
159		$overview = $overviewRepository->find($overviewId);
160
161		if (!$overview) {
162		throw new \Exception('Unkown overview ID');
163		}
164
165		return $overview;
166		}
167
168		/**
169		* get all overviews of a segment
170		*
171		* @param int $segmentId
172		*
173		* @return array
174		*/
175	View Code Duplication	private function getOverviewsOfSegment($segmentId)
176		{
177		// get specified segment
178		$segmentRepository = $this->em->getRepository('KunstmaanDashboardBundle:AnalyticsSegment');
179		$segment = $segmentRepository->find($segmentId);
180
181		if (!$segment) {
182		throw new \Exception('Unkown segment ID');
183		}
184
185		// init the segment
186		$segmentRepository->initSegment($segment);
187
188		// get the overviews
189		return $segment->getOverviews();
190		}
191
192		/**
193		* get all overviews of a config
194		*
195		* @param int $configId
196		*
197		* @return array
198		*/
199		private function getOverviewsOfConfig($configId)
200		{
201		$configRepository = $this->em->getRepository('KunstmaanDashboardBundle:AnalyticsConfig');
202		$segmentRepository = $this->em->getRepository('KunstmaanDashboardBundle:AnalyticsSegment');
203		$overviewRepository = $this->em->getRepository('KunstmaanDashboardBundle:AnalyticsOverview');
204		// get specified config
205		$config = $configRepository->find($configId);
206
207		if (!$config) {
208		throw new \Exception('Unkown config ID');
209		}
210
211		// create default overviews for this config if none exist yet
212		if (!\count($config->getOverviews())) {
213		$overviewRepository->addOverviews($config);
214		}
215
216		// init all the segments for this config
217		$segments = $config->getSegments();
218		foreach ($segments as $segment) {
219		$segmentRepository->initSegment($segment);
220		}
221
222		// get the overviews
223		return $config->getOverviews();
224		}
225
226		/**
227		* get all overviews
228		*
229		* @return array
230		*/
231	View Code Duplication	private function getAllOverviews()
232		{
233		$configRepository = $this->em->getRepository('KunstmaanDashboardBundle:AnalyticsConfig');
234		$overviewRepository = $this->em->getRepository('KunstmaanDashboardBundle:AnalyticsOverview');
235		$segmentRepository = $this->em->getRepository('KunstmaanDashboardBundle:AnalyticsSegment');
236		$configs = $configRepository->findAll();
237
238		foreach ($configs as $config) {
239		// add overviews if none exist yet
240		if (\count($config->getOverviews()) == 0) {
241		$overviewRepository->addOverviews($config);
242		}
243
244		// init all the segments for this config
245		$segments = $config->getSegments();
246		foreach ($segments as $segment) {
247		$segmentRepository->initSegment($segment);
248		}
249		}
250
251		// get all overviews
252		return $overviewRepository->findAll();
253		}
254
255		/**
256		* update the overviews
257		*
258		* @param array $overviews collection of all overviews which need to be updated
259		*/
260		public function updateData($overviews)
261		{
262		// helpers
263		$queryHelper = $this->getContainer()->get('kunstmaan_dashboard.helper.google.analytics.query');
264		$configHelper = $this->getContainer()->get('kunstmaan_dashboard.helper.google.analytics.config');
265		$metrics = new MetricsCommandHelper($configHelper, $queryHelper, $this->output, $this->em);
266		$chartData = new ChartDataCommandHelper($configHelper, $queryHelper, $this->output, $this->em);
267		$goals = new GoalCommandHelper($configHelper, $queryHelper, $this->output, $this->em);
268		$visitors = new UsersCommandHelper($configHelper, $queryHelper, $this->output, $this->em);
269
270		// get data per overview
271		foreach ($overviews as $overview) {
272		$configHelper->init($overview->getConfig()->getId());
273		/* @var AnalyticsOverview $overview */
274		$this->output->writeln('Fetching data for overview "<fg=green>' . $overview->getTitle() . '</fg=green>"');
275
276		try {
277		// metric data
278		$metrics->getData($overview);
279		if ($overview->getSessions()) { // if there are any visits
280		// day-specific data
281		$chartData->getData($overview);
282
283		// get goals
284		$goals->getData($overview);
285
286		// visitor types
287		$visitors->getData($overview);
288		} else {
289		// reset overview
290		$this->reset($overview);
291		$this->output->writeln("\t" . 'No visitors');
292		}
293		// persist entity back to DB
294		$this->output->writeln("\t" . 'Persisting..');
295		$this->em->persist($overview);
296		$this->em->flush();
297
298		$this->em->getRepository('KunstmaanDashboardBundle:AnalyticsConfig')->setUpdated($overview->getConfig()->getId());
299		} catch (\Google_ServiceException $e) {
300		$error = explode(')', $e->getMessage());
301		$error = $error[1];
302		$this->output->writeln("\t" . '<fg=red>Invalid segment: </fg=red>' .$error);
303		++$this->errors;
304		}
305		}
306		}
307
308		/**
309		* Reset the data for the overview
310		*
311		* @param AnalyticsOverview $overview The overview
312		*/
313		private function reset(AnalyticsOverview $overview)
314		{
315		// reset overview
316		$overview->setNewUsers(0);
317		$overview->setReturningUsers(0);
318		}
319		}
320

Kunstmaan / KunstmaanBundlesCMS

Push — master ( aba493...5356ed )

Command/GoogleAnalyticsDataCollectCommand.php (1 issue)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Duplication Side-by-Side

Filter issues like