Katapoka\Ahgora\AbstractApi

Complexity

Total Complexity

10

Size/Duplication

Total Lines	60
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

0%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	isValidMonth()	0	4	3
A	isValidYear()	0	4	1
B	isValidPeriod()	0	7	5
A	setDateTimeFormat()	0	6	1

<?php
namespace Katapoka\Ahgora;

use Katapoka\Ahgora\Contracts\IAhgoraApi;

/**
 * Class AbstractApi.
 */
abstract class AbstractApi implements IAhgoraApi
{
    use Loggable;

    protected $datetimeFormat = 'Y-m-d H:i:s';

    /**
     * Validate if the given month is valid.
     *
     * @param int $month
     *
     * @return bool
     */
    protected function isValidMonth($month)
    {
        return is_int($month) && ($month >= 1 && $month <= 12);
    }

    /**
     * Validate if the given year is "valid".
     *
     * @param int $year
     *
     * @return bool
     */
    protected function isValidYear($year)
    {
        return $year <= date('Y');
    }

    /**
     * Validate if the given period is valid.
     *
     * @param int $month
     * @param int $year
     *
     * @return bool
     */
    protected function isValidPeriod($month, $year)
    {
        $currentYear = (int)date('Y');
        $currentMonth = (int)date('m');

        return $this->isValidMonth($month) && $this->isValidYear($year) && ($year < $currentYear || $year === $currentYear && $month <= $currentMonth);
    }

    /**
     * Set the Datetime parse format. Default 'Y-m-d H:i:s'.
     *
     * @param $format
     *
     * @return $this
     */
    public function setDateTimeFormat($format)
    {
        $this->datetimeFormat = $format;

        return $this;
    }
}