RedirectVhostCommand::configure()   A
last analyzed

Complexity

Conditions 1
Paths 1

Size

Total Lines 28

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
dl 0
loc 28
ccs 0
cts 20
cp 0
rs 9.472
c 0
b 0
f 0
cc 1
nc 1
nop 0
crap 2
1
<?php
2
3
/**
4
 * admin
5
 *
6
 * @category    Tollwerk
7
 * @package     Tollwerk\Admin
8
 * @subpackage  Tollwerk\Admin\Infrastructure
9
 * @author      Joschi Kuphal <[email protected]> / @jkphl
10
 * @copyright   Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
11
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
12
 */
13
14
/***********************************************************************************
15
 *  The MIT License (MIT)
16
 *
17
 *  Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
18
 *
19
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
20
 *  this software and associated documentation files (the "Software"), to deal in
21
 *  the Software without restriction, including without limitation the rights to
22
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
23
 *  the Software, and to permit persons to whom the Software is furnished to do so,
24
 *  subject to the following conditions:
25
 *
26
 *  The above copyright notice and this permission notice shall be included in all
27
 *  copies or substantial portions of the Software.
28
 *
29
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
30
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
31
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
32
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
33
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
34
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
35
 ***********************************************************************************/
36
37
namespace Tollwerk\Admin\Infrastructure\Commands\Vhost;
38
39
use Symfony\Component\Console\Input\InputArgument;
40
use Symfony\Component\Console\Input\InputInterface;
41
use Symfony\Component\Console\Output\OutputInterface;
42
use Tollwerk\Admin\Infrastructure\Commands\AbstractCommand;
43
use Tollwerk\Admin\Ports\Facade\Vhost;
44
45
/**
46
 * vhost:redirect command
47
 *
48
 * @package Tollwerk\Admin
49
 * @subpackage Tollwerk\Admin\Infrastructure
50
 */
51
class RedirectVhostCommand extends AbstractCommand
52
{
53
    /**
54
     * Configure the command
55
     */
56
    protected function configure()
57
    {
58
        $this
59
            // the name of the command (the part after "bin/console")
60
            ->setName('vhost:redirect')
61
            // the short description shown while running "php bin/console list"
62
            ->setDescription('Redirect a virtual host')
63
            // the full command description shown when running the command with
64
            // the "--help" option
65
            ->setHelp("This command allows you to completely redirect a virtual host")
66
            // configure the virtual host account name
67
            ->addArgument(
68
                'account',
69
                InputArgument::REQUIRED,
70
                'The name of the account the virtual host belongs to'
71
            )
72
            // configure the virtual host document root
73
            ->addArgument('docroot', InputArgument::OPTIONAL, 'The virtual hosts\'s document root', '')
74
            // configure the URL to redirect to
75
            ->addArgument('url', InputArgument::OPTIONAL, 'The redirect URL', '')
76
            // configure the redirect status
77
            ->addArgument(
78
                'status',
79
                InputArgument::OPTIONAL,
80
                'The redirect HTTP status code',
81
                \Tollwerk\Admin\Domain\Vhost\Vhost::REDIRECT_DEFAULT_STATUS
82
            );
83
    }
84
85
    /**
86
     * Execute the command
87
     *
88
     * @param InputInterface $input
89
     * @param OutputInterface $output
90
     * @return int Status code
91
     */
92
    protected function execute(InputInterface $input, OutputInterface $output)
93
    {
94
        $account = $input->getArgument('account');
95
        $docroot = $input->getArgument('docroot');
96
        $url = $input->getArgument('url');
97
        $status = $input->getArgument('status');
98
        try {
99
            Vhost::redirect($account, $docroot, $url, $status);
0 ignored issues
show
Bug introduced by
It seems like $account defined by $input->getArgument('account') on line 94 can also be of type array<integer,string> or null; however, Tollwerk\Admin\Ports\Facade\Vhost::redirect() does only seem to accept string, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
Bug introduced by
It seems like $docroot defined by $input->getArgument('docroot') on line 95 can also be of type array<integer,string> or null; however, Tollwerk\Admin\Ports\Facade\Vhost::redirect() does only seem to accept string, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
Bug introduced by
It seems like $url defined by $input->getArgument('url') on line 96 can also be of type array<integer,string> or null; however, Tollwerk\Admin\Ports\Facade\Vhost::redirect() does only seem to accept string, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
Documentation introduced by
$status is of type string|array<integer,string>|null, but the function expects a integer.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
100
            $output->writeln(sprintf('<info>Virtual host "%s" redirected successfully</info>', $docroot ?: '/'));
101
            $this->printMessages($output);
102
            return 0;
103
        } catch (\Exception $e) {
104
            $output->writeln(
105
                sprintf(
106
                    '<error>Error redirecting virtual host "%s": %s (%s)</error>',
107
                    $docroot ?: '/',
108
                    $e->getMessage(),
109
                    $e->getCode()
110
                )
111
            );
112
            $this->printMessages($output);
113
            return $e->getCode();
114
        }
115
    }
116
}
117