Andegna\Operations\Formatter

Complexity

Total Complexity

47

Size/Duplication

Total Lines	231
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	format()	0	12	2
A	getValueOfFormatCharacter()	0	9	2
A	getDayTwoDigit()	0	6	2
A	getTextualDay()	0	4	1
A	getTextualDayShort()	0	6	1
A	getTextualMonth()	0	4	1
A	getTextualMonthShort()	0	6	1
A	getMonth()	0	4	1
A	getMonthTwoDigit()	0	6	2
A	getDaysInMonth()	0	4	1
A	getLeapYearString()	0	4	2
A	getYear()	0	4	1
A	getYearShort()	0	6	1
D	getTimeOfDay()	0	45	25
A	getOrthodoxDay()	0	4	1
A	getTextualEra()	0	4	2
A	getOrthodoxYear()	0	4	1

<?php

namespace Andegna\Operations;

use Andegna\Constants;

/**
 * class DateFormatter.
 *
 * This class deals with the date time formatting issue
 */
trait Formatter
{
    /**
     * Accepts the same format as the date() function.
     *
     * @see date(), \DateTime
     *
     * @param $format
     *
     * @return string
     */
    public function format($format)
    {
        $result = '';
        $length = \mb_strlen($format);

        // iterate for each character
        for ($index = 0; $index < $length; $index++) {
            $result .= $this->getValueOfFormatCharacter(mb_substr($format, $index, 1));
        }

        return $result;
    }

    /**
     * Return the value of the format character.
     *
     * @param string $name of the field
     *
     * @return string
     */
    protected function getValueOfFormatCharacter($name)
    {

        if (array_key_exists($name, Constants::FORMAT_MAPPER)) {
            return '' . $this->{Constants::FORMAT_MAPPER[$name]}();
        }

        return $this->dateTime->format($name);

The property dateTime does not exist. Did you maybe forget to declare it?

    }

    /**
     * (01-30) Day of the month, 2 digits with leading zeros
     *
     * @return string
     */
    public function getDayTwoDigit()
    {
        $day = $this->getValueOfFormatCharacter('j');

        return strlen($day) === 1 ? "0$day" : $day;
    }

    /**
     * (ሰኞ-እሑድ) A full textual representation of the day of the week
     *
     * return string
     */
    public function getTextualDay()
    {
        return Constants::WEEK_NAME[$this->getDayOfWeek()];

It seems like getDayOfWeek() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * (ሰኞ-እሑ) A textual representation of a day, two letters
     *
     * return string
     */
    public function getTextualDayShort()
    {
        $week = $this->getValueOfFormatCharacter('l');

        return mb_substr($week, 0, 2, 'UTF-8');
    }

    /**
     * (መስከረም-ጳጉሜን) A full textual representation of a month
     *
     * @return string
     */
    public function getTextualMonth()
    {
        return Constants::MONTHS_NAME[$this->getMonth()];
    }

    /**
     * (መስ - ጳጉ) A short textual representation of a month, two letters
     *
     * @return string
     */
    public function getTextualMonthShort()
    {
        $F = $this->getValueOfFormatCharacter('F');

        return mb_substr($F, 0, 2, 'UTF-8');
    }

    /**
     * (1-13) Numeric representation of a month, without leading zeros
     *
     * @return string
     */
    public function getMonth()
    {
        return "{$this->getMonth()}";
    }

    /**
     * (01-13) Numeric representation of a month, with leading zeros
     *
     * @return string
     */
    public function getMonthTwoDigit()
    {
        $n = $this->getValueOfFormatCharacter('n');

        return (strlen($n) == 1) ? "0$n" : "$n";
    }

    /**
     * (5,6 or 30) Number of days in the given month
     *
     * @return string
     */
    public function getDaysInMonth()
    {
        return "{$this->getDaysInMonth()}";
    }

    /**
     * (1 or 0) Whether it's a leap year
     *
     * @return string
     */
    public function getLeapYearString()
    {
        return $this->isLeapYear() ? '1' : '0';

It seems like isLeapYear() must be provided by classes using this trait. How about adding it as abstract method to this trait?

    }

    /**
     * (1000-9999) A full numeric representation of a year, 4 digits mostly
     *
     * @return string
     */
    public function getYear()
    {
        return "{$this->getYear()}";
    }

    public function getYearShort()
    {
        $Y = $this->getValueOfFormatCharacter('Y');

        return mb_substr($Y, strlen($Y) - 2, 2);
    }

    /**
     * Return the amharic equivalent of AM & PM.
     *
     * (እኩለ፡ሌሊት-ምሽት)
     *
     * It suppose to format 'Ante meridiem' and 'Post meridiem'
     * But we Ethiopians classify the day in <b>ten</b> parts
     * and we don't have Uppercase and Lowercase letters
     *
     * @link http://web.archive.org/web/20140331152859/http://ethiopic.org/Calendars/
     *
     * @return string
     */
    public function getTimeOfDay()
    {
        switch ($this->getHour()) {

It seems like getHour() must be provided by classes using this trait. How about adding it as abstract method to this trait?

            case 23:
            case 0:
                return 'እኩለ፡ሌሊት';
            case 1:
            case 2:
            case 3:
                return 'ውደቀት';
            case 4:
            case 5:
                return 'ንጋት';
            case 6:
            case 7:
            case 8:
                return 'ጡዋት';
            case 9:
            case 10:
            case 11:
                return 'ረፋድ';
            case 12:
                return 'እኩለ፡ቀን';
            case 13:
            case 14:
            case 15:
                return 'ከሰዓት፡በኋላ';
            case 16:
            case 17:
                return 'ወደማታ';
            case 18:
            case 19:
                return 'ሲደነግዝ';
            case 20:
            case 21:
            case 22:
                return 'ምሽት';
        }

        // We shouldn't get to this :(
        // Something must been wrong

        // Lets just keep quite about it ;)
        return '';
    }

    public function getOrthodoxDay()
    {
        return Constants::ORTHODOX_DAY_NAME[$this->getMonth()];
    }

    public function getTextualEra()
    {
        return $this->getYear() > 0 ? 'ዓ/ም' : 'ዓ/ዓ';
    }

    public function getOrthodoxYear()
    {
        return Constants::ORTHODOX_YEAR_NAME[$this->getYear() % 4];
    }

}