PhpWeekday::parseName() - Code Metrics - Inspection of "Fixes #3" - chinleung/php-weekday - Measure and Improve Code Quality continuously with Scrutinizer

Completed
Push — master ( 02fcb9...4774b2 )

by Chin
created 2019-08-05 17:39 UTC
PhpWeekday::parseName() A

↳ Parent: PhpWeekday
Complexity

Conditions	4
Paths	2
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
dl	0
loc	10
rs	9.9332
c	0
b	0
f	0
cc	4
nc	2
nop	2
<?php

namespace ChinLeung\PhpWeekday;

use InvalidArgumentException;

class PhpWeekday
{
    /**
     * The locale of the application.
     *
     * @var string
     */
    protected $locale;

    /**
     * The name of the weekday.
     *
     * @var string
     */
    protected $name;

    /**
     * The value of the weekday.
     *
     * @var int
     */
    protected $value;

    /**
     * Constructor of the class.
     *
     * @param  string|int  $value
     * @param  string  $locale
     * @return self

     */
    public function __construct($value, string $locale)
    {
        $this->setLocale($locale)
             ->set($value);

        return $this;

    }

    /**
     * Retrieve the current locale.
     *
     * @return string
     */
    public function getLocale() : string
    {
        return $this->locale;
    }

    /**
     * Retrieve the supported locales.
     *
     * @return array
     */
    public static function getLocales() : array
    {
        return array_map(
            'basename',
            glob(__DIR__.'/../resources/lang/*') ?: []
        );
    }

    /**
     * Retrieve the name of the weekday.
     *
     * @param  string  $locale
     * @return string
     */
    public function getName(string $locale = null) : string
    {
        if ($locale && $locale != $this->locale) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return $this->parseName($this->getValue(), $locale);
        }

        if (is_null($this->name)) {
            $this->name = $this->parseName($this->getValue());
        }

        return $this->name;
    }

    /**
     * Retrieve the name from a value.
     *
     * @param  int  $value
     * @param  string  $locale
     * @return string
     */
    public static function getNameFromValue(int $value, string $locale) : string
    {
        return static::parse($value, $locale)->getName();
    }

    /**
     * Retrieve the names of every weekday for a locale.
     *
     * @param  string  $locale
     * @return array
     */
    public static function getNames(string $locale) : array
    {
        $path = __DIR__."/../resources/lang/$locale/names.php";

        if (! file_exists($path)) {
            static::throwNotSupportedLocaleException($locale);
        }

        return require $path;
    }

    /**
     * Retrieve the value of the weekday.
     *
     * @return int
     */
    public function getValue() : int
    {
        if (is_null($this->value)) {
            $this->value = $this->parseValue($this->getName());
        }

        return $this->value;
    }

    /**
     * Retrieve the value from a name.
     *
     * @param  string  $name
     * @param  string  $locale
     * @return string
     */
    public static function getValueFromName(string $name, string $locale) : string
    {
        return static::parse($name, $locale)->getValue();
    }

    /**
     * Check if the locale is supported.
     *
     * @param  string  $locale
     * @return bool
     */
    public function isSupported(string $locale) : bool
    {
        return file_exists(__DIR__."/../resources/lang/$locale");
    }

    /**
     * Check if the locale is not supported.
     *
     * @param  string  $locale
     * @return bool
     */
    public function isNotSupported(string $locale) : bool
    {
        return ! $this->isSupported($locale);
    }

    /**
     * Create a new instance from a value.
     *
     * @param  string|int  $value
     * @param  string  $locale
     * @return self
     */
    public static function parse($value, string $locale)
    {
        return new static($value, $locale);
    }

    /**
     * Parse the name of the weekday based on the value.
     *
     * @param  int  $value
     * @param  string  $locale
     * @return string
     */
    public function parseName(int $value, string $locale = null) : string
    {
        if ($value < 0 || $value > 6) {
            throw new InvalidArgumentException(
                "The provided value ($value) is not a valid weekday."
            );
        }

        return array_values(static::getNames($locale ?: $this->locale))[$value];
    }

    /**
     * Parse the value from the weekday name.
     *
     * @param  string  $name
     * @param  string  $locale
     * @return int
     */
    public function parseValue(string $name, string $locale = null) : int
    {
        $names = array_map(
            'strtolower',
            static::getNames($locale ?: $this->locale)
        );

        $value = array_search(
            strtolower($name),
            array_values($names)
        );

        if ($value === false) {
            throw new InvalidArgumentException(
                sprintf(
                    'The value could not be parsed for %s in %s.',
                    $name,
                    $locale ?: $this->locale
                )
            );
        }

        return $value;
    }

    /**
     * Set the weekday based on the integer or string value.
     *
     * @param  string|int  $value
     * @return self
     */
    public function set($value) : self
    {
        if (is_numeric($value)) {
            $this->value = $value;
class Id
{
    public $id;

    public function __construct($id)
    {
        $this->id = $id;
    }

}

class Account
{
    /** @var  Id $id */
    public $id;
}

$account_id = false;

if (starsAreRight()) {
    $account_id = new Id(42);
}

$account = new Account();
if ($account instanceof Id)
{
    $account->id = $account_id;
}
            $this->name = null;
        } else {
            $this->name = $value;
            $this->value = null;
        }

        return $this;
    }

    /**
     * Set the locale of the instance.
     *
     * @param  string  $locale
     * @return self
     */
    public function setLocale(string $locale) : self
    {
        if ($locale != $this->locale) {
            if ($this->isNotSupported($locale)) {
                static::throwNotSupportedLocaleException($locale);
            }

            $this->name = null;
            $this->locale = $locale;
        }

        return $this;
    }

    /**
     * Throw an exception to let the user know that the locale is not yet
     * supported.
     *
     * @param  string  $locale
     * @return void
     */
    protected static function throwNotSupportedLocaleException(string $locale) : void
    {
        throw new InvalidArgumentException(
            "The locale ($locale) is not yet supported."
        );
    }

    /**
     * Function to retrieve the name in Afrikaans.
     *
     * @return string
     */
    public function inAfrikaans() : string
    {
        return $this->getName('af');
    }

    /**
     * Function to retrieve the name in Albanian.
     *
     * @return string
     */
    public function inAlbanian() : string
    {
        return $this->getName('sq');
    }

    /**
     * Function to retrieve the name in Amharic.
     *
     * @return string
     */
    public function inAmharic() : string
    {
        return $this->getName('am');
    }

    /**
     * Function to retrieve the name in Arabic.
     *
     * @return string
     */
    public function inArabic() : string
    {
        return $this->getName('ar');
    }

    /**
     * Function to retrieve the name in Armenian.
     *
     * @return string
     */
    public function inArmenian() : string
    {
        return $this->getName('hy');
    }

    /**
     * Function to retrieve the name in Azerbaijani.
     *
     * @return string
     */
    public function inAzerbaijani() : string
    {
        return $this->getName('az');
    }

    /**
     * Function to retrieve the name in Basque.
     *
     * @return string
     */
    public function inBasque() : string
    {
        return $this->getName('eu');
    }

    /**
     * Function to retrieve the name in Belarusian.
     *
     * @return string
     */
    public function inBelarusian() : string
    {
        return $this->getName('be');
    }

    /**
     * Function to retrieve the name in Bengali.
     *
     * @return string
     */
    public function inBengali() : string
    {
        return $this->getName('bn');
    }

    /**
     * Function to retrieve the name in Bosnian.
     *
     * @return string
     */
    public function inBosnian() : string
    {
        return $this->getName('bs');
    }

    /**
     * Function to retrieve the name in Bulgarian.
     *
     * @return string
     */
    public function inBulgarian() : string
    {
        return $this->getName('bg');
    }

    /**
     * Function to retrieve the name in Catalan.
     *
     * @return string
     */
    public function inCatalan() : string
    {
        return $this->getName('ca');
    }

    /**
     * Function to retrieve the name in Cebuano.
     *
     * @return string
     */
    public function inCebuano() : string
    {
        return $this->getName('ceb');
    }

    /**
     * Function to retrieve the name in Chichewa.
     *
     * @return string
     */
    public function inChichewa() : string
    {
        return $this->getName('ny');
    }

    /**
     * Function to retrieve the name in Chinese (Simplified).
     *
     * @return string
     */
    public function inSimplifiedChinese() : string
    {
        return $this->getName('zh_CN');
    }

    /**
     * Function to retrieve the name in Chinese (Traditional).
     *
     * @return string
     */
    public function inTraditionalChinese() : string
    {
        return $this->getName('zh_TW');
    }

    /**
     * Function to retrieve the name in Corsican.
     *
     * @return string
     */
    public function inCorsican() : string
    {
        return $this->getName('co');
    }

    /**
     * Function to retrieve the name in Croatian.
     *
     * @return string
     */
    public function inCroatian() : string
    {
        return $this->getName('hr');
    }

    /**
     * Function to retrieve the name in Czech.
     *
     * @return string
     */
    public function inCzech() : string
    {
        return $this->getName('cs');
    }

    /**
     * Function to retrieve the name in Danish.
     *
     * @return string
     */
    public function inDanish() : string
    {
        return $this->getName('da');
    }

    /**
     * Function to retrieve the name in Dutch.
     *
     * @return string
     */
    public function inDutch() : string
    {
        return $this->getName('nl');
    }

    /**
     * Function to retrieve the name in English.
     *
     * @return string
     */
    public function inEnglish() : string
    {
        return $this->getName('en');
    }

    /**
     * Function to retrieve the name in Esperanto.
     *
     * @return string
     */
    public function inEsperanto() : string
    {
        return $this->getName('eo');
    }

    /**
     * Function to retrieve the name in Estonian.
     *
     * @return string
     */
    public function inEstonian() : string
    {
        return $this->getName('et');
    }

    /**
     * Function to retrieve the name in Filipino.
     *
     * @return string
     */
    public function inFilipino() : string
    {
        return $this->getName('tl');
    }

    /**
     * Function to retrieve the name in Finnish.
     *
     * @return string
     */
    public function inFinnish() : string
    {
        return $this->getName('fi');
    }

    /**
     * Function to retrieve the name in French.
     *
     * @return string
     */
    public function inFrench() : string
    {
        return $this->getName('fr');
    }

    /**
     * Function to retrieve the name in Frisian.
     *
     * @return string
     */
    public function inFrisian() : string
    {
        return $this->getName('fy');
    }

    /**
     * Function to retrieve the name in Galician.
     *
     * @return string
     */
    public function inGalician() : string
    {
        return $this->getName('gl');
    }

    /**
     * Function to retrieve the name in Georgian.
     *
     * @return string
     */
    public function inGeorgian() : string
    {
        return $this->getName('ka');
    }

    /**
     * Function to retrieve the name in German.
     *
     * @return string
     */
    public function inGerman() : string
    {
        return $this->getName('de');
    }

    /**
     * Function to retrieve the name in Greek.
     *
     * @return string
     */
    public function inGreek() : string
    {
        return $this->getName('el');
    }

    /**
     * Function to retrieve the name in Gujarati.
     *
     * @return string
     */
    public function inGujarati() : string
    {
        return $this->getName('gu');
    }

    /**
     * Function to retrieve the name in Haitian Creole.
     *
     * @return string
     */
    public function inHaitianCreole() : string
    {
        return $this->getName('ht');
    }

    /**
     * Function to retrieve the name in Hausa.
     *
     * @return string
     */
    public function inHausa() : string
    {
        return $this->getName('ha');
    }

    /**
     * Function to retrieve the name in Hawaiian.
     *
     * @return string
     */
    public function inHawaiian() : string
    {
        return $this->getName('haw');
    }

    /**
     * Function to retrieve the name in Hebrew.
     *
     * @return string
     */
    public function inHebrew() : string
    {
        return $this->getName('iw');
    }

    /**
     * Function to retrieve the name in Hindi.
     *
     * @return string
     */
    public function inHindi() : string
    {
        return $this->getName('hi');
    }

    /**
     * Function to retrieve the name in Hmong.
     *
     * @return string
     */
    public function inHmong() : string
    {
        return $this->getName('hmn');
    }

    /**
     * Function to retrieve the name in Hungarian.
     *
     * @return string
     */
    public function inHungarian() : string
    {
        return $this->getName('hu');
    }

    /**
     * Function to retrieve the name in Icelandic.
     *
     * @return string
     */
    public function inIcelandic() : string
    {
        return $this->getName('is');
    }

    /**
     * Function to retrieve the name in Igbo.
     *
     * @return string
     */
    public function inIgbo() : string
    {
        return $this->getName('ig');
    }

    /**
     * Function to retrieve the name in Indonesian.
     *
     * @return string
     */
    public function inIndonesian() : string
    {
        return $this->getName('id');
    }

    /**
     * Function to retrieve the name in Irish.
     *
     * @return string
     */
    public function inIrish() : string
    {
        return $this->getName('ga');
    }

    /**
     * Function to retrieve the name in Italian.
     *
     * @return string
     */
    public function inItalian() : string
    {
        return $this->getName('it');
    }

    /**
     * Function to retrieve the name in Japanese.
     *
     * @return string
     */
    public function inJapanese() : string
    {
        return $this->getName('ja');
    }

    /**
     * Function to retrieve the name in Javanese.
     *
     * @return string
     */
    public function inJavanese() : string
    {
        return $this->getName('jw');
    }

    /**
     * Function to retrieve the name in Kannada.
     *
     * @return string
     */
    public function inKannada() : string
    {
        return $this->getName('kn');
    }

    /**
     * Function to retrieve the name in Kazakh.
     *
     * @return string
     */
    public function inKazakh() : string
    {
        return $this->getName('kk');
    }

    /**
     * Function to retrieve the name in Khmer.
     *
     * @return string
     */
    public function inKhmer() : string
    {
        return $this->getName('km');
    }

    /**
     * Function to retrieve the name in Korean.
     *
     * @return string
     */
    public function inKorean() : string
    {
        return $this->getName('ko');
    }

    /**
     * Function to retrieve the name in Kurdish (Kurmanji).
     *
     * @return string
     */
    public function inKurmanjiKurdish() : string
    {
        return $this->getName('ku');
    }

    /**
     * Function to retrieve the name in Kyrgyz.
     *
     * @return string
     */
    public function inKyrgyz() : string
    {
        return $this->getName('ky');
    }

    /**
     * Function to retrieve the name in Lao.
     *
     * @return string
     */
    public function inLao() : string
    {
        return $this->getName('lo');
    }

    /**
     * Function to retrieve the name in Latin.
     *
     * @return string
     */
    public function inLatin() : string
    {
        return $this->getName('la');
    }

    /**
     * Function to retrieve the name in Latvian.
     *
     * @return string
     */
    public function inLatvian() : string
    {
        return $this->getName('lv');
    }

    /**
     * Function to retrieve the name in Lithuanian.
     *
     * @return string
     */
    public function inLithuanian() : string
    {
        return $this->getName('lt');
    }

    /**
     * Function to retrieve the name in Luxembourgish.
     *
     * @return string
     */
    public function inLuxembourgish() : string
    {
        return $this->getName('lb');
    }

    /**
     * Function to retrieve the name in Macedonian.
     *
     * @return string
     */
    public function inMacedonian() : string
    {
        return $this->getName('mk');
    }

    /**
     * Function to retrieve the name in Malagasy.
     *
     * @return string
     */
    public function inMalagasy() : string
    {
        return $this->getName('mg');
    }

    /**
     * Function to retrieve the name in Malay.
     *
     * @return string
     */
    public function inMalay() : string
    {
        return $this->getName('ms');
    }

    /**
     * Function to retrieve the name in Malayalam.
     *
     * @return string
     */
    public function inMalayalam() : string
    {
        return $this->getName('ml');
    }

    /**
     * Function to retrieve the name in Maltese.
     *
     * @return string
     */
    public function inMaltese() : string
    {
        return $this->getName('mt');
    }

    /**
     * Function to retrieve the name in Maori.
     *
     * @return string
     */
    public function inMaori() : string
    {
        return $this->getName('mi');
    }

    /**
     * Function to retrieve the name in Marathi.
     *
     * @return string
     */
    public function inMarathi() : string
    {
        return $this->getName('mr');
    }

    /**
     * Function to retrieve the name in Mongolian.
     *
     * @return string
     */
    public function inMongolian() : string
    {
        return $this->getName('mn');
    }

    /**
     * Function to retrieve the name in Myanmar (Burmese).
     *
     * @return string
     */
    public function inBurmeseMyanmar() : string
    {
        return $this->getName('my');
    }

    /**
     * Function to retrieve the name in Nepali.
     *
     * @return string
     */
    public function inNepali() : string
    {
        return $this->getName('ne');
    }

    /**
     * Function to retrieve the name in Norwegian.
     *
     * @return string
     */
    public function inNorwegian() : string
    {
        return $this->getName('no');
    }

    /**
     * Function to retrieve the name in Pashto.
     *
     * @return string
     */
    public function inPashto() : string
    {
        return $this->getName('ps');
    }

    /**
     * Function to retrieve the name in Persian.
     *
     * @return string
     */
    public function inPersian() : string
    {
        return $this->getName('fa');
    }

    /**
     * Function to retrieve the name in Polish.
     *
     * @return string
     */
    public function inPolish() : string
    {
        return $this->getName('pl');
    }

    /**
     * Function to retrieve the name in Portuguese.
     *
     * @return string
     */
    public function inPortuguese() : string
    {
        return $this->getName('pt');
    }

    /**
     * Function to retrieve the name in Punjabi.
     *
     * @return string
     */
    public function inPunjabi() : string
    {
        return $this->getName('pa');
    }

    /**
     * Function to retrieve the name in Romanian.
     *
     * @return string
     */
    public function inRomanian() : string
    {
        return $this->getName('ro');
    }

    /**
     * Function to retrieve the name in Russian.
     *
     * @return string
     */
    public function inRussian() : string
    {
        return $this->getName('ru');
    }

    /**
     * Function to retrieve the name in Samoan.
     *
     * @return string
     */
    public function inSamoan() : string
    {
        return $this->getName('sm');
    }

    /**
     * Function to retrieve the name in Scots Gaelic.
     *
     * @return string
     */
    public function inScotsGaelic() : string
    {
        return $this->getName('gd');
    }

    /**
     * Function to retrieve the name in Serbian.
     *
     * @return string
     */
    public function inSerbian() : string
    {
        return $this->getName('sr');
    }

    /**
     * Function to retrieve the name in Sesotho.
     *
     * @return string
     */
    public function inSesotho() : string
    {
        return $this->getName('st');
    }

    /**
     * Function to retrieve the name in Shona.
     *
     * @return string
     */
    public function inShona() : string
    {
        return $this->getName('sn');
    }

    /**
     * Function to retrieve the name in Sindhi.
     *
     * @return string
     */
    public function inSindhi() : string
    {
        return $this->getName('sd');
    }

    /**
     * Function to retrieve the name in Sinhala.
     *
     * @return string
     */
    public function inSinhala() : string
    {
        return $this->getName('si');
    }

    /**
     * Function to retrieve the name in Slovak.
     *
     * @return string
     */
    public function inSlovak() : string
    {
        return $this->getName('sk');
    }

    /**
     * Function to retrieve the name in Slovenian.
     *
     * @return string
     */
    public function inSlovenian() : string
    {
        return $this->getName('sl');
    }

    /**
     * Function to retrieve the name in Somali.
     *
     * @return string
     */
    public function inSomali() : string
    {
        return $this->getName('so');
    }

    /**
     * Function to retrieve the name in Spanish.
     *
     * @return string
     */
    public function inSpanish() : string
    {
        return $this->getName('es');
    }

    /**
     * Function to retrieve the name in Sundanese.
     *
     * @return string
     */
    public function inSundanese() : string
    {
        return $this->getName('su');
    }

    /**
     * Function to retrieve the name in Swahili.
     *
     * @return string
     */
    public function inSwahili() : string
    {
        return $this->getName('sw');
    }

    /**
     * Function to retrieve the name in Swedish.
     *
     * @return string
     */
    public function inSwedish() : string
    {
        return $this->getName('sv');
    }

    /**
     * Function to retrieve the name in Tajik.
     *
     * @return string
     */
    public function inTajik() : string
    {
        return $this->getName('tg');
    }

    /**
     * Function to retrieve the name in Tamil.
     *
     * @return string
     */
    public function inTamil() : string
    {
        return $this->getName('ta');
    }

    /**
     * Function to retrieve the name in Telugu.
     *
     * @return string
     */
    public function inTelugu() : string
    {
        return $this->getName('te');
    }

    /**
     * Function to retrieve the name in Thai.
     *
     * @return string
     */
    public function inThai() : string
    {
        return $this->getName('th');
    }

    /**
     * Function to retrieve the name in Turkish.
     *
     * @return string
     */
    public function inTurkish() : string
    {
        return $this->getName('tr');
    }

    /**
     * Function to retrieve the name in Ukrainian.
     *
     * @return string
     */
    public function inUkrainian() : string
    {
        return $this->getName('uk');
    }

    /**
     * Function to retrieve the name in Urdu.
     *
     * @return string
     */
    public function inUrdu() : string
    {
        return $this->getName('ur');
    }

    /**
     * Function to retrieve the name in Uzbek.
     *
     * @return string
     */
    public function inUzbek() : string
    {
        return $this->getName('uz');
    }

    /**
     * Function to retrieve the name in Vietnamese.
     *
     * @return string
     */
    public function inVietnamese() : string
    {
        return $this->getName('vi');
    }

    /**
     * Function to retrieve the name in Welsh.
     *
     * @return string
     */
    public function inWelsh() : string
    {
        return $this->getName('cy');
    }

    /**
     * Function to retrieve the name in Xhosa.
     *
     * @return string
     */
    public function inXhosa() : string
    {
        return $this->getName('xh');
    }

    /**
     * Function to retrieve the name in Yiddish.
     *
     * @return string
     */
    public function inYiddish() : string
    {
        return $this->getName('yi');
    }

    /**
     * Function to retrieve the name in Yoruba.
     *
     * @return string
     */
    public function inYoruba() : string
    {
        return $this->getName('yo');
    }

    /**
     * Function to retrieve the name in Zulu.
     *
     * @return string
     */
    public function inZulu() : string
    {
        return $this->getName('zu');
    }
}

chinleung / php-weekday

Push — master ( 02fcb9...4774b2 )

PhpWeekday::parseName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like
