Kunstmaan / KunstmaanBundlesCMS

src/Kunstmaan/DashboardBundle/Command/GoogleAnalyticsOverviewsListCommand.php

<?php

namespace Kunstmaan\DashboardBundle\Command;

use Kunstmaan\DashboardBundle\Entity\AnalyticsConfig;
use Kunstmaan\DashboardBundle\Entity\AnalyticsOverview;
use Kunstmaan\DashboardBundle\Entity\AnalyticsSegment;
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;

/**
 * @final since 5.1
 * NEXT_MAJOR extend from `Command` and remove `$this->getContainer` usages
 */
class GoogleAnalyticsOverviewsListCommand extends ContainerAwareCommand

The class Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand has been deprecated with message: since Symfony 4.2, use {@see Command} instead.

{
    /** @var EntityManagerInterface */
    private $em;

    /**
     * @param EntityManagerInterface|null $em
     */
    public function __construct(/* EntityManagerInterface */ $em = 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:overviews:list' : $em);

            return;
        }

        $this->em = $em;
    }

    protected function configure()

This method seems to be duplicated in your project.

    {
        $this
            ->setName('kuma:dashboard:widget:googleanalytics:overviews:list')
            ->setDescription('List available overviews')
            ->addOption(
                'config',
                null,
                InputOption::VALUE_OPTIONAL,
                'Specify to only list overviews of one config',
                false
            )
            ->addOption(
                'segment',
                null,
                InputOption::VALUE_OPTIONAL,
                'Specify to only list overviews of one segment',
                false
            );
    }

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

        // get params
        $configId = $input->getOption('config');
        $segmentId = $input->getOption('segment');

        try {
            if ($segmentId) {
                $overviews = $this->getOverviewsOfSegment($segmentId);
            } elseif ($configId) {
                $overviews = $this->getOverviewsOfConfig($configId);
            } else {
                $overviews = $this->getAllOverviews();
            }

            if (\count($overviews)) {
                $result = "\t".'<fg=green>' . \count($overviews) . '</fg=green> overviews found:';
                $output->writeln($result);
                foreach ($overviews as $overview) {
                    $result = "\t".'(id: <fg=cyan>' .$overview->getId() . '</fg=cyan>)';
                    $result .= "\t".'(config: <fg=cyan>' .$overview->getconfig()->getId() . '</fg=cyan>)';
                    if ($overview->getSegment()) {
                        $result .= "\t".'(segment: <fg=cyan>' .$overview->getSegment()->getId() . '</fg=cyan>)';
                    } else {
                        $result .= "\t\t";
                    }
                    $result .= "\t" . $overview->getTitle();

                    $output->writeln($result);
                }
            } else {
                $output->writeln('No overviews found');
            }

            return 0;
        } catch (\Exception $e) {
            $output->writeln('<fg=red>'.$e->getMessage().'</fg=red>');

            return 1;
        }
    }

    /**
     * get all overviews of a segment
     *
     * @param int $segmentId
     *
     * @return array
     */
    private function getOverviewsOfSegment($segmentId)

This method seems to be duplicated in your project.

    {
        // get specified segment
        $segmentRepository = $this->em->getRepository(AnalyticsSegment::class);
        $segment = $segmentRepository->find($segmentId);

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

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

    /**
     * get all overviews of a config
     *
     * @param int $configId
     *
     * @return array
     */
    private function getOverviewsOfConfig($configId)

This method seems to be duplicated in your project.

    {
        // get specified config
        $configRepository = $this->em->getRepository(AnalyticsConfig::class);
        $config = $configRepository->find($configId);

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

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

    /**
     * get all overviews
     *
     * @return array

Consider making the return type a bit more specific; maybe use object[].

     */
    private function getAllOverviews()
    {
        // get all overviews
        $overviewRepository = $this->em->getRepository(AnalyticsOverview::class);

        return $overviewRepository->findAll();
    }
}