Kerox\Messenger\Helper\ValidatorTrait

Complexity

Total Complexity

25

Size/Duplication

Total Lines	139
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Test Coverage

Coverage

97.87%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	isValidColor()	0	6	2
A	isValidString()	0	6	2
A	isValidUrl()	0	6	2
A	isValidLocale()	0	6	2
A	isValidCountry()	0	6	2
A	isValidDateTime()	0	6	2
A	isValidArray()	0	10	4
A	isValidCurrency()	0	6	2
A	isValidExtension()	0	7	3
A	isValidButtons()	0	13	4

<?php

namespace Kerox\Messenger\Helper;

use InvalidArgumentException;
use Kerox\Messenger\Model\Common\Button\AbstractButton;

trait ValidatorTrait
{

    /**
     * @param string $value
     * @return void
     * @throws \InvalidArgumentException
     */
    protected function isValidColor(string $value)
    {
        if (!preg_match('/^#[A-Fa-f0-9]{6}$/', $value)) {
            throw new InvalidArgumentException("The color must be expressed in #rrggbb format.");
        }
    }

    /**
     * @param string $value
     * @param int $length
     * @return void
     * @throws \InvalidArgumentException
     */
    protected function isValidString(string $value, int $length = 20)
    {
        if (mb_strlen($value) > $length) {
            throw new InvalidArgumentException("String should not exceed {$length} characters.");
        }
    }

    /**
     * @param string $value
     * @return void
     * @throws \InvalidArgumentException
     */
    protected function isValidUrl(string $value)
    {
        if (!preg_match('/^https?:\/\/(www\.)?[-a-zA-Z0-9@:%._\+~#=]{1,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&\/=]*)$/', $value)) {
            throw new InvalidArgumentException("{$value} is not a valid url.");
        }
    }

    /**
     * @param string $value
     * @return void
     * @throws \InvalidArgumentException
     */
    protected function isValidLocale(string $value)
    {
        if (!preg_match('/^[a-z]{2}_[A-Z]{2}$/', $value)) {
            throw new InvalidArgumentException("{$value} is not valid. Locale must be in ISO-639-1 and ISO-3166-1 format like fr_FR.");
        }
    }

    /**
     * @param string $value
     * @return void
     * @throws \InvalidArgumentException
     */
    protected function isValidCountry(string $value)
    {
        if (!preg_match('/^[A-Z]{2}$/', $value)) {
            throw new InvalidArgumentException("{$value} is not valid. Country must be in ISO 3166 Alpha-2 format like FR.");
        }
    }

    /**
     * @param string $value
     * @return void
     * @throws \InvalidArgumentException
     */
    protected function isValidDateTime(string $value)
    {
        if (!preg_match('/^(\d{4})-(0[1-9]|1[0-2])-([12]\d|0[1-9]|3[01])T(0[0-9]|1\d|2[0-3]):([0-5]\d)$/', $value)) {
            throw new InvalidArgumentException("{$value} is not valid. DateTime must be in ISO-8601 AAAA-MM-JJThh:mm format");
        }
    }

    /**
     * @param array $array
     * @param int $maxSize
     * @param int $minSize
     * @return void
     * @throws \InvalidArgumentException
     */
    protected function isValidArray(array $array, int $maxSize, int $minSize = null)
    {
        $countArray = count($array);
        if ($minSize !== null && $countArray < $minSize) {
            throw new InvalidArgumentException("The minimum number of items for this array is {$minSize}.");
        }
        if ($countArray > $maxSize) {
            throw new InvalidArgumentException("The maximum number of items for this array is {$maxSize}.");
        }
    }

    /**
     * @param string $value
     * @return void
     * @throws \InvalidArgumentException
     */
    protected function isValidCurrency(string $value)
    {
        if (!preg_match('/^SGD|RON|EUR|TRY|SEK|ZAR|HKD|CHF|NIO|JPY|ISK|TWD|NZD|CZK|AUD|THB|BOB|BRL|MXN|USD|ILS|HNL|MOP|COP|UYU|CRC|DKK|QAR|PYG|CAD|INR|KRW|GTQ|AED|VEF|SAR|NOK|CNY|ARS|PLN|GBP|PEN|PHP|VND|RUB|HUF|MYR|CLP|IDR$/', $value)) {
            throw new InvalidArgumentException("{$value} is not a valid currency. Currency must be in ISO-4217-3 format.");
        }
    }

    /**
     * @param string $filename
     * @param array $allowedExtension
     * @return void
     * @throws \InvalidArgumentException
     */
    protected function isValidExtension(string $filename, array $allowedExtension)
    {
        $ext = pathinfo($filename, PATHINFO_EXTENSION);
        if (empty($ext) || !in_array($ext, $allowedExtension)) {
            throw new InvalidArgumentException("{$filename} doesn't have a valid extension. Allowed extensions are " . implode(', ', $allowedExtension));
        }
    }

    /**
     * @param \Kerox\Messenger\Model\Common\Button\AbstractButton[] $buttons
     * @param array $allowedButtonsType
     * @return void
     */
    protected function isValidButtons(array $buttons, array $allowedButtonsType)
    {
        /** @var \Kerox\Messenger\Model\Common\Button\AbstractButton $button */
        foreach ($buttons as $button) {
            if (!$button instanceof AbstractButton) {
                throw new \InvalidArgumentException('Array can only contain instance of AbstractButton.');
            }

            if (!in_array($button->getType(), $allowedButtonsType)) {
                throw new \InvalidArgumentException('Buttons can only be an instance of ' . implode(', ', $allowedButtonsType));
            }
        }
    }
}