Test Failed
Push — develop ( bd77d0...12e168 )
by nguereza
03:10
created

ServiceProvider   A

Complexity

Total Complexity 6

Size/Duplication

Total Lines 68
Duplicated Lines 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
eloc 7
dl 0
loc 68
c 1
b 0
f 0
rs 10
wmc 6

6 Methods

Rating   Name   Duplication   Size   Complexity  
A addRoutes() 0 2 1
A register() 0 2 1
A boot() 0 2 1
A getCommands() 0 3 1
A __construct() 0 3 1
A addCommand() 0 5 1
1
<?php
2
3
/**
4
 * Platine Framework
5
 *
6
 * Platine Framework is a lightweight, high-performance, simple and elegant
7
 * PHP Web framework
8
 *
9
 * This content is released under the MIT License (MIT)
10
 *
11
 * Copyright (c) 2020 Platine Framework
12
 *
13
 * Permission is hereby granted, free of charge, to any person obtaining a copy
14
 * of this software and associated documentation files (the "Software"), to deal
15
 * in the Software without restriction, including without limitation the rights
16
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17
 * copies of the Software, and to permit persons to whom the Software is
18
 * furnished to do so, subject to the following conditions:
19
 *
20
 * The above copyright notice and this permission notice shall be included in all
21
 * copies or substantial portions of the Software.
22
 *
23
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29
 * SOFTWARE.
30
 */
31
32
/**
33
 *  @file ServiceProvider.php
34
 *
35
 *  The Service provider base class
36
 *
37
 *  @package    Platine\Framework\Service
38
 *  @author Platine Developers team
39
 *  @copyright  Copyright (c) 2020
40
 *  @license    http://opensource.org/licenses/MIT  MIT License
41
 *  @link   http://www.iacademy.cf
42
 *  @version 1.0.0
43
 *  @filesource
44
 */
45
46
declare(strict_types=1);
47
48
namespace Platine\Framework\Service;
49
50
use Platine\Framework\App\Application;
51
use Platine\Route\Router;
52
53
/**
54
 * class ServiceProvider
55
 * @package Platine\Framework\Service
56
 */
57
class ServiceProvider
58
{
59
60
    /**
61
     * The Application instance
62
     * @var Application
63
     */
64
    protected Application $app;
65
66
    /**
67
     * Provider command list
68
     * @var class-string[]
0 ignored issues
show
Documentation Bug introduced by
The doc comment class-string[] at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string[].
Loading history...
69
     */
70
    protected array $commands = [];
71
72
    /**
73
     * Create new instance
74
     * @param Application $app
75
     */
76
    public function __construct(Application $app)
77
    {
78
        $this->app = $app;
79
    }
80
81
    /**
82
     * Register all the services needed
83
     * @return void
84
     */
85
    public function register(): void
86
    {
87
    }
88
89
    /**
90
     * Action to run when the application is booted
91
     * @return void
92
     */
93
    public function boot(): void
94
    {
95
    }
96
97
    /**
98
     * Add application route
99
     * @param Router $router the route instance
100
     * @return void
101
     */
102
    public function addRoutes(Router $router): void
0 ignored issues
show
Unused Code introduced by
The parameter $router is not used and could be removed. ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-unused  annotation

102
    public function addRoutes(/** @scrutinizer ignore-unused */ Router $router): void

This check looks for parameters that have been defined for a function or method, but which are not used in the method body.

Loading history...
103
    {
104
    }
105
106
    /**
107
     * Register command
108
     * @param class-string $command
0 ignored issues
show
Documentation Bug introduced by
The doc comment class-string at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string.
Loading history...
109
     * @return $this
110
     */
111
    public function addCommand(string $command): self
112
    {
113
        $this->commands[] = $command;
114
115
        return $this;
116
    }
117
118
    /**
119
     * Return the list of command
120
     * @return class-string[]
0 ignored issues
show
Documentation Bug introduced by
The doc comment class-string[] at position 0 could not be parsed: Unknown type name 'class-string' at position 0 in class-string[].
Loading history...
121
     */
122
    public function getCommands(): array
123
    {
124
        return $this->commands;
125
    }
126
}
127