Country

Complexity

Total Complexity

9

Size/Duplication

Total Lines	119
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	assignResult()	0	5	1
A	getName()	0	4	1
A	getISO()	0	4	1
A	getFlagLiteral()	0	4	1
A	getCountries()	0	4	1
A	getCountriesWithISO()	0	8	1
A	getFlagCssClass()	0	4	1
A	getIdFromISO()	0	4	1
A	getQueryBuilder()	0	9	1

<?php
/**
 * This file contains functionality relating to the countries players are allowed to set in their profiles as their location
 *
 * @package    BZiON\Models
 * @license    https://github.com/allejo/bzion/blob/master/LICENSE.md GNU General Public License Version 3
 */

/**
 * A country
 * @package    BZiON\Models
 */
class Country extends Model
{
    /**
     * The name of the country
     * @var string
     */
    protected $name;

    /**
     * The ISO code of the country
     * @var string
     */
    protected $iso;

    /**
     * The name of the database table used for queries
     */
    const TABLE = "countries";

    /**
     * {@inheritdoc}
     */
    protected function assignResult($country)
    {
        $this->name = $country['name'];
        $this->iso = $country['iso'];
    }

    /**
     * Get the name of the country in the default language
     *
     * @return string The name of the country
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * Get the ISO code of a country
     *
     * @return string The ISO code of the country
     */
    public function getISO()
    {
        return $this->iso;
    }

    /**
     * Get the HTML to display a specific flag
     *
     * @return string HTML to generate a flag
     */
    public function getFlagLiteral()
    {
        return '<div class="c-flag ' . $this->getFlagCssClass() . '" title="' . $this->getName() . '"></div>';
    }

    /**
     * Get all the countries in the database
     *
     * @return Country[] An array of country objects
     */
    public static function getCountries()
    {
        return self::arrayIdToModel(self::fetchIds());
    }

    /**
     * Get an associative array with country ISO code as keys and country names
     * as values
     *
     * @return array
     */
    public static function getCountriesWithISO()
    {
        $result = Database::getInstance()->query(
            'SELECT iso, name from ' . static::TABLE
        );

        return array_column($result, 'name', 'iso');
    }

    /**
     * Get the country's flag's CSS class
     *
     * @return string The URL to the country's flag
     */
    private function getFlagCssClass()
    {
        return "c-flag--" . strtolower($this->getISO());
    }

    /**
     * Given a country's ISO, get its ID
     *
     * @param  string $iso The two-letter ISO code of the country
     * @return int    The country's database ID
     */
    public static function getIdFromISO($iso)
    {
        return self::fetchIdFrom($iso, 'iso');
    }

    /**
     * Get a query builder for countries
     *
     * @return QueryBuilder
     */
    public static function getQueryBuilder()
    {
        return new QueryBuilder('Country', array(
            'columns' => array(
                'name' => 'name',
            ),
            'name' => 'name',
        ));
    }
}