ValidateData::validateMethodHasDefinedArguments() - Code Metrics - MohannadNaj/smsa-sdk - Measure and Improve Code Quality continuously with Scrutinizer

ValidateData::validateMethodHasDefinedArguments() A
last analyzed 2018-01-10 04:36 UTC

↳ Parent: ValidateData

Complexity

Conditions	4
Paths	6

Size

Total Lines	18
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	4

Importance

Changes

Metric	Value
cc	4
eloc	10
nc	6
nop	2
dl	0
loc	18
ccs	13
cts	13
cp	1
crap	4
rs	9.2
c	0
b	0
f	0

<?php

namespace SmsaSDK\Concerns;

use ReflectionClass;
use SmsaSDK\Config;
use SmsaSDK\Exceptions\InvalidArgumentException;
use SmsaSDK\Exceptions\UndefinedMethodException;

trait ValidateData
{
    /**
     * validate
     * Insert description here.
     *
     * @param $arguments
     * @param $class
     *
     * @return
     */
    private function validate($arguments, $class)

    {
        $this->validateMethodExistance($class);

        $this->validateArgumentsType($arguments, $class);

        $this->reflection = new ReflectionClass($class);
class MyClass { }

$x = new MyClass();
$x->foo = true;

        $this->validateMethodHasDefinedArguments($arguments, $class);

        if ($this->nullValues === null) {
class MyClass { }

$x = new MyClass();
$x->foo = true;
            $this->validateMissingArguments($arguments, $class);
        }
    }

    /**
     * validateMissingArguments
     * Insert description here.
     *
     * @param $arguments
     * @param $class
     *
     * @return
     */
    private function validateMissingArguments($arguments, $class)
    {
        $missingArguments = [];
        $keys = array_keys($arguments);
        $commonKeys = array_keys(Config::getCommonData());
        $properties = $this->getReflectionProperties($this->reflection);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        foreach ($properties as $key) {
            if (!in_array($key, $keys) && !in_array($key, $commonKeys)) {
                $missingArguments[] = $key;
            }
        }

        if (count($missingArguments) > 0) {
            $classBaseName = $this->getBaseName($class);

            throw new InvalidArgumentException("calling the method [$classBaseName] some arguments are missing: [".implode(', ', $missingArguments).']. required arguments: ['.implode(', ', $properties).'].');
        }
    }

    /**
     * validateMethodHasDefinedArguments
     * Insert description here.
     *
     * @param $arguments
     * @param $class
     *
     * @return
     */
    private function validateMethodHasDefinedArguments($arguments, $class)
    {
        $unknownArguments = [];

        foreach ($arguments as $key => $value) {
            $setterMethod = $this->getSetterMethodFromKey($key);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            if (!$this->reflection->hasMethod($setterMethod)) {
                $unknownArguments[] = $key;
            }
        }

        if (count($unknownArguments) > 0) {
            $properties = $this->getReflectionProperties($this->reflection);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            $classBaseName = $this->getBaseName($class);

            throw new InvalidArgumentException("Argument passed to the method [$classBaseName] is not expected to this method. unknown arguments: [".implode(', ', $unknownArguments).']. required arguments: ['.implode(', ', $properties).'].');
        }
    }

    /**
     * validateArgumentsType
     * Insert description here.
     *
     * @param $arguments
     * @param $class
     *
     * @return
     */
    private function validateArgumentsType($arguments, $class)
    {
        $classBaseName = $this->getBaseName($class);

        if (!is_array($arguments)) {
            throw new InvalidArgumentException("Arguments passed to the method [$classBaseName] should be an array, ".gettype($arguments).' given');
        }
    }

    /**
     * validateMethodExistance
     * Insert description here.
     *
     * @param $class
     *
     * @return
     */
    private function validateMethodExistance($class)
    {
        if (!class_exists($class)) {
            $classBaseName = $this->getBaseName($class);

            throw new UndefinedMethodException("the method [$classBaseName] is not defined, there is no matching class handler at: $class");
        }
    }

    /**
     * getBaseName
     * Insert description here.
     *
     * @param $class
     *
     * @return
     */
    private function getBaseName($class)
    {
        return preg_replace('/.*\\\\/', '', $class);
    }
}


1		<?php
2
3		namespace SmsaSDK\Concerns;
4
5		use ReflectionClass;
6		use SmsaSDK\Config;
7		use SmsaSDK\Exceptions\InvalidArgumentException;
8		use SmsaSDK\Exceptions\UndefinedMethodException;
9
10		trait ValidateData
11		{
12		/**
13		* validate
14		* Insert description here.
15		*
16		* @param $arguments
17		* @param $class
18		*
19		* @return
20		*/
21	6	private function validate($arguments, $class)
		0 ignored issues – show Unused Code introduced 2018-01-10 02:45 UTC by Report Bug Copy Issue Report This method is not used, and could be removed. Loading history...
22		{
23	6	$this->validateMethodExistance($class);
24
25	5	$this->validateArgumentsType($arguments, $class);
26
27	5	$this->reflection = new ReflectionClass($class);
		0 ignored issues – show Bug introduced 2018-01-10 02:45 UTC by Report Bug Copy Issue Report The property `reflection` 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...
28
29	5	$this->validateMethodHasDefinedArguments($arguments, $class);
30
31	4	if ($this->nullValues === null) {
		0 ignored issues – show Bug introduced 2018-01-10 02:45 UTC by Report Bug Copy Issue Report The property `nullValues` 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...
32	4	$this->validateMissingArguments($arguments, $class);
33	2	}
34	3	}
35
36		/**
37		* validateMissingArguments
38		* Insert description here.
39		*
40		* @param $arguments
41		* @param $class
42		*
43		* @return
44		*/
45	4	private function validateMissingArguments($arguments, $class)
46		{
47	4	$missingArguments = [];
48	4	$keys = array_keys($arguments);
49	4	$commonKeys = array_keys(Config::getCommonData());
50	4	$properties = $this->getReflectionProperties($this->reflection);
		0 ignored issues – show Bug introduced 2018-01-10 02:45 UTC by Report Bug Copy Issue Report It seems like `getReflectionProperties()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
51
52	4	foreach ($properties as $key) {
53	4	if (!in_array($key, $keys) && !in_array($key, $commonKeys)) {
54	2	$missingArguments[] = $key;
55	2	}
56	4	}
57
58	4	if (count($missingArguments) > 0) {
59	2	$classBaseName = $this->getBaseName($class);
60
61	2	throw new InvalidArgumentException("calling the method [$classBaseName] some arguments are missing: [".implode(', ', $missingArguments).']. required arguments: ['.implode(', ', $properties).'].');
62		}
63	2	}
64
65		/**
66		* validateMethodHasDefinedArguments
67		* Insert description here.
68		*
69		* @param $arguments
70		* @param $class
71		*
72		* @return
73		*/
74	5	private function validateMethodHasDefinedArguments($arguments, $class)
75		{
76	5	$unknownArguments = [];
77
78	5	foreach ($arguments as $key => $value) {
79	4	$setterMethod = $this->getSetterMethodFromKey($key);
		0 ignored issues – show Bug introduced 2018-01-10 02:45 UTC by Report Bug Copy Issue Report It seems like `getSetterMethodFromKey()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
80	4	if (!$this->reflection->hasMethod($setterMethod)) {
81	1	$unknownArguments[] = $key;
82	1	}
83	5	}
84
85	5	if (count($unknownArguments) > 0) {
86	1	$properties = $this->getReflectionProperties($this->reflection);
		0 ignored issues – show Bug introduced 2018-01-10 02:45 UTC by Report Bug Copy Issue Report It seems like `getReflectionProperties()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
87	1	$classBaseName = $this->getBaseName($class);
88
89	1	throw new InvalidArgumentException("Argument passed to the method [$classBaseName] is not expected to this method. unknown arguments: [".implode(', ', $unknownArguments).']. required arguments: ['.implode(', ', $properties).'].');
90		}
91	4	}
92
93		/**
94		* validateArgumentsType
95		* Insert description here.
96		*
97		* @param $arguments
98		* @param $class
99		*
100		* @return
101		*/
102	5	private function validateArgumentsType($arguments, $class)
103		{
104	5	$classBaseName = $this->getBaseName($class);
105
106	5	if (!is_array($arguments)) {
107		throw new InvalidArgumentException("Arguments passed to the method [$classBaseName] should be an array, ".gettype($arguments).' given');
108		}
109	5	}
110
111		/**
112		* validateMethodExistance
113		* Insert description here.
114		*
115		* @param $class
116		*
117		* @return
118		*/
119	6	private function validateMethodExistance($class)
120		{
121	6	if (!class_exists($class)) {
122	1	$classBaseName = $this->getBaseName($class);
123
124	1	throw new UndefinedMethodException("the method [$classBaseName] is not defined, there is no matching class handler at: $class");
125		}
126	5	}
127
128		/**
129		* getBaseName
130		* Insert description here.
131		*
132		* @param $class
133		*
134		* @return
135		*/
136	6	private function getBaseName($class)
137		{
138	6	return preg_replace('/.*\\\\/', '', $class);
139		}
140		}
141

MohannadNaj / smsa-sdk

GitHub Access Token became invalid

ValidateData::validateMethodHasDefinedArguments() A last analyzed 2018-01-10 04:36 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

ValidateData::validateMethodHasDefinedArguments() A
last analyzed 2018-01-10 04:36 UTC