Completed
Push — master ( 022281...f9cc19 )
by Elan
20s
created

Xhgui_ServiceContainer::_services()   B

Complexity

Conditions 4
Paths 1

Size

Total Lines 55

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 55
rs 8.9818
c 0
b 0
f 0
cc 4
nc 1
nop 0

How to fix   Long Method   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
use Slim\Slim;
3
use Slim\Views\Twig;
4
use Slim\Middleware\SessionCookie;
5
6
class Xhgui_ServiceContainer extends Pimple
7
{
8
    protected static $_instance;
9
10
    public static function instance()
11
    {
12
        if (empty(static::$_instance)) {
13
            static::$_instance = new self();
14
        }
15
        return static::$_instance;
16
    }
17
18
    public function __construct()
19
    {
20
        $this->_slimApp();
21
        $this->_services();
22
        $this->_controllers();
0 ignored issues
show
Unused Code introduced by
The call to the method Xhgui_ServiceContainer::_controllers() seems un-needed as the method has no side-effects.

PHP Analyzer performs a side-effects analysis of your code. A side-effect is basically anything that might be visible after the scope of the method is left.

Let’s take a look at an example:

class User
{
    private $email;

    public function getEmail()
    {
        return $this->email;
    }

    public function setEmail($email)
    {
        $this->email = $email;
    }
}

If we look at the getEmail() method, we can see that it has no side-effect. Whether you call this method or not, no future calls to other methods are affected by this. As such code as the following is useless:

$user = new User();
$user->getEmail(); // This line could safely be removed as it has no effect.

On the hand, if we look at the setEmail(), this method _has_ side-effects. In the following case, we could not remove the method call:

$user = new User();
$user->setEmail('email@domain'); // This line has a side-effect (it changes an
                                 // instance variable).
Loading history...
23
    }
24
25
    // Create the Slim app.
26
    protected function _slimApp()
27
    {
28
        $this['view'] = function ($c) {
29
            $cacheDir = isset($c['config']['cache']) ? $c['config']['cache'] : XHGUI_ROOT_DIR . '/cache';
30
31
            // Configure Twig view for slim
32
            $view = new Twig();
33
34
            $view->twigTemplateDirs = array(dirname(__DIR__) . '/templates');
35
            $view->parserOptions = array(
36
                'charset' => 'utf-8',
37
                'cache' => $cacheDir,
38
                'auto_reload' => true,
39
                'strict_variables' => false,
40
                'autoescape' => true
41
            );
42
43
            return $view;
44
        };
45
46
        $this['app'] = $this->share(function ($c) {
47
            $app = new Slim($c['config']);
48
49
            // Enable cookie based sessions
50
            $app->add(new SessionCookie(array(
51
                'httponly' => true,
52
            )));
53
54
            // Add renderer.
55
            $app->add(new Xhgui_Middleware_Render());
56
57
            $view = $c['view'];
58
            $view->parserExtensions = array(
59
                new Xhgui_Twig_Extension($app)
60
            );
61
            $app->view($view);
62
63
            return $app;
64
        });
65
    }
66
67
    /**
68
     * Add common service objects to the container.
69
     */
70
    protected function _services()
71
    {
72
        $this['config'] = Xhgui_Config::all();
73
74
        $this['db'] = $this->share(function ($c) {
75
            $config = $c['config'];
76
            if (empty($config['db.options'])) {
77
                $config['db.options'] = array();
78
            }
79
            $mongo = new MongoClient($config['db.host'], $config['db.options']);
80
            $mongo->{$config['db.db']}->results->findOne();
81
82
            return $mongo->{$config['db.db']};
83
        });
84
85
        $this['pdo'] = $this->share(function ($c) {
86
            return new PDO(
87
                $c['config']['pdo']['dsn'],
88
                $c['config']['pdo']['pass'],
89
                $c['config']['pdo']['user']
90
            );
91
        });
92
93
        $this['searcher.mongo'] = function ($c) {
94
            return new Xhgui_Searcher_Mongo($c['db']);
95
        };
96
97
        $this['searcher.pdo'] = function ($c) {
98
            return new Xhgui_Searcher_Pdo($c['pdo'], $c['config']['pdo']['table']);
99
        };
100
101
        $this['searcher'] = function ($c) {
102
            $config = $c['config'];
103
104
            switch ($config['save.handler']) {
105
                case 'pdo':
106
                    return $c['searcher.pdo'];
107
108
                case 'mongodb':
109
                default:
110
                    return $c['searcher.mongo'];
111
            }
112
        };
113
114
        $this['saver.mongo'] = function ($c) {
115
            $config = $c['config'];
116
            $config['save.handler'] = 'mongodb';
117
118
            return Xhgui_Saver::factory($config);
119
        };
120
121
        $this['saver'] = function ($c) {
122
            return Xhgui_Saver::factory($c['config']);
123
        };
124
    }
125
126
    /**
127
     * Add controllers to the DI container.
128
     */
129
    protected function _controllers()
130
    {
131
        $this['watchController'] = function ($c) {
132
            return new Xhgui_Controller_Watch($c['app'], $c['searcher']);
133
        };
134
135
        $this['runController'] = function ($c) {
136
            return new Xhgui_Controller_Run($c['app'], $c['searcher']);
137
        };
138
139
        $this['customController'] = function ($c) {
140
            return new Xhgui_Controller_Custom($c['app'], $c['searcher']);
141
        };
142
143
        $this['waterfallController'] = function ($c) {
144
            return new Xhgui_Controller_Waterfall($c['app'], $c['searcher']);
145
        };
146
147
        $this['importController'] = function ($c) {
148
            return new Xhgui_Controller_Import($c['app'], $c['saver']);
149
        };
150
    }
151
152
}
153