Issues (66)

src/Command/ConsoleStyleCommand.php (1 issue)

Labels
Severity
1
<?php
2
namespace PortlandLabs\Slackbot\Command;
3
4
use PortlandLabs\Slackbot\Command\Argument\Manager;
0 ignored issues
show
This use statement conflicts with another class in this namespace, PortlandLabs\Slackbot\Command\Manager. Consider defining an alias.

Let?s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let?s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
5
use PortlandLabs\Slackbot\Slack\Rtm\Event\Message;
6
7
/**
8
 * A command that acts similarly to a console command
9
 * @example @somebot do-something --with="test"
10
 */
11
interface ConsoleStyleCommand extends Command
12
{
13
14
    /**
15
     * Add arguments to the argument manager
16
     * This method gets called after we match the command to a request
17
     *
18
     * @param Manager $manager
19
     *
20
     * @return Manager
21
     */
22
    public function configure(Manager $manager): Manager;
23
24
    /**
25
     * Handle a message
26
     *
27
     * @param Message $message
28
     * @param Manager $manager
29
     *
30
     * @return void
31
     */
32
    public function run(Message $message, Manager $manager);
33
34
    /**
35
     * Get the description for this command
36
     *
37
     * @return string
38
     */
39
    public function getDescription(): string;
40
41
}