CMPayments\SchemaValidator\Validators\ErrorTrait

Complexity

Total Complexity

13

Size/Duplication

Total Lines	134
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	3

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	getErrors()	0	4	1
A	addError()	0	5	1
A	isValid()	0	4	1
A	getPreposition()	0	17	4
A	conjugationToBe()	0	5	2
A	conjugationObject()	0	4	2
A	numberToOrdinal()	0	9	2

<?php namespace CMPayments\SchemaValidator\Validators;

use CMPayments\Cache\Cache;
use CMPayments\SchemaValidator\BaseValidator;
use CMPayments\SchemaValidator\Exceptions\ValidateException;
use CMPayments\SchemaValidator\Exceptions\ValidateSchemaException;

/**
 * Class ErrorTrait
 *
 * @package CMPayments\SchemaValidator\Validators
 * @Author  Boy Wijnmaalen <boy.wijnmaalen@cmtelecom.com>
 */
trait ErrorTrait
{
    /**
     * @var null|Cache
     */
    protected $cache;

    /**
     * @var array
     */
    protected $errors = [];

    /**
     * @var array
     */
    private $stringifiedOrdinals = ['th', 'st', 'nd', 'rd'];

    /**
     * @var string
     */
    private $prepositionDefault = 'a';

    /**
     * @var array
     */
    private $prepositions = [
        BaseValidator::_ARRAY  => 'an',
        BaseValidator::BOOLEAN => 'a',
        BaseValidator::CLOSURE => 'a',
        BaseValidator::INTEGER => 'an',
        BaseValidator::NUMBER  => 'a',
        BaseValidator::OBJECT  => 'an',
        BaseValidator::STRING  => 'a',
        BaseValidator::_NULL   => ''
    ];

    /**
     * @return array
     */
    public function getErrors()
    {
        return $this->errors;
    }

    /**
     * @param int   $code
     * @param array $args
     */
    protected function addError($code, array $args = [])
    {
        $message        = (new ValidateException($code, $args))->getMessage();
        $this->errors[] = compact('code', 'args', 'message');
    }

    /**
     * Returns boolean on whether the JSON is valid or not
     *
     * @return bool
     */
    public function isValid()
    {
        return (count($this->getErrors()) === 0);
    }

    /**
     * Returns the preposition for a specific type
     *
     * @param $type
     *
     * @return mixed
     * @throws ValidateSchemaException
     */
    public function getPreposition($type)
    {
        $type = strtolower($type);

        if (!isset($this->prepositions[$type])) {

            // output exception when $this->config['debug'] === true

36% of this comment could be valid code. Did you maybe forget this after debugging?

            if (($this->cache instanceof Cache) && $this->cache->getDebug()) {

                throw new ValidateSchemaException(ValidateSchemaException::ERROR_INPUT_IS_NOT_A_VALID_PREPOSITION, $type);

$type is of type string, but the function expects a array.

            } else {
                return $this->prepositionDefault;
            }
        }

        return $this->prepositions[$type];
    }

    /**
     * Returns a valid conjugation of the verb 'to be'
     *
     * @param integer $count
     *
     * @return string
     */
    public function conjugationToBe($count)
    {
        // 3rd singular or 3rd plural
        return ($count === 1) ? 'is' : 'are';
    }

    /**
     * Returns a valid representation of 'items' (or other value)
     *
     * @param        integer $count
     * @param string $single
     * @param string $plural
     *
     * @return string
     */
    public function conjugationObject($count, $single = 'item', $plural = 'items')
    {
        return ($count === 1) ? $single : $plural;
    }

    /**
     * Converts a number to a ordinal
     *
     * @param int $number
     *
     * @return string
     */
    public function numberToOrdinal($number)
    {
        if (in_array(($lastDigit = (int)substr($number, -1)), [1, 2, 3])) {

            return $number . $this->stringifiedOrdinals[$lastDigit];
        }

        return $number . $this->stringifiedOrdinals[0];
    }
}