CountryFlagProvider.php

Go to the documentation of this file.

<?php
/*
 You may not change or alter any portion of this comment or credits
 of supporting developers from this source code or any supporting source code
 which is considered copyrighted (c) material of the original comment or credit authors.

 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
*/

use Xoops\Core\Service\AbstractContract;
use Xoops\Core\Service\Contract\CountryflagInterface;
use Xoops\Core\Service\Response;
use Xoops\Html\Img;

class CountryFlagProvider extends AbstractContract implements CountryflagInterface
{
    protected $flagSource = 'media/xoops/images/flags/';

    public function getName()
    {
        return 'system';
    }

    public function getDescription()
    {
        return 'Built in CountryFlag provider';
    }


    private function getFlagUrl($countryCode, $size)
    {
        $size = strtolower(substr($size, 0, 1));
        $sizeDir = '64';
        switch ($size) {
            case 's':
                $sizeDir = '16';
                break;
            case 'm':
                $sizeDir = '32';
                break;
        }

        $xoops = \Xoops::getInstance();
        $flagDir = $this->flagSource . $sizeDir . '/';
        $flagFile = $flagDir . $countryCode . '.png';

        $file = $xoops->path($flagFile);
        // switch to unknown if file is not readable
        if (!is_readable($file)) {
            $flagFile = $flagDir . '_unknown.png';
        }
        $url = $xoops->url($flagFile);
        return $url;
    }

    public function getImgUrl(Response $response, $countryCode, $size = 'large')
    {
        $response->setValue($this->getFlagUrl($countryCode, $size));
    }

    public function getImgTag(
        Response $response,
        $countryCode,
        $attributes = array(),
        $size = 'large'
    ) {
        $url = $this->getFlagUrl($countryCode, $size);

        $imgTag = new Img(array('src' => $url, 'alt' => $countryCode));
        $imgTag->setAttributes($attributes);
        $response->setValue($imgTag->render());
    }
}