Test Failed
Push — develop ( 8b5bdd...c753fd )
by nguereza
02:34
created

ServiceProvider::subscribe()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 5
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 2
nc 1
nop 1
dl 0
loc 5
rs 10
c 0
b 0
f 0
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
    /**
64
     * The Application instance
65
     * @var Application
66
     */
67
    protected Application $app;
68
69
    /**
70
     * Provider command list
71
     * @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...
72
     */
73
    protected array $commands = [];
74
75
    /**
76
     * Create new instance
77
     * @param Application $app
78
     */
79
    public function __construct(Application $app)
80
    {
81
        $this->app = $app;
82
    }
83
84
    /**
85
     * Register all the services needed
86
     * @return void
87
     */
88
    public function register(): void
89
    {
90
    }
91
92
    /**
93
     * Action to run when the application is booted
94
     * @return void
95
     */
96
    public function boot(): void
97
    {
98
    }
99
100
    /**
101
     * Add application route
102
     * @param Router $router the route instance
103
     * @return void
104
     */
105
    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

105
    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...
106
    {
107
    }
108
109
    /**
110
     * Register command
111
     * @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...
112
     * @return $this
113
     */
114
    public function addCommand(string $command): self
115
    {
116
        $this->commands[] = $command;
117
118
        return $this;
119
    }
120
121
    /**
122
     * Register a listener for the given event.
123
     *
124
     * @param string $eventName the name of event
125
     * @param ListenerInterface|callable|string $listener the Listener
126
     * interface or any callable
127
     * @param int $priority the listener execution priority
128
     * @return $this
129
     */
130
    public function listen(
131
        string $eventName,
132
        $listener,
133
        int $priority = DispatcherInterface::PRIORITY_DEFAULT
134
    ): self {
135
        $this->app->listen($eventName, $listener, $priority);
136
137
        return $this;
138
    }
139
140
    /**
141
     * Add event subscriber
142
     * @param SubscriberInterface $subscriber
143
     * @return $this
144
     */
145
    public function subscribe(SubscriberInterface $subscriber): self
146
    {
147
        $this->app->subscribe($subscriber);
148
149
        return $this;
150
    }
151
152
    /**
153
     * Return the list of command
154
     * @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...
155
     */
156
    public function getCommands(): array
157
    {
158
        return $this->commands;
159
    }
160
}
161