Completed
Push — master ( df8184...e3b994 )
by Aydin
02:31
created

examples/disabled-items.php (1 issue)

Labels
Severity

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

1
<?php
2
3
use PhpSchool\CliMenu\CliMenu;
4
use PhpSchool\CliMenu\Builder\CliMenuBuilder;
5
6
require_once(__DIR__ . '/../vendor/autoload.php');
7
8
$itemCallable = function (CliMenu $menu) {
9
    echo $menu->getSelectedItem()->getText();
10
};
11
12
$menu = (new CliMenuBuilder)
0 ignored issues
show
It seems like you code against a concrete implementation and not the interface PhpSchool\CliMenu\Builder\Builder as the method setTitle() does only exist in the following implementations of said interface: PhpSchool\CliMenu\Builder\CliMenuBuilder.

Let’s take a look at an example:

interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.

Available Fixes

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the interface:

    interface User
    {
        /** @return string */
        public function getPassword();
    
        /** @return string */
        public function getDisplayName();
    }
    
Loading history...
13
    ->setTitle('Basic CLI Menu Disabled Items')
14
    ->addItem('First Item', $itemCallable)
15
    ->addItem('Second Item', $itemCallable, false, true)
16
    ->addItem('Third Item', $itemCallable, false, true)
17
    ->addSubMenu('Submenu')
18
        ->setTitle('Basic CLI Menu Disabled Items > Submenu')
19
        ->addItem('You can go in here!', $itemCallable)
20
        ->end()
21
    ->addSubMenu('Disabled Submenu')
22
        ->setTitle('Basic CLI Menu Disabled Items > Disabled Submenu')
23
        ->addItem('Nope can\'t see this!', $itemCallable)
24
        ->disableMenu()
25
        ->end()
26
    ->addLineBreak('-')
27
    ->build();
28
29
$menu->open();
30