Fenos\Notifynder\Builder\BuilderRules

Complexity

Total Complexity

17

Size/Duplication

Total Lines	138
Duplicated Lines	6.52 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes	10
Bugs	4	Features	2

9 Methods

Rating	Name	Duplication	Size	Complexity
A	isString()	0	8	2
A	isCarbon()	0	6	2
A	isNumeric()	0	8	2
A	getRequiredFields()	0	4	1
A	hasRequiredFields()	0	10	3
A	isRequiredField()	0	4	1
A	isReadyArrToFormatInJson()	0	13	3
A	isAssociativeArr()	0	4	1
A	isMultidimensionalArray()	9	9	2

<?php namespace Fenos\Notifynder\Builder;

use InvalidArgumentException;
use Carbon\Carbon;

/**
 * Class BuilderRules
 *
 * Simple trait that define the rules that
 * the builder has to match. It required mandatory
 * fields listed in the $requiredFields property
 *
 * @package Fenos\Notifynder\Builder
 */
trait BuilderRules
{

    /**
     * @var array
     */
    private $requiredFields = ['from_id','to_id','url','category_id'];

    /**
     * Value has to be a string
     *
     * @param $value
     * @return bool
     */
    protected function isString($value)
    {
        if (! is_string($value)) {
            throw new InvalidArgumentException("The value Passed is not a string");
        }

        return true;
    }

    /**
     * Value has to be a valid Carbon Instance
     *
     * @param $value
     * @return bool | InvalidArgumentException
     */
    protected function isCarbon($value)
    {
        if($value instanceof Carbon) return true;

        throw new InvalidArgumentException("The value Passed has to be an instance of Carbon\Carbon");
    }

    /**
     * Value has to be numeric
     *
     * @param $value
     * @return bool
     */
    protected function isNumeric($value)
    {
        if (! is_numeric($value)) {
            throw new InvalidArgumentException("The value Passed must be a number");
        }

        return true;
    }

    /**
     * Returns all required fields including the config ones
     *
     * @return array
     */
    public function getRequiredFields()
    {
        return array_unique($this->requiredFields + config('notifynder.additional_fields.required'));
    }

    /**
     * Check that the builder has
     * the required field to send the
     * notifications correctly
     *
     * @param $array
     * @return bool
     */
    public function hasRequiredFields($array)
    {
        foreach ($this->getRequiredFields() as $field) {
            if (! array_key_exists($field, $array)) {
                return false;
            }
        }

        return true;
    }

    /**
     * Check if is a required field
     *
     * @param $offset
     * @return bool
     */
    public function isRequiredField($offset)
    {
        return (in_array($offset,$this->getRequiredFields()));
    }

    /**
     * Check if the array passed is
     * multidimensional
     *
     * @param $arr
     * @return bool
     */
    protected function isReadyArrToFormatInJson(array $arr)
    {
         if ($this->isAssociativeArr($arr)) {
             return true;
         }

        if (count($arr) > 0) {
            $error = "The 'extra' value must to be an associative array";
            throw new InvalidArgumentException($error);
        }

        return false;
    }

    /**
     * @param array $arr
     * @return bool
     */
    protected function isAssociativeArr(array $arr)
    {
        return array_keys($arr) !== range(0, count($arr) - 1);
    }

    /**
     * Check if the array is
     * multidimensional
     *
     * @param $arr
     * @return bool
     */
    public function isMultidimensionalArray($arr)

This method seems to be duplicated in your project.

    {
        $rv = array_filter($arr, 'is_array');
        if (count($rv) > 0) {
            return true;
        }

        return false;
    }
}