PortAddVhostCommand::execute() - Code Metrics - tollwerk/admin - Measure and Improve Code Quality continuously with Scrutinizer

PortAddVhostCommand::execute() B
last analyzed 2020-07-08 14:33 UTC

↳ Parent: PortAddVhostCommand

Complexity

Conditions	7
Paths	24

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	56

Importance

Changes

Metric	Value
dl	0
loc	38
ccs	0
cts	36
cp	0
rs	8.3786
c	0
b	0
f	0
cc	7
nc	24
nop	2
crap	56

<?php

/**
 * admin
 *
 * @category    Tollwerk
 * @package     Tollwerk\Admin
 * @subpackage  Tollwerk\Admin\Infrastructure
 * @author      Joschi Kuphal <[email protected]> / @jkphl
 * @copyright   Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
 * @license     http://opensource.org/licenses/MIT The MIT License (MIT)
 */

/***********************************************************************************
 *  The MIT License (MIT)
 *
 *  Copyright © 2018 Joschi Kuphal <[email protected]> / @jkphl
 *
 *  Permission is hereby granted, free of charge, to any person obtaining a copy of
 *  this software and associated documentation files (the "Software"), to deal in
 *  the Software without restriction, including without limitation the rights to
 *  use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 *  the Software, and to permit persons to whom the Software is furnished to do so,
 *  subject to the following conditions:
 *
 *  The above copyright notice and this permission notice shall be included in all
 *  copies or substantial portions of the Software.
 *
 *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 *  FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 *  COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 *  IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 *  CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 ***********************************************************************************/

namespace Tollwerk\Admin\Infrastructure\Commands\Vhost;

use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Tollwerk\Admin\Infrastructure\Commands\AbstractCommand;
use Tollwerk\Admin\Ports\Facade\Vhost;

/**
 * vhost:port:add command
 *
 * @package Tollwerk\Admin
 * @subpackage Tollwerk\Admin\Infrastructure
 */
class PortAddVhostCommand extends AbstractCommand
{
    /**
     * Configure the command
     */
    protected function configure()
    {
        $this
            // the name of the command (the part after "bin/console")
            ->setName('vhost:port:add')
            // the short description shown while running "php bin/console list"
            ->setDescription('Add a protocol / port')
            // the full command description shown when running the command with
            // the "--help" option
            ->setHelp("This command allows you to add a protocol / port combination to a virtual host")
            // configure the virtual host account name
            ->addArgument(
                'account',
                InputArgument::REQUIRED,
                'The name of the account the virtual host belongs to'
            )
            // configure the virtual host document root
            ->addArgument('docroot', InputArgument::OPTIONAL, 'The virtual hosts\'s document root', '')
            // configure the protocol
            ->addArgument(
                'protocol',
                InputArgument::OPTIONAL,
                'The protocol ("http" (default) or "https")',
                \Tollwerk\Admin\Domain\Vhost\Vhost::PROTOCOL_HTTP
            )
            // configure the port
            ->addArgument(
                'port',
                InputArgument::OPTIONAL,
                'The HTTP port (default 80 for HTTP protocol, 443 for HTTPS protocol)',
                ''
            );
    }

    /**
     * Execute the command
     *
     * @param InputInterface $input
     * @param OutputInterface $output
     * @return int Status code
     */
    protected function execute(InputInterface $input, OutputInterface $output)
    {
        $account = $input->getArgument('account');
        $docroot = $input->getArgument('docroot');
        $protocol = $input->getArgument('protocol');
        $port = $input->getArgument('port');
        try {
            // Determine the protocol
            if (!array_key_exists($protocol, \Tollwerk\Admin\Domain\Vhost\Vhost::$supportedProtocols)) {
                $protocolStr = strtolower($protocol);
                $protocolKey = array_search($protocolStr, \Tollwerk\Admin\Domain\Vhost\Vhost::$supportedProtocols);
                if ($protocolKey === false) {
                    throw new \RuntimeException(sprintf('Invalid protocol "%s"', $protocol), 1475484081);
                }
                $protocol = $protocolKey;
            }
            $protocol = intval($protocol);
            $port = trim($port) ?: null;

            Vhost::addPort($account, $docroot, $protocol, $port);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            $output->writeln(
                sprintf('<info>Virtual host "%s" protocol port added successfully</info>', $docroot ?: '/')
            );
            $this->printMessages($output);
            return 0;
        } catch (\Exception $e) {
            $output->writeln(
                sprintf(
                    '<error>Error adding protocol port to virtual host "%s": %s (%s)</error>',
                    $docroot ?: '/',
                    $e->getMessage(),
                    $e->getCode()
                )
            );
            $this->printMessages($output);
            return $e->getCode();
        }
    }
}


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:port:add command
47			*
48			* @package Tollwerk\Admin
49			* @subpackage Tollwerk\Admin\Infrastructure
50			*/
51			class PortAddVhostCommand 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:port:add')
61			// the short description shown while running "php bin/console list"
62			->setDescription('Add a protocol / port')
63			// the full command description shown when running the command with
64			// the "--help" option
65			->setHelp("This command allows you to add a protocol / port combination to 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 protocol
75			->addArgument(
76			'protocol',
77			InputArgument::OPTIONAL,
78			'The protocol ("http" (default) or "https")',
79			\Tollwerk\Admin\Domain\Vhost\Vhost::PROTOCOL_HTTP
80			)
81			// configure the port
82			->addArgument(
83			'port',
84			InputArgument::OPTIONAL,
85			'The HTTP port (default 80 for HTTP protocol, 443 for HTTPS protocol)',
86			''
87			);
88			}
89
90			/**
91			* Execute the command
92			*
93			* @param InputInterface $input
94			* @param OutputInterface $output
95			* @return int Status code
96			*/
97			protected function execute(InputInterface $input, OutputInterface $output)
98			{
99			$account = $input->getArgument('account');
100			$docroot = $input->getArgument('docroot');
101			$protocol = $input->getArgument('protocol');
102			$port = $input->getArgument('port');
103			try {
104			// Determine the protocol
105			if (!array_key_exists($protocol, \Tollwerk\Admin\Domain\Vhost\Vhost::$supportedProtocols)) {
106			$protocolStr = strtolower($protocol);
107			$protocolKey = array_search($protocolStr, \Tollwerk\Admin\Domain\Vhost\Vhost::$supportedProtocols);
108			if ($protocolKey === false) {
109			throw new \RuntimeException(sprintf('Invalid protocol "%s"', $protocol), 1475484081);
110			}
111			$protocol = $protocolKey;
112			}
113			$protocol = intval($protocol);
114			$port = trim($port) ?: null;
115
116			Vhost::addPort($account, $docroot, $protocol, $port);
			0 ignored issues – show Bug introduced 2020-07-08 14:26 UTC by Report Bug Copy Issue Report It seems like `$account` defined by `$input->getArgument('account')` on line `99` can also be of type `array<integer,string>` or `null`; however, `Tollwerk\Admin\Ports\Facade\Vhost::addPort()` 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 2020-07-08 14:26 UTC by Report Bug Copy Issue Report It seems like `$docroot` defined by `$input->getArgument('docroot')` on line `100` can also be of type `array<integer,string>` or `null`; however, `Tollwerk\Admin\Ports\Facade\Vhost::addPort()` 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...
117			$output->writeln(
118			sprintf('<info>Virtual host "%s" protocol port added successfully</info>', $docroot ?: '/')
119			);
120			$this->printMessages($output);
121			return 0;
122			} catch (\Exception $e) {
123			$output->writeln(
124			sprintf(
125			'<error>Error adding protocol port to virtual host "%s": %s (%s)</error>',
126			$docroot ?: '/',
127			$e->getMessage(),
128			$e->getCode()
129			)
130			);
131			$this->printMessages($output);
132			return $e->getCode();
133			}
134			}
135			}
136

tollwerk / admin

PortAddVhostCommand::execute() B last analyzed 2020-07-08 14:33 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

PortAddVhostCommand::execute() B
last analyzed 2020-07-08 14:33 UTC