JeroenDesloovere\SitemapBundle\Item\ChangeFrequency

Complexity

Total Complexity

19

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	monthly()	0	3	1
A	isMonthly()	0	3	1
A	isAlways()	0	3	1
A	daily()	0	3	1
A	isNever()	0	3	1
A	isWeekly()	0	3	1
A	isYearly()	0	3	1
A	isHourly()	0	3	1
A	equals()	0	7	2
A	yearly()	0	3	1
A	__construct()	0	7	2
A	weekly()	0	3	1
A	__toString()	0	3	1
A	never()	0	3	1
A	isDaily()	0	3	1
A	hourly()	0	3	1
A	always()	0	3	1

<?php

namespace JeroenDesloovere\SitemapBundle\Item;

use JeroenDesloovere\SitemapBundle\Exception\SitemapException;

final class ChangeFrequency
{
    protected const ALWAYS = 'always';
    protected const HOURLY = 'hourly';
    protected const DAILY = 'daily';
    protected const WEEKLY = 'weekly';
    protected const MONTHLY = 'monthly';
    protected const YEARLY = 'yearly';
    protected const NEVER = 'never';

    public const POSSIBLE_VALUES = [
        self::ALWAYS,
        self::HOURLY,
        self::DAILY,
        self::WEEKLY,
        self::MONTHLY,
        self::YEARLY,
        self::NEVER,
    ];

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

    /**
     * @param string $changeFrequency
     * @throws \Exception
     */
    private function __construct(string $changeFrequency)
    {
        if (!in_array($changeFrequency, self::POSSIBLE_VALUES)) {
            throw SitemapException::forNotExistingChangeFrequency($changeFrequency);
        }

        $this->value = $changeFrequency;
    }

    public function __toString(): string
    {
        return $this->value;
    }

    public function equals(ChangeFrequency $changeFrequency): bool
    {
        if (!($changeFrequency instanceof $this)) {
            return false;
        }

        return $changeFrequency === $this;
    }

    public static function always(): self
    {
        return new self(self::ALWAYS);
    }

    public function isAlways(): bool
    {
        return $this->equals(self::always());
    }

    public static function hourly(): self
    {
        return new self(self::HOURLY);
    }

    public function isHourly(): bool
    {
        return $this->equals(self::hourly());
    }

    public static function daily(): self
    {
        return new self(self::DAILY);
    }

    public function isDaily(): bool
    {
        return $this->equals(self::daily());
    }

    public static function weekly(): self
    {
        return new self(self::WEEKLY);
    }

    public function isWeekly(): bool
    {
        return $this->equals(self::weekly());
    }

    public static function monthly(): self
    {
        return new self(self::MONTHLY);
    }

    public function isMonthly(): bool
    {
        return $this->equals(self::monthly());
    }

    public static function yearly(): self
    {
        return new self(self::YEARLY);
    }

    public function isYearly(): bool
    {
        return $this->equals(self::yearly());
    }

    public static function never(): self
    {
        return new self(self::NEVER);
    }

    public function isNever(): bool
    {
        return $this->equals(self::never());
    }
}