symfony-doge/veslo

<?php

/*
 * This file is part of the Veslo project <https://github.com/symfony-doge/veslo>.
 *
 * (C) 2019 Pavel Petrov <itnelo@gmail.com>.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license https://opensource.org/licenses/GPL-3.0 GPL-3.0
 */

declare(strict_types=1);

namespace Veslo\AnthillBundle\Entity\Vacancy\Roadmap\Configuration\Parameters;

use DateTimeInterface;
use Doctrine\ORM\Mapping as ORM;
use Veslo\AnthillBundle\Vacancy\Roadmap\Configuration\ParametersInterface;
use Veslo\AnthillBundle\Vacancy\Roadmap\Strategy\HeadHunter\Api\Version20190213 as HeadHunterApiStrategy;

/**
 * Parameters for vacancy search on HeadHunter website
 *
 * @ORM\Table(name="anthill_vacancy_roadmap_headhunter")
 * @ORM\Entity(repositoryClass="Veslo\AnthillBundle\Entity\Repository\Vacancy\Roadmap\Configuration\Parameters\HeadHunterRepository")
 * @ORM\Cache(usage="READ_WRITE", region="roadmap_parameters_head_hunter")
 */
class HeadHunter implements ParametersInterface
{
    /**
     * DateTime format
     *
     * @const string
     */
    public const DATETIME_FORMAT = 'Y-m-d\TH:i:s';

    /**
     * Parameters record identifier
     *
     * @var int
     *
     * @ORM\Column(name="id", type="integer", options={"comment": "Parameters record identifier"})
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    private $id;

    /**
     * Roadmap configuration key to which parameters belongs to
     *
     * @var string
     *
     * @ORM\Column(
     *     name="configuration_key",
     *     type="string",
     *     length=255,
     *     unique=true,
     *     options={"comment": "Roadmap configuration key to which parameters belongs to"}
     * )
     */
    private $configurationKey;

    /**
     * Vacancy website URL
     *
     * @var string
     *
     * @ORM\Column(name="url", type="string", length=255, options={"comment": "Vacancy website URL"})
     */
    private $url;

    /**
     * Search query text
     *
     * @var string
     *
     * @ORM\Column(name="text", type="string", length=255, options={"comment": "Search query text"})
     */
    private $text;

    /**
     * Vacancy area
     *
     * @var int
     *
     * @ORM\Column(name="area", type="integer", options={"unsigned": true, "comment": "Vacancy area"})
     */
    private $area;

    /**
     * Publication date from
     *
     * @var DateTimeInterface
     *
     * @ORM\Column(name="date_from", type="datetime", options={"comment": "Publication date from"})
     */
    private $dateFrom;

    /**
     * Publication date to
     *
     * @var DateTimeInterface
     *
     * @ORM\Column(name="date_to", type="datetime", options={"comment": "Publication date to"})
     */
    private $dateTo;

    /**
     * Order by criteria
     *
     * @var string
     *
     * @ORM\Column(name="order_by", type="string", length=255, options={"comment": "Order by criteria"})
     */
    private $orderBy;

    /**
     * Number of vacancies to fetch for a single page
     *
     * @var int
     *
     * @ORM\Column(
     *     name="per_page",
     *     type="integer",
     *     options={"unsigned": true, "comment": "Number of vacancies to fetch for a single page"}
     * )
     */
    private $perPage;

    /**
     * Vacancies received during specified publication date range
     * This value cannot be used in any real statistics because it can be changed by algorithms
     *
     * @var int
     *
     * @ORM\Column(
     *     name="received",
     *     type="integer",
     *     options={"unsigned": true, "comment": "Vacancies received during specified publication date range"}
     * )
     *
     * @see HeadHunterApiStrategy::determinePage()
     */
    private $received;

    /**
     * Returns parameters record identifier
     *
     * @return int
     */
    public function getId(): int
    {
        return $this->id;
    }

    /**
     * {@inheritdoc}
     */
    public function getConfigurationKey(): string
    {
        return $this->configurationKey;
    }

    /**
     * Sets configuration key to which parameters belongs to
     *
     * @param string $configurationKey Configuration key to which parameters belongs to
     *
     * @return void
     */
    public function setConfigurationKey(string $configurationKey): void
    {
        $this->configurationKey = $configurationKey;
    }

    /**
     * {@inheritdoc}
     */
    public function getProviderUri(): string
    {
        return $this->getUrl();
    }

    /**
     * Returns vacancy website URL
     *
     * @return string
     */
    public function getUrl(): string
    {
        return $this->url;
    }

    /**
     * Sets vacancy website URL
     *
     * @param string $url Website URL
     *
     * @return void
     */
    public function setUrl(string $url): void
    {
        $this->url = $url;
    }

    /**
     * Returns search query text
     *
     * @return string
     */
    public function getText(): string
    {
        return $this->text;
    }

    /**
     * Sets search query text
     *
     * @param string $text Search query text
     *
     * @return void
     */
    public function setText(string $text): void
    {
        $this->text = $text;
    }

    /**
     * Returns vacancy area
     *
     * @return int
     */
    public function getArea(): int
    {
        return $this->area;
    }

    /**
     * Sets vacancy area
     *
     * @param int $area Vacancy area
     *
     * @return void
     */
    public function setArea(int $area): void
    {
        $this->area = $area;
    }

    /**
     * Returns publication date "from" part for searching vacancies within range
     *
     * @return DateTimeInterface
     */
    public function getDateFrom(): DateTimeInterface
    {
        return $this->dateFrom;
    }

    /**
     * Returns publication date "from" formatted for query argument
     *
     * @return string
     */
    public function getDateFromFormatted(): string
    {
        if (!$this->dateFrom instanceof DateTimeInterface) {
            return '';
        }

        return $this->dateFrom->format(self::DATETIME_FORMAT);
    }

    /**
     * Sets publication date from
     *
     * @param DateTimeInterface $dateFrom Publication date "from" part for searching vacancies within range
     *
     * @return void
     */
    public function setDateFrom(DateTimeInterface $dateFrom): void
    {
        $this->dateFrom = $dateFrom;
    }

    /**
     * Returns publication date "to" part for searching vacancies within range
     *
     * @return DateTimeInterface
     */
    public function getDateTo(): DateTimeInterface
    {
        return $this->dateTo;
    }

    /**
     * Returns publication date "to" formatted for query argument
     *
     * @return string
     */
    public function getDateToFormatted(): string
    {
        if (!$this->dateTo instanceof DateTimeInterface) {
            return '';
        }

        return $this->dateTo->format(self::DATETIME_FORMAT);
    }

    /**
     * Sets publication date to
     *
     * @param DateTimeInterface $dateTo Publication date "to" part for searching vacancies within range
     *
     * @return void
     */
    public function setDateTo(DateTimeInterface $dateTo): void
    {
        $this->dateTo = $dateTo;
    }

    /**
     * Returns order by criteria
     *
     * @return string
     */
    public function getOrderBy(): string
    {
        return $this->orderBy;
    }

    /**
     * Sets order by criteria
     *
     * @param string $orderBy Order by criteria
     *
     * @return void
     */
    public function setOrderBy(string $orderBy): void
    {
        $this->orderBy = $orderBy;
    }

    /**
     * Returns number of vacancies to fetch for a single page
     *
     * @return int
     */
    public function getPerPage(): int
    {
        return $this->perPage;
    }

    /**
     * Sets number of vacancies to fetch for a single page
     *
     * @param int $perPage Number of vacancies to fetch for a single page
     *
     * @return void
     */
    public function setPerPage(int $perPage): void
    {
        $this->perPage = $perPage;
    }

    /**
     * Returns received vacancies count during specified publication date range
     *
     * @return int
     */
    public function getReceived(): int
    {
        return $this->received;
    }

    /**
     * Sets vacancies received count
     *
     * @param int $received Received vacancies count during specified publication date range
     *
     * @return void
     */
    public function setReceived(int $received): void
    {
        $this->received = $received;
    }
}