Passed
Push — develop ( 86d31c...191f96 )
by nguereza
03:18
created

ServiceProvider::register()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 2
Code Lines 0

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
cc 1
eloc 0
c 1
b 0
f 0
nc 1
nop 0
dl 0
loc 2
rs 10
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\Event\DispatcherInterface;
51
use Platine\Event\ListenerInterface;
52
use Platine\Event\SubscriberInterface;
53
use Platine\Framework\App\Application;
54
use Platine\Route\Router;
55
56
/**
57
 * @class ServiceProvider
58
 * @package Platine\Framework\Service
59
 */
60
class ServiceProvider
61
{
62
    /**
63
     * The Application instance
64
     * @var Application
65
     */
66
    protected Application $app;
67
68
    /**
69
     * Provider command list
70
     * @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...
71
     */
72
    protected array $commands = [];
73
74
    /**
75
     * Provider task list
76
     * @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...
77
     */
78
    protected array $tasks = [];
79
80
    /**
81
     * Create new instance
82
     * @param Application $app
83
     */
84
    public function __construct(Application $app)
85
    {
86
        $this->app = $app;
87
    }
88
89
    /**
90
     * Register all the services needed
91
     * @return void
92
     */
93
    public function register(): void
94
    {
95
    }
96
97
    /**
98
     * Action to run when the application is booted
99
     * @return void
100
     */
101
    public function boot(): void
102
    {
103
    }
104
105
    /**
106
     * Add application route
107
     * @param Router $router the route instance
108
     * @return void
109
     */
110
    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

110
    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...
111
    {
112
    }
113
114
    /**
115
     * Register command
116
     * @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...
117
     * @return $this
118
     */
119
    public function addCommand(string $command): self
120
    {
121
        $this->commands[] = $command;
122
123
        return $this;
124
    }
125
126
    /**
127
     * Register task
128
     * @param class-string $task
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...
129
     * @return $this
130
     */
131
    public function addTask(string $task): self
132
    {
133
        $this->tasks[] = $task;
134
135
        return $this;
136
    }
137
138
    /**
139
     * Register a listener for the given event.
140
     *
141
     * @param string $eventName the name of event
142
     * @param ListenerInterface|callable|string $listener the Listener
143
     * interface or any callable
144
     * @param int $priority the listener execution priority
145
     * @return $this
146
     */
147
    public function listen(
148
        string $eventName,
149
        $listener,
150
        int $priority = DispatcherInterface::PRIORITY_DEFAULT
151
    ): self {
152
        $this->app->listen($eventName, $listener, $priority);
153
154
        return $this;
155
    }
156
157
    /**
158
     * Add event subscriber
159
     * @param SubscriberInterface $subscriber
160
     * @return $this
161
     */
162
    public function subscribe(SubscriberInterface $subscriber): self
163
    {
164
        $this->app->subscribe($subscriber);
165
166
        return $this;
167
    }
168
169
    /**
170
     * Return the list of command
171
     * @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...
172
     */
173
    public function getCommands(): array
174
    {
175
        return $this->commands;
176
    }
177
178
    /**
179
     * Return the list of task
180
     * @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...
181
     */
182
    public function getTasks(): array
183
    {
184
        return $this->tasks;
185
    }
186
}
187