Passed
Push — master ( 215600...914e6e )
by Alain
02:30
created

ViewFinder   A

Complexity

Total Complexity 11

Size/Duplication

Total Lines 91
Duplicated Lines 23.08 %

Coupling/Cohesion

Components 1
Dependencies 3

Test Coverage

Coverage 82.61%

Importance

Changes 4
Bugs 0 Features 1
Metric Value
wmc 11
c 4
b 0
f 1
lcom 1
cbo 3
dl 21
loc 91
ccs 19
cts 23
cp 0.8261
rs 10

4 Methods

Rating   Name   Duplication   Size   Complexity  
A find() 0 16 4
A initializeViews() 0 6 2
A initializeView() 21 21 4
A getFindablesConfigKey() 0 4 1

How to fix   Duplicated Code   

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

1
<?php
2
/**
3
 * Bright Nucleus View Component.
4
 *
5
 * @package   BrightNucleus\View
6
 * @author    Alain Schlesser <[email protected]>
7
 * @license   MIT
8
 * @link      http://www.brightnucleus.com/
9
 * @copyright 2016 Alain Schlesser, Bright Nucleus
10
 */
11
12
namespace BrightNucleus\View\View;
13
14
use BrightNucleus\View\Engine\EngineInterface;
15
use BrightNucleus\View\Exception\FailedToInstantiateViewException;
16
use BrightNucleus\View\Support\AbstractFinder;
17
18
/**
19
 * Class ViewFinder.
20
 *
21
 * @since   0.1.0
22
 *
23
 * @package BrightNucleus\View\View
24
 * @author  Alain Schlesser <[email protected]>
25
 */
26
class ViewFinder extends AbstractFinder
27
{
28
29
    /**
30
     * Find a result based on a specific criteria.
31
     *
32
     * @since 0.1.0
33
     *
34
     * @param array           $criteria Criteria to search for.
35
     * @param EngineInterface $engine   Optional. Engine to use with the view.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $engine not be null|EngineInterface?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
36
     *
37
     * @return ViewInterface View that was found.
1 ignored issue
show
Documentation introduced by
Should the return type not be \BrightNucleus\View\Supp...View\Support\NullObject?

This check compares the return type specified in the @return annotation of a function or method doc comment with the types returned by the function and raises an issue if they mismatch.

Loading history...
38
     */
39 17
    public function find(array $criteria, EngineInterface $engine = null)
40
    {
41 17
        $uri = $criteria[0];
42
43 17
        $this->initializeViews($uri, $engine);
44
45 17
        foreach ($criteria as $entry) {
46 17
            foreach ($this->findables as $viewObject) {
47 17
                if ($viewObject->canHandle($entry)) {
48 17
                    return $viewObject;
49
                }
50
            }
51
        }
52
53
        return $this->getNullObject();
54
    }
55
56
    /**
57
     * Initialize the views that can be iterated.
58
     *
59
     * @since 0.1.0
60
     *
61
     * @param string          $uri    URI to use for the view.
62
     * @param EngineInterface $engine Optional. Engine to use with the view.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $engine not be null|EngineInterface?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
63
     */
64 17
    protected function initializeViews($uri, EngineInterface $engine = null)
65
    {
66 17
        foreach ($this->findables as &$view) {
67 17
            $view = $this->initializeView($view, $uri, $engine);
68
        }
69 17
    }
70
71
    /**
72
     * Initialize a single view by instantiating class name strings and calling closures.
73
     *
74
     * @since 0.1.0
75
     *
76
     * @param mixed           $view   View to instantiate.
77
     * @param string          $uri    URI to use for the view.
78
     * @param EngineInterface $engine Optional. Engine to use with the view.
0 ignored issues
show
Documentation introduced by
Should the type for parameter $engine not be null|EngineInterface?

This check looks for @param annotations where the type inferred by our type inference engine differs from the declared type.

It makes a suggestion as to what type it considers more descriptive.

Most often this is a case of a parameter that can be null in addition to its declared types.

Loading history...
79
     *
80
     * @return ViewInterface Instantiated view.
81
     * @throws FailedToInstantiateViewException If the view could not be instantiated.
82
     */
83 17 View Code Duplication
    protected function initializeView($view, $uri, EngineInterface $engine = null)
0 ignored issues
show
Duplication introduced by
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...
84
    {
85 17
        if (is_string($view)) {
86 7
            $view = new $view($uri, $engine);
87
        }
88
89 17
        if (is_callable($view)) {
90
            $view = $view($uri, $engine);
91
        }
92
93 17
        if (! $view instanceof ViewInterface) {
94
            throw new FailedToInstantiateViewException(
95
                sprintf(
96
                    _('Could not instantiate view "%s".'),
97
                    serialize($view)
98
                )
99
            );
100
        }
101
102 17
        return $view;
103
    }
104
105
    /**
106
     * Get the config key for the Findables definitions.
107
     *
108
     * @since 0.1.0
109
     *
110
     * @return string Config key use to define the Findables.
111
     */
112 7
    protected function getFindablesConfigKey()
113
    {
114 7
        return 'Views';
115
    }
116
}
117