Test Failed
Push — master ( dc68d1...1f5199 )
by Mathieu
02:31
created

AbstractManager   A

Complexity

Total Complexity 13

Size/Duplication

Total Lines 134
Duplicated Lines 14.93 %

Coupling/Cohesion

Components 2
Dependencies 1

Importance

Changes 0
Metric Value
wmc 13
lcom 2
cbo 1
dl 20
loc 134
rs 10
c 0
b 0
f 0

7 Methods

Rating   Name   Duplication   Size   Complexity  
B __construct() 0 26 5
A setModelFactory() 0 6 1
A modelFactory() 10 10 2
A setCollectionLoader() 0 6 1
A collectionLoader() 10 10 2
A setAdminConfig() 0 6 1
A adminConfig() 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
namespace Charcoal\Cms\Service\Manager;
4
5
// dependency from charcoal-factory
6
use Charcoal\Factory\FactoryInterface;
7
8
// dependency from charcoal-core
9
use Charcoal\Loader\CollectionLoader;
10
11
// Psr-7 dependencies
12
use RuntimeException;
13
use Exception;
14
15
use \Charcoal\Translator\TranslatorAwareTrait;
16
17
/**
18
 * Abstract Manager
19
 */
20
class AbstractManager
21
{
22
    use TranslatorAwareTrait;
23
24
    /**
25
     * Store the factory instance for the current class.
26
     *
27
     * @var FactoryInterface
28
     */
29
    protected $modelFactory;
30
31
    /**
32
     * Store the collection loader for the current class.
33
     *
34
     * @var CollectionLoader
35
     */
36
    protected $collectionLoader;
37
38
    /**
39
     * @var object $adminConfig The admin config object model.
40
     */
41
    protected $adminConfig;
42
43
    /**
44
     * NewsManager constructor.
45
     * @param array $data The Data.
46
     * @throws Exception When $data index is not set.
47
     */
48
    public function __construct(array $data)
49
    {
50
        if (!isset($data['factory'])) {
51
            throw new Exception(sprintf(
52
                'Model Factory must be defined in the %s constructor.',
53
                get_called_class()
54
            ));
55
        }
56
        if (!isset($data['loader'])) {
57
            throw new Exception(sprintf(
58
                'CollectionLoader must be defined in the %s constructor.',
59
                get_called_class()
60
            ));
61
        }
62
        if (!isset($data['cms/config'])) {
63
            throw new Exception('You must define a global config object in your cms.json config file. (config_obj)');
64
        }
65
66
        if (isset($data['translator'])) {
67
            $this->setTranslator($data['translator']);
68
        }
69
70
        $this->setModelFactory($data['factory']);
71
        $this->setCollectionLoader($data['loader']);
72
        $this->setAdminConfig($data['cms/config']);
73
    }
74
75
    /**
76
     * Set an object model factory.
77
     *
78
     * @param FactoryInterface $factory The model factory, to create objects.
79
     * @return self
80
     */
81
    protected function setModelFactory(FactoryInterface $factory)
82
    {
83
        $this->modelFactory = $factory;
84
85
        return $this;
86
    }
87
88
    /**
89
     * Retrieve the object model factory.
90
     *
91
     * @throws RuntimeException If the model factory was not previously set.
92
     * @return FactoryInterface
93
     */
94 View Code Duplication
    public function modelFactory()
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...
95
    {
96
        if (!isset($this->modelFactory)) {
97
            throw new RuntimeException(
98
                sprintf('Model Factory is not defined for "%s"', get_class($this))
99
            );
100
        }
101
102
        return $this->modelFactory;
103
    }
104
105
    /**
106
     * Set a model collection loader.
107
     *
108
     * @param CollectionLoader $loader The collection loader.
109
     * @return self
110
     */
111
    protected function setCollectionLoader(CollectionLoader $loader)
112
    {
113
        $this->collectionLoader = $loader;
114
115
        return $this;
116
    }
117
118
    /**
119
     * Retrieve the model collection loader.
120
     *
121
     * @throws RuntimeException If the collection loader was not previously set.
122
     * @return CollectionLoader
123
     */
124 View Code Duplication
    public function collectionLoader()
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...
125
    {
126
        if (!isset($this->collectionLoader)) {
127
            throw new RuntimeException(
128
                sprintf('Collection Loader is not defined for "%s"', get_class($this))
129
            );
130
        }
131
132
        return $this->collectionLoader;
133
    }
134
135
    /**
136
     * @param mixed $adminConfig The admin configuration.
137
     * @return self
138
     */
139
    public function setAdminConfig($adminConfig)
140
    {
141
        $this->adminConfig = $adminConfig;
142
143
        return $this;
144
    }
145
146
    /**
147
     * @return mixed
148
     */
149
    public function adminConfig()
150
    {
151
        return $this->adminConfig;
152
    }
153
}
154