Mailcode\Mailcode_Commands_Command_ShowPhone

Complexity

Total Complexity

15

Size/Duplication

Total Lines	151
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getLabel()	0	3	1
A	getName()	0	3	1
A	validateSyntax_source_format()	0	13	2
A	getSupportedCountries()	0	23	3
A	getValidations()	0	8	1
A	validateSyntax_country_code()	0	11	2
A	loadData()	0	24	4
A	getSourceFormat()	0	3	1

<?php
/**
 * File containing the {@see Mailcode_Commands_Command_ShowPhone} class.
 *
 * @package Mailcode
 * @subpackage Commands
 * @see Mailcode_Commands_Command_ShowPhone
 */

declare(strict_types=1);

namespace Mailcode;

use AppUtils\FileHelper;
use AppUtils\FileHelper_Exception;

/**
 * Mailcode command: show a phone number variable value, in E164 format.
 *
 * @package Mailcode
 * @subpackage Commands
 * @author Sebastian Mordziol <s.mordziol@mistralys.eu>
 */
class Mailcode_Commands_Command_ShowPhone extends Mailcode_Commands_ShowBase
{
    public const VALIDATION_SOURCE_FORMAT_MISSING = 84001;
    public const VALIDATION_INVALID_COUNTRY = 84002;

    /**
     * Two-letter country code, uppercase.
     * @var string
     */
    protected $sourceFormat = '';

    /**
     * List of supported countries in the libphonenumber package.
     * NOTE: This can be extracted automatically using the provided PHP script.
     *
     * @var array<string,Mailcode_Commands_Command_ShowPhone_Number>
     *
     * @see /tools/extractPhoneCountries.php
     */
    protected static $supportedCountries = array();

    /**
     * @var bool
     */
    protected static $countriesLoaded = false;

    public function getName() : string
    {
        return 'showphone';
    }

    public function getLabel() : string
    {
        return t('Show phone number variable');
    }

    protected function getValidations() : array
    {
        return array(
            Mailcode_Interfaces_Commands_Validation_Variable::VALIDATION_NAME_VARIABLE,
            'source_format',
            'country_code',
            Mailcode_Interfaces_Commands_Validation_URLEncode::VALIDATION_NAME_URLENCODE,
            Mailcode_Interfaces_Commands_Validation_URLDecode::VALIDATION_NAME_URLDECODE
        );
    }

    protected function validateSyntax_source_format(): void
    {
        $val = $this->validator->createStringLiteral();

        if($val->isValid())
        {
            $this->sourceFormat = strtoupper($val->getToken()->getText());
            return;
        }

        $this->validationResult->makeError(
            t('No country code for the source phone format specified.'),
            self::VALIDATION_SOURCE_FORMAT_MISSING
        );
    }

    /**
     * Validates the specified country code to ensure it is one of the
     * supported countries.
     *
     * @throws FileHelper_Exception
     */
    protected function validateSyntax_country_code(): void
    {
        $countries = self::getSupportedCountries();

        if(isset($countries[$this->sourceFormat])) {
            return;
        }

        $this->validationResult->makeError(
            t('The country code %1$s is not supported for phone number conversion.', '<code>'.$this->sourceFormat.'</code>'),
            self::VALIDATION_INVALID_COUNTRY
        );
    }

    /**
     * Retrieves the list of countries supported for phone number conversions,
     * as an associative array with uppercase country code => number class pairs.
     *
     * @return array<string,Mailcode_Commands_Command_ShowPhone_Number>
     * @throws FileHelper_Exception
     */
    public static function getSupportedCountries() : array
    {
        if(self::$countriesLoaded) {
            return self::$supportedCountries;
        }

        self::$countriesLoaded = true;

        $data = self::loadData();

        foreach($data as $code => $def)
        {
            $code = (string)$code;

            self::$supportedCountries[$code] = new Mailcode_Commands_Command_ShowPhone_Number(
                $code,
                $def['label'],
                $def['local'],
                $def['international']
            );
        }

        return self::$supportedCountries;
    }

    /**
     * @return array<string,array{label:string,local:string,international:string}>
     * @throws FileHelper_Exception
     */
    private static function loadData() : array
    {
        $data = FileHelper::parseJSONFile(__DIR__.'/ShowPhone/numbers.json');
        $result = array();

        foreach($data as $idx => $def)
        {
            if(!is_array($def) || !is_string($idx))
            {
                continue;
            }

            $label = $def['label'] ?? '';
            $local = $def['local'] ?? '';
            $int = $def['international'] ?? '';

            $result[$idx] = array(
                'label' => (string)$label,
                'local' => (string)$local,
                'international' => (string)$int
            );
        }

        return $result;
    }

    /**
     * @return string Two-letter country code, uppercase.
     */
    public function getSourceFormat() : string
    {
        return $this->sourceFormat;
    }
}