BuilderRules::getRequiredFields() - Code Metrics - Inspection of "#105 add config for additional fields" - fenos/Notifynder - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#106)

by Fabrizio

created 2016-04-19 21:13 UTC

BuilderRules::getRequiredFields() A

↳ Parent: BuilderRules

Complexity

Conditions	3
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
c	2
b	0
f	1
dl	0
loc	10
rs	9.4285
cc	3
eloc	6
nc	2
nop	0

<?php namespace Fenos\Notifynder\Builder;

use Illuminate\Contracts\Config\Repository;
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()
    {
        if (property_exists($this,'config') && $this->config instanceof Repository) {
            $customRequiredFields = $this->config->get('notifynder.additional_fields.required');
class MyClass { }

$x = new MyClass();
$x->foo = true;
        } else {
            $customRequiredFields = [];
        }

        return array_unique($this->requiredFields + $customRequiredFields);
    }

    /**
     * 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)

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

        return false;
    }
}


1		<?php namespace Fenos\Notifynder\Builder;
2
3		use Illuminate\Contracts\Config\Repository;
4		use InvalidArgumentException;
5		use Carbon\Carbon;
6
7		/**
8		* Class BuilderRules
9		*
10		* Simple trait that define the rules that
11		* the builder has to match. It required mandatory
12		* fields listed in the $requiredFields property
13		*
14		* @package Fenos\Notifynder\Builder
15		*/
16		trait BuilderRules
17		{
18
19		/**
20		* @var array
21		*/
22		private $requiredFields = ['from_id','to_id','url','category_id'];
23
24		/**
25		* Value has to be a string
26		*
27		* @param $value
28		* @return bool
29		*/
30		protected function isString($value)
31		{
32		if (! is_string($value)) {
33		throw new InvalidArgumentException("The value Passed is not a string");
34		}
35
36		return true;
37		}
38
39		/**
40		* Value has to be a valid Carbon Instance
41		*
42		* @param $value
43		* @return bool \| InvalidArgumentException
44		*/
45		protected function isCarbon($value)
46		{
47		if($value instanceof Carbon) return true;
48
49		throw new InvalidArgumentException("The value Passed has to be an instance of Carbon\Carbon");
50		}
51
52		/**
53		* Value has to be numeric
54		*
55		* @param $value
56		* @return bool
57		*/
58		protected function isNumeric($value)
59		{
60		if (! is_numeric($value)) {
61		throw new InvalidArgumentException("The value Passed must be a number");
62		}
63
64		return true;
65		}
66
67		/**
68		* Returns all required fields including the config ones
69		*
70		* @return array
71		*/
72		public function getRequiredFields()
73		{
74		if (property_exists($this,'config') && $this->config instanceof Repository) {
75		$customRequiredFields = $this->config->get('notifynder.additional_fields.required');
		0 ignored issues – show Bug introduced 2016-04-19 21:15 UTC by Report Bug Copy Issue Report The property `config` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
76		} else {
77		$customRequiredFields = [];
78		}
79
80		return array_unique($this->requiredFields + $customRequiredFields);
81		}
82
83		/**
84		* Check that the builder has
85		* the required field to send the
86		* notifications correctly
87		*
88		* @param $array
89		* @return bool
90		*/
91		public function hasRequiredFields($array)
92		{
93		foreach ($this->getRequiredFields() as $field) {
94		if (! array_key_exists($field, $array)) {
95		return false;
96		}
97		}
98
99		return true;
100		}
101
102		/**
103		* Check if is a required field
104		*
105		* @param $offset
106		* @return bool
107		*/
108		public function isRequiredField($offset)
109		{
110		return (in_array($offset,$this->getRequiredFields()));
111		}
112
113		/**
114		* Check if the array passed is
115		* multidimensional
116		*
117		* @param $arr
118		* @return bool
119		*/
120		protected function isReadyArrToFormatInJson(array $arr)
121		{
122		if ($this->isAssociativeArr($arr)) {
123		return true;
124		}
125
126		if (count($arr) > 0) {
127		$error = "The 'extra' value must to be an associative array";
128		throw new InvalidArgumentException($error);
129		}
130
131		return false;
132		}
133
134		/**
135		* @param array $arr
136		* @return bool
137		*/
138		protected function isAssociativeArr(array $arr)
139		{
140		return array_keys($arr) !== range(0, count($arr) - 1);
141		}
142
143		/**
144		* Check if the array is
145		* multidimensional
146		*
147		* @param $arr
148		* @return bool
149		*/
150	View Code Duplication	public function isMultidimensionalArray($arr)
		0 ignored issues – show Duplication introduced 2015-12-22 09:17 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
151		{
152		$rv = array_filter($arr, 'is_array');
153		if (count($rv) > 0) {
154		return true;
155		}
156
157		return false;
158		}
159		}
160

fenos / Notifynder

Pull Request — master (#106)

BuilderRules::getRequiredFields() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like