Detector::check() - Code Metrics - Inspection of "check inheritance" - sokil/php-fraud-detect - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a31967...066d89 )

by De

created 2015-12-01 22:29 UTC

Detector::check() A

↳ Parent: Detector

Complexity

Conditions	3
Paths	3

Size

Total Lines	21
Code Lines	13

Duplication

Lines	0
Ratio	0 %

Importance

Changes	16
Bugs	1	Features	7

Metric	Value
c	16
b	1
f	7
dl	0
loc	21
rs	9.3143
cc	3
eloc	13
nc	3
nop	0

<?php

namespace Sokil\FraudDetector;

use Sokil\DataType\PriorityList;
use Symfony\Component\EventDispatcher\EventDispatcher;

class Detector
{
    const STATE_UNCHECKED   = 'unckecked';
    const STATE_PASSED      = 'checkPassed';
    const STATE_FAILED      = 'checkFailed';

    private $state = self::STATE_UNCHECKED;

    /**
     *
     * @var mixed key to identify unique user
     */
    private $key;

    /**
     *
     * @var \Sokil\DataType\PriorityList
     */
    private $processorDeclarationList;

    private $processorList = array();

    private $processorNamespaces = array(
        '\Sokil\FraudDetector\Processor',
    );

    private $collectorNamespaces = array(
        '\Sokil\FraudDetector\Processor\RequestRate\Collector',
    );

    /**
     *
     * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
     */
    private $eventDispatcher;

    public function __construct()
    {
        $this->processorDeclarationList = new PriorityList();
        $this->eventDispatcher = new EventDispatcher();
    }

    /**
     * Key that uniquely identify user
     * @param type $key
     * @return \Sokil\FraudDetector\Detector
     */
    public function setKey($key)
    {
        $this->key = $key;
        return $this;
    }

    public function getKey()
    {
        if(!$this->key) {
            $this->key = isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : null;
        }

        return $this->key;
    }

    /**
     * Check if request is not fraud
     */
    public function check()
    {
        // check all conditions
        /* @var $processor \Sokil\FraudDetector\ProcessorInterface */
        foreach($this->processorDeclarationList->getKeys() as $processorName) {
            $processor = $this->getProcessor($processorName);

            if($processor->isPassed()) {
                $processor->afterCheckPassed();
                $this->trigger(self::STATE_PASSED . ':' . $processorName);
                $this->state = self::STATE_PASSED;
            } else {
                $processor->afterCheckFailed();
                $this->trigger(self::STATE_FAILED . ':' . $processorName);
                $this->state = self::STATE_FAILED;
                break;
            }
        }

        $this->trigger($this->state);
    }

    public function registerProcessorNamespace($namespace)
    {
        $this->processorNamespaces[] = rtrim($namespace, '\\');
        return $this;
    }

    /**
     * Add processor identified by its name.
     * If processor already added, it will be replaced by new instance.
     *
     * @param string $name name of processor
     * @param callable $callable configurator callable
     * @return \Sokil\FraudDetector\Detector
     */
    public function declareProcessor($name, $callable = null, $priority = 0)
    {
        $this->processorDeclarationList->set($name, $callable, $priority);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        return $this;
    }

    public function addProcssor($name, ProcessorInterface $processor, $priority = 0)
    {
        $this->declareProcessor($name, null, $priority);
        $this->processorList[$name] = $processor;

        return $this;
    }

    public function isProcessorDeclared($name)
    {
        return $this->processorDeclarationList->has($name);
    }

    /**
     * Factory method to create new check condition
     *
     * @param string $name name of check condition
     * @return \Sokil\FraudDetector\ProcessorInterface
     * @throws \Exception
     */
    private function getProcessorClassName($name)
    {
        $className = ucfirst($name) . 'Processor';

        foreach($this->processorNamespaces as $namespace) {

            $fullyQualifiedClassName = $namespace . '\\' . $className;
            if(class_exists($fullyQualifiedClassName)) {
                return $fullyQualifiedClassName;
            }
        }

        throw new \Exception('Class ' . $fullyQualifiedClassName . ' not found');
    }

    public function getProcessor($processorName)
    {
        if(isset($this->processorList[$processorName])) {
            return $this->processorList[$processorName];
        }

        // create processor
        $processorClassName = $this->getProcessorClassName($processorName);
        $processor =  new $processorClassName($this);

        if (!($processor instanceof ProcessorInterface)) {
            throw new \Exception('Processor must inherit ProcessorInterface');
        }

        // configure processor
        $configuratorCallable = $this->processorDeclarationList->get($processorName);
        if($configuratorCallable && is_callable($configuratorCallable)) {
            call_user_func($configuratorCallable, $processor);
        }

        $this->processorList[$processorName] = $processor;

        return $processor;
    }

    public function registerCollectorNamespace($namespace)
    {
        $this->collectorNamespaces[] = rtrim($namespace, '\\');
        return $this;
    }

    public function getCollectorClassName($type)
    {
        if(false == strpos($type, '_')) {

            $className = ucfirst($type);
        } else {
            $className = implode('', array_map('ucfirst', explode('_', $type)));
        }

        $className .= 'Collector';

        foreach($this->collectorNamespaces as $namespace) {

            $fullyQualifiedClassName = $namespace . '\\' . $className;
            if(class_exists($fullyQualifiedClassName)) {
                return $fullyQualifiedClassName;
            }
        }

        throw new \Exception('Class ' . $fullyQualifiedClassName . ' not found');
    }

    private function on($stateName, $callable)
    {
        if($this->hasState(self::STATE_UNCHECKED)) {
            $this->subscribe($stateName, $callable);
        } elseif($this->hasState($stateName)) {
            call_user_func($callable);
        }

        return $this;
    }

    public function onCheckPassed($callable)
    {
        $this->on(self::STATE_PASSED, $callable);

        return $this;
    }

    public function onCheckFailed($callable)
    {
        $this->on(self::STATE_FAILED, $callable);

        return $this;
    }

    public function isUnchecked()
    {
        return $this->hasState(self::STATE_UNCHECKED);
    }

    public function isPassed()
    {
        return $this->hasState(self::STATE_PASSED);
    }

    public function isFailed()
    {
        return $this->hasState(self::STATE_FAILED);
    }

    private function hasState($state)
    {
        return $this->state === $state;
    }

    public function subscribe($eventName, $callable, $priority = 0)
    {
        $this->eventDispatcher->addListener($eventName, $callable, $priority);
        return $this;
    }

    /**
     *
     * @param string $eventName
     * @param mixed $target
     * @return \Sokil\FraudDetector\Event
     */
    public function trigger($eventName, $target = null)
    {
        $event = new Event();

        if($target) {
            $event->setTarget($target);
        }

        return $this->eventDispatcher->dispatch($eventName, $event);
    }
}

1		<?php
2
3		namespace Sokil\FraudDetector;
4
5		use Sokil\DataType\PriorityList;
6		use Symfony\Component\EventDispatcher\EventDispatcher;
7
8		class Detector
9		{
10		const STATE_UNCHECKED = 'unckecked';
11		const STATE_PASSED = 'checkPassed';
12		const STATE_FAILED = 'checkFailed';
13
14		private $state = self::STATE_UNCHECKED;
15
16		/**
17		*
18		* @var mixed key to identify unique user
19		*/
20		private $key;
21
22		/**
23		*
24		* @var \Sokil\DataType\PriorityList
25		*/
26		private $processorDeclarationList;
27
28		private $processorList = array();
29
30		private $processorNamespaces = array(
31		'\Sokil\FraudDetector\Processor',
32		);
33
34		private $collectorNamespaces = array(
35		'\Sokil\FraudDetector\Processor\RequestRate\Collector',
36		);
37
38		/**
39		*
40		* @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
41		*/
42		private $eventDispatcher;
43
44		public function __construct()
45		{
46		$this->processorDeclarationList = new PriorityList();
47		$this->eventDispatcher = new EventDispatcher();
48		}
49
50		/**
51		* Key that uniquely identify user
52		* @param type $key
53		* @return \Sokil\FraudDetector\Detector
54		*/
55		public function setKey($key)
56		{
57		$this->key = $key;
58		return $this;
59		}
60
61		public function getKey()
62		{
63		if(!$this->key) {
64		$this->key = isset($_SERVER['REMOTE_ADDR']) ? $_SERVER['REMOTE_ADDR'] : null;
65		}
66
67		return $this->key;
68		}
69
70		/**
71		* Check if request is not fraud
72		*/
73		public function check()
74		{
75		// check all conditions
76		/* @var $processor \Sokil\FraudDetector\ProcessorInterface */
77		foreach($this->processorDeclarationList->getKeys() as $processorName) {
78		$processor = $this->getProcessor($processorName);
79
80		if($processor->isPassed()) {
81		$processor->afterCheckPassed();
82		$this->trigger(self::STATE_PASSED . ':' . $processorName);
83		$this->state = self::STATE_PASSED;
84		} else {
85		$processor->afterCheckFailed();
86		$this->trigger(self::STATE_FAILED . ':' . $processorName);
87		$this->state = self::STATE_FAILED;
88		break;
89		}
90		}
91
92		$this->trigger($this->state);
93		}
94
95		public function registerProcessorNamespace($namespace)
96		{
97		$this->processorNamespaces[] = rtrim($namespace, '\\');
98		return $this;
99		}
100
101		/**
102		* Add processor identified by its name.
103		* If processor already added, it will be replaced by new instance.
104		*
105		* @param string $name name of processor
106		* @param callable $callable configurator callable
107		* @return \Sokil\FraudDetector\Detector
108		*/
109		public function declareProcessor($name, $callable = null, $priority = 0)
110		{
111		$this->processorDeclarationList->set($name, $callable, $priority);
		0 ignored issues – show Documentation introduced 2015-12-01 22:27 UTC by Report Bug Copy Issue Report `$callable` is of type `callable\|null`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
112		return $this;
113		}
114
115		public function addProcssor($name, ProcessorInterface $processor, $priority = 0)
116		{
117		$this->declareProcessor($name, null, $priority);
118		$this->processorList[$name] = $processor;
119
120		return $this;
121		}
122
123		public function isProcessorDeclared($name)
124		{
125		return $this->processorDeclarationList->has($name);
126		}
127
128		/**
129		* Factory method to create new check condition
130		*
131		* @param string $name name of check condition
132		* @return \Sokil\FraudDetector\ProcessorInterface
133		* @throws \Exception
134		*/
135		private function getProcessorClassName($name)
136		{
137		$className = ucfirst($name) . 'Processor';
138
139	View Code Duplication	foreach($this->processorNamespaces as $namespace) {
		0 ignored issues – show Duplication introduced 2015-12-01 22:27 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
140		$fullyQualifiedClassName = $namespace . '\\' . $className;
141		if(class_exists($fullyQualifiedClassName)) {
142		return $fullyQualifiedClassName;
143		}
144		}
145
146		throw new \Exception('Class ' . $fullyQualifiedClassName . ' not found');
147		}
148
149		public function getProcessor($processorName)
150		{
151		if(isset($this->processorList[$processorName])) {
152		return $this->processorList[$processorName];
153		}
154
155		// create processor
156		$processorClassName = $this->getProcessorClassName($processorName);
157		$processor = new $processorClassName($this);
158
159		if (!($processor instanceof ProcessorInterface)) {
160		throw new \Exception('Processor must inherit ProcessorInterface');
161		}
162
163		// configure processor
164		$configuratorCallable = $this->processorDeclarationList->get($processorName);
165		if($configuratorCallable && is_callable($configuratorCallable)) {
166		call_user_func($configuratorCallable, $processor);
167		}
168
169		$this->processorList[$processorName] = $processor;
170
171		return $processor;
172		}
173
174		public function registerCollectorNamespace($namespace)
175		{
176		$this->collectorNamespaces[] = rtrim($namespace, '\\');
177		return $this;
178		}
179
180		public function getCollectorClassName($type)
181		{
182		if(false == strpos($type, '_')) {
		0 ignored issues – show Bug Best Practice introduced 2015-12-01 22:27 UTC by Report Bug Copy Issue Report It seems like you are loosely comparing `strpos($type, '_')` of type `integer` to the boolean `false`. If you are specifically checking for 0, consider using something more explicit like `=== 0` instead. Loading history...
183		$className = ucfirst($type);
184		} else {
185		$className = implode('', array_map('ucfirst', explode('_', $type)));
186		}
187
188		$className .= 'Collector';
189
190	View Code Duplication	foreach($this->collectorNamespaces as $namespace) {
		0 ignored issues – show Duplication introduced 2015-12-01 22:27 UTC by Report Bug Copy Issue Report This code seems to be duplicated across 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...
191		$fullyQualifiedClassName = $namespace . '\\' . $className;
192		if(class_exists($fullyQualifiedClassName)) {
193		return $fullyQualifiedClassName;
194		}
195		}
196
197		throw new \Exception('Class ' . $fullyQualifiedClassName . ' not found');
198		}
199
200		private function on($stateName, $callable)
201		{
202		if($this->hasState(self::STATE_UNCHECKED)) {
203		$this->subscribe($stateName, $callable);
204		} elseif($this->hasState($stateName)) {
205		call_user_func($callable);
206		}
207
208		return $this;
209		}
210
211		public function onCheckPassed($callable)
212		{
213		$this->on(self::STATE_PASSED, $callable);
214
215		return $this;
216		}
217
218		public function onCheckFailed($callable)
219		{
220		$this->on(self::STATE_FAILED, $callable);
221
222		return $this;
223		}
224
225		public function isUnchecked()
226		{
227		return $this->hasState(self::STATE_UNCHECKED);
228		}
229
230		public function isPassed()
231		{
232		return $this->hasState(self::STATE_PASSED);
233		}
234
235		public function isFailed()
236		{
237		return $this->hasState(self::STATE_FAILED);
238		}
239
240		private function hasState($state)
241		{
242		return $this->state === $state;
243		}
244
245		public function subscribe($eventName, $callable, $priority = 0)
246		{
247		$this->eventDispatcher->addListener($eventName, $callable, $priority);
248		return $this;
249		}
250
251		/**
252		*
253		* @param string $eventName
254		* @param mixed $target
255		* @return \Sokil\FraudDetector\Event
256		*/
257		public function trigger($eventName, $target = null)
258		{
259		$event = new Event();
260
261		if($target) {
262		$event->setTarget($target);
263		}
264
265		return $this->eventDispatcher->dispatch($eventName, $event);
266		}
267		}

sokil / php-fraud-detect

Push — master ( a31967...066d89 )

Detector::check() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like