GSoares\GoogleTrends\Search\SearchFilter

Complexity

Total Complexity

27

Size/Duplication

Total Lines	256
Duplicated Lines	0 %

Coupling/Cohesion

Components	8
Dependencies	1

Test Coverage

Coverage

100%

Importance

Changes

0

25 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	12	1
A	withToken()	0	6	1
A	withinInterval()	0	27	3
A	considerImageSearch()	0	6	1
A	considerGoogleShoppingSearch()	0	6	1
A	considerYoutubeSearch()	0	6	1
A	considerNewsSearch()	0	6	1
A	considerWebSearch()	0	6	1
A	withRisingMetrics()	0	6	1
A	withTopMetrics()	0	6	1
A	withLanguage()	0	6	1
A	withCategory()	0	6	1
A	withLocation()	0	6	1
A	withSearchTerm()	0	6	1
A	getToken()	0	4	1
A	getLocation()	0	4	1
A	getLanguage()	0	4	1
A	getCategory()	0	4	1
A	getSearchTerm()	0	4	1
A	getSearchType()	0	4	1
A	getTime()	0	4	1
A	getCompareTime()	0	4	1
A	getMetrics()	0	4	1
A	isConsideringTopMetrics()	0	4	1
A	isConsideringRisingMetrics()	0	4	1

<?php declare(strict_types=1);

namespace GSoares\GoogleTrends\Search;

use DateTimeImmutable;
use GSoares\GoogleTrends\Error\GoogleTrendsException;

/**
 * @author Gabriel Felipe Soares <gabrielfs7@gmail.com>
 */
class SearchFilter
{
    public const SEARCH_SOURCE_WEB = '';
    public const SEARCH_SOURCE_NEWS = 'news';
    public const SEARCH_SOURCE_IMAGES = 'images';
    public const SEARCH_SOURCE_YOUTUBE = 'youtube';
    public const SEARCH_SOURCE_GOOGLE_SHOPPING = 'froogle';

    private const DEFAULT_LANG = 'en-US';
    private const DEFAULT_COUNTRY = 'US';

    /**
     * @var string
     */
    private $token;

    /**
     * @var string
     */
    private $location;

    /**
     * @var string
     * @deprecated Will be removed, cause other languages do not work as filter. We should utilize only location
     */
    private $language;

    /**
     * @var int
     */
    private $category;

    /**
     * @var string
     */
    private $searchTerm;

    /**
     * @var string[]
     */
    private $metrics;

    /**
     * @var string
     */
    private $time;

    /**
     * @var string
     */
    private $compareTime;

    /**
     * @var string
     */
    private $searchType;

    /**
     * @var DateTimeImmutable
     */
    private $currentDate;

    public function __construct(DateTimeImmutable $currentDate = null)
    {
        $this->metrics = [];
        $this->searchTerm = '';
        $this->category = 0;
        $this->currentDate = $currentDate ?? new DateTimeImmutable();

        $this->withinInterval($this->currentDate->modify('-1 month'), $this->currentDate)

The method GSoares\GoogleTrends\Search\SearchFilter::withLanguage() has been deprecated with message: Will be removed, cause other languages do not work as filter. We should utilize only location

            ->withLanguage(self::DEFAULT_LANG)
            ->withLocation(self::DEFAULT_COUNTRY)
            ->considerWebSearch();
    }

    public function withToken(string $token): self
    {
        $this->token = $token;

        return $this;
    }

    /**
     * @param DateTimeImmutable $from
     * @param DateTimeImmutable $to
     *
     * @return $this
     *
     * @throws GoogleTrendsException
     */
    public function withinInterval(DateTimeImmutable $from, DateTimeImmutable $to): self
    {
        if ($from >= $to || $from->format('Ymd') === $to->format('Ymd')) {
            throw new GoogleTrendsException(
                sprintf(
                    'Invalid interval. From %s to %s',
                    $from->format(DATE_ATOM),
                    $to->format(DATE_ATOM)
                )
            );
        }

        $from = $from->setTime(0, 0, 0);
        $to = $to->setTime(23, 59, 50);

        $this->time = $from->format('Y-m-d') . ' ' . $to->format('Y-m-d');

        $daysDifference = (int)ceil(($to->getTimestamp() - $from->getTimestamp()) / 60 / 60 / 24);

        $this->compareTime = $from->modify('-' . $daysDifference . ' days')
            ->format('Y-m-d')
            . ' '
            . $to->modify('-' . $daysDifference . ' days')
            ->format('Y-m-d');

        return $this;
    }

    public function considerImageSearch(): self
    {
        $this->searchType = self::SEARCH_SOURCE_IMAGES;

        return $this;
    }

    public function considerGoogleShoppingSearch(): self
    {
        $this->searchType = self::SEARCH_SOURCE_GOOGLE_SHOPPING;

        return $this;
    }

    public function considerYoutubeSearch(): self
    {
        $this->searchType = self::SEARCH_SOURCE_YOUTUBE;

        return $this;
    }

    public function considerNewsSearch(): self
    {
        $this->searchType = self::SEARCH_SOURCE_NEWS;

        return $this;
    }

    public function considerWebSearch(): self
    {
        $this->searchType = self::SEARCH_SOURCE_WEB;

        return $this;
    }

    public function withRisingMetrics(): self
    {
        $this->metrics[] = 'RISING';

        return $this;
    }

    public function withTopMetrics(): self
    {
        $this->metrics[] = 'TOP';

        return $this;
    }

    /**
     * @deprecated Will be removed, cause other languages do not work as filter. We should utilize only location
     */
    public function withLanguage(string $language): self
    {
        $this->language = $language;

The property GSoares\GoogleTrends\Search\SearchFilter::$language has been deprecated with message: Will be removed, cause other languages do not work as filter. We should utilize only location

        return $this;
    }

    public function withCategory(int $category): self
    {
        $this->category = $category;

        return $this;
    }

    public function withLocation(string $location): self
    {
        $this->location = $location;

        return $this;
    }

    public function withSearchTerm(string $searchTerm): self
    {
        $this->searchTerm = $searchTerm;

        return $this;
    }

    public function getToken(): string
    {
        return (string)$this->token;
    }

    public function getLocation(): string
    {
        return $this->location;
    }

    /**
     * @deprecated Will be removed, cause other languages do not work as filter. We should utilize only location
     */
    public function getLanguage(): string
    {
        return $this->language;

The property GSoares\GoogleTrends\Search\SearchFilter::$language has been deprecated with message: Will be removed, cause other languages do not work as filter. We should utilize only location

    }

    public function getCategory(): int
    {
        return $this->category;
    }

    public function getSearchTerm(): string
    {
        return $this->searchTerm;
    }

    public function getSearchType(): string
    {
        return $this->searchType;
    }

    public function getTime(): string
    {
        return $this->time;
    }

    public function getCompareTime(): string
    {
        return $this->compareTime;
    }

    public function getMetrics(): array
    {
        return $this->metrics;
    }

    public function isConsideringTopMetrics(): bool
    {
        return in_array('TOP', $this->metrics);
    }

    public function isConsideringRisingMetrics(): bool
    {
        return in_array('RISING', $this->metrics);
    }
}