Charcoal\Admin\Search\TopSearchWidget

Complexity

Total Complexity

12

Size/Duplication

Total Lines	81
Duplicated Lines	41.98 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes	2
Bugs	1	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	setDependencies()	6	6	1
A	setStartDate()	17	17	4
A	startDate()	7	7	2

<?php

namespace Charcoal\Admin\Widget\Search;

use \DateTime;
use \DateTimeInterface;
use \InvalidArgumentException;
use \PDO;

use \Pimple\Container;

use \Charcoal\Admin\AdminWidget;

use \Charcoal\Search\SearchLog;

/**
 * Search widget to show the latest searched-for terms and their results.
 */
class TopSearchWidget extends AdminWidget

This class seems to be duplicated in your project.

{
    /**
     * @var DateTimeInterface $startDate
     */
    private $startDate;

    /**
     * @var DateTimeInterface $endDate
     */
    private $endDate;

    private $collectionLoader;
    private $topSearches;

    public function setDependencies(Container $container)
    {
        parent::setDependencies($container);

        $this->collectionLoader = $container['model/collection/loader'];
    }

    /**
     * @param string|DateTimeInterface|null $date The starting date-time.
     * @throws InvalidArgumentException If the date format is not valid.
     * @return TopSearchWidget Chainable
     */
    public function setStartDate($date)
    {
        if ($date === null) {
            $this->startDate = new DateTime('30 days ago');
            return $this;
        }
        if (is_string($date)) {
            $date = new DateTime($date);
        }
        if (!($date instanceof DateTimeInterface)) {
            throw new InvalidArgumentException(
                'Invalid "Start Date" value. Must be a date/time string or a DateTimeInterface object.'
            );
        }
        $this->startDate = $date;
        return $this;
    }

    /**
     * @return DateTimeInterface
     */
    public function startDate()
    {
        if ($this->startDate === null) {
            return new DateTime('30 days ago');
        }
        return $this->startDate;
    }

    /**
     * @param string|DateTimeInterface|null $date The ending date-time.
     * @throws InvalidArgumentException If the date format is not valid.
     * @return TopSearchWidget Chainable
     */
    public function setEndDate($date)
    {
        if ($date === null) {
            $this->endDate = new DateTime('now');
            return $this;
        }
        if (is_string($date)) {
            $date = new DateTime($date);
        }
        if (!($date instanceof DateTimeInterface)) {
            throw new InvalidArgumentException(
                'Invalid "End Date" value. Must be a date/time string or a DateTimeInterface object.'
            );
        }
        $this->endDate = $date;
        return $this;
    }


    /**
     * @return DateTimeInterface
     */
    public function endDate()
    {
        if ($this->endDate === null) {
            return new DateTime('now');
        }
        return $this->endDate;
    }

    public function topSearches()
    {
        if ($this->topSearches === null) {
            $this->topSearches = $this->loadTopSearches();
        }

        return $this->topSearches;
    }

    public function hasTopSearches()
    {
        $topSearches = $this->topSearches();
        return (count($topSearches) > 0);
    }

    public function loadTopSearches()
    {
        $proto = $this->modelFactory()->create(SearchLog::class);
        $source = $proto->source();
        $table = $source->table();

        $q = '
        SELECT
            `keyword`,
            COUNT(`keyword`) as num_searches,
            SUM(`num_results`) as num_results
        FROM
            `'.$table.'`
        WHERE
            `ts` > :start
        AND
            `ts` <= :end
        GROUP BY
            `keyword`
        ORDER BY
            num_searches DESC
        LIMIT
            20
        ';

        $sth = $source->dbQuery($q, [
            'start' =>$this->startDate()->format('Y-m-d H:i:s'),
            'end' => $this->endDate()->format('Y-m-d H:i:s')
        ]);

        $results = $sth->fetchAll(PDO::FETCH_ASSOC);
        return $results;
    }
}