Application::onDisconnectFromServer() - Code Metrics - Inspection of "add log & fix bug" - slince/spike - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ca8586...ca93ac )

by Taosikai

created 2017-07-03 12:59 UTC

Application::onDisconnectFromServer() A

↳ Parent: Application

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	5
rs	9.4285
cc	1
eloc	3
nc	1
nop	1

<?php
/**
 * Spike library
 * @author Tao <[email protected]>
 */
namespace Spike\Client;

use Slince\Event\Event;
use Spike\Application as BaseApplication;
use Slince\Event\SubscriberInterface;
use Spike\Client\Command\InitCommand;
use Spike\Client\Command\SpikeCommand;
use Spike\Client\Command\ShowProxyHostsCommand;
use Spike\Client\Subscriber\LoggerSubscriber;
use Spike\Logger\Logger;
use Symfony\Component\Console\Input\InputDefinition;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

class Application extends BaseApplication implements SubscriberInterface
{
    /**
     * @var string
     */
    const NAME = 'spike-client';

    /**
     * @var string
     */
    const VERSION = '1.0.0.dev';

    /**
     * The client instance
     * @var Client
     */
    protected $client;

    /**
     * The server address
     * @var string
     */
    protected $serverAddress;

    public function __construct(Configuration $configuration)
    {
        parent::__construct($configuration,static::NAME, static::VERSION);
        $this->client = new Client(
            $configuration->getServerAddress(),
            $configuration->getTunnels(),
            $configuration->get('auth') ?: [],
            $this->loop,
            $this->dispatcher
        );
    }

    /**
     * Sets the client for the application
     * @param Client $client
     */
    public function setKernel(Client $client)
    {
        $this->client = $client;
    }

    /**
     * Gets the client instance
     * @return Client
     */
    public function getKernel()
    {
        return $this->client;
    }

    /**
     * {@inheritdoc}
     * @codeCoverageIgnore
     */
    public function doRun(InputInterface $input, OutputInterface $output)
    {
        $this->input = $input;
        $this->output = $output;
        //Logger
        $this->logger = new Logger(
            $this->getConfiguration()->getLogLevel(),
            $this->getConfiguration()->getLogFile(),
            $this->output
        );
        $this->client->setLogger($this->logger);
        $commandName = $input->getFirstArgument();
        if ($commandName) {
            $exitCode = parent::doRun($input, $output);
        } else {
            $exitCode = $this->doRunClient();
        }
        return $exitCode;
    }

    /**
     * @codeCoverageIgnore
     */
    protected function doRunClient()
    {
        if (true === $this->input->hasParameterOption(array('--help', '-h'), true)) {
            $command = $this->get('spike');
            $exitCode = $this->doRunCommand($command, $this->input, $this->output);
        } else {
            $exitCode = $this->runClient();
        }
        return $exitCode;
    }

    /**
     * Start the client
     * @codeCoverageIgnore
     */
    protected function runClient()
    {
        foreach ($this->getSubscribers() as $subscriber) {
            $this->dispatcher->addSubscriber($subscriber);
        }
        $this->client->run();
        return 0;
    }

    /**
     * {@inheritdoc}
     */
    public function getEvents()
    {
        return [
            EventStore::CANNOT_CONNECT_TO_SERVER => 'onCannotConnectToServer',
            EventStore::AUTH_ERROR => 'onAuthError',
            EventStore::REGISTER_TUNNEL_ERROR => 'onRegisterTunnelError',
            EventStore::DISCONNECT_SERVER => 'onDisconnectFromServer'
        ];
    }

    /**
     * @codeCoverageIgnore
     */
    public function onAuthError(Event $event)

    {
        $this->output->writeln('Auth error, please checks your configuration file');
        $this->client->close();
    }

    /**
     * @codeCoverageIgnore
     */
    public function onRegisterTunnelError(Event $event)
    {
        $this->output->writeln(sprintf('Registers the tunnel "%s" error, message: %s',
            $event->getArgument('tunnel'),
            $event->getArgument('errorMessage')
        ));
        $this->client->close();
    }

    /**
     * @codeCoverageIgnore
     */
    public function onCannotConnectToServer(Event $event)

    {
        $this->client->close();
    }

    /**
     * @codeCoverageIgnore
     */
    public function onDisconnectFromServer(Event $event)

    {
        $this->output->writeln('Disconnect from the server');
        $this->client->close();
    }

    /**
     * {@inheritdoc}
     */
    public function getDefaultCommands()
    {
        return array_merge(parent::getDefaultCommands(), [
class Author {
    private $name;

    public function __construct($name) {
        $this->name = $name;
    }

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
            new SpikeCommand($this),
            new ShowProxyHostsCommand($this),
            new InitCommand($this),
        ]);
    }

    /**
     * Gets all subscribers
     * @return array
     */
    public function getSubscribers()
    {
        return [
            $this,
            new LoggerSubscriber($this)
        ];
    }

    /**
     * {@inheritdoc}
     */
    protected function getDefaultInputDefinition()
    {
        $definition = new InputDefinition([
            new InputOption('config', null, InputOption::VALUE_OPTIONAL,
                'The configuration file, support json,ini,xml and yaml format')
        ]);
        $defaultDefinition = parent::getDefaultInputDefinition();
        $definition->addArguments($defaultDefinition->getArguments());
        $definition->addOptions($defaultDefinition->getOptions());
        return $definition;
    }
}

1			<?php
2			/**
3			* Spike library
4			* @author Tao <[email protected]>
5			*/
6			namespace Spike\Client;
7
8			use Slince\Event\Event;
9			use Spike\Application as BaseApplication;
10			use Slince\Event\SubscriberInterface;
11			use Spike\Client\Command\InitCommand;
12			use Spike\Client\Command\SpikeCommand;
13			use Spike\Client\Command\ShowProxyHostsCommand;
14			use Spike\Client\Subscriber\LoggerSubscriber;
15			use Spike\Logger\Logger;
16			use Symfony\Component\Console\Input\InputDefinition;
17			use Symfony\Component\Console\Input\InputInterface;
18			use Symfony\Component\Console\Input\InputOption;
19			use Symfony\Component\Console\Output\OutputInterface;
20
21			class Application extends BaseApplication implements SubscriberInterface
22			{
23			/**
24			* @var string
25			*/
26			const NAME = 'spike-client';
27
28			/**
29			* @var string
30			*/
31			const VERSION = '1.0.0.dev';
32
33			/**
34			* The client instance
35			* @var Client
36			*/
37			protected $client;
38
39			/**
40			* The server address
41			* @var string
42			*/
43			protected $serverAddress;
44
45			public function __construct(Configuration $configuration)
46			{
47			parent::__construct($configuration,static::NAME, static::VERSION);
48			$this->client = new Client(
49			$configuration->getServerAddress(),
50			$configuration->getTunnels(),
51			$configuration->get('auth') ?: [],
52			$this->loop,
53			$this->dispatcher
54			);
55			}
56
57			/**
58			* Sets the client for the application
59			* @param Client $client
60			*/
61			public function setKernel(Client $client)
62			{
63			$this->client = $client;
64			}
65
66			/**
67			* Gets the client instance
68			* @return Client
69			*/
70			public function getKernel()
71			{
72			return $this->client;
73			}
74
75			/**
76			* {@inheritdoc}
77			* @codeCoverageIgnore
78			*/
79			public function doRun(InputInterface $input, OutputInterface $output)
80			{
81			$this->input = $input;
82			$this->output = $output;
83			//Logger
84			$this->logger = new Logger(
85			$this->getConfiguration()->getLogLevel(),
86			$this->getConfiguration()->getLogFile(),
87			$this->output
88			);
89			$this->client->setLogger($this->logger);
90			$commandName = $input->getFirstArgument();
91			if ($commandName) {
92			$exitCode = parent::doRun($input, $output);
93			} else {
94			$exitCode = $this->doRunClient();
95			}
96			return $exitCode;
97			}
98
99			/**
100			* @codeCoverageIgnore
101			*/
102			protected function doRunClient()
103			{
104			if (true === $this->input->hasParameterOption(array('--help', '-h'), true)) {
105			$command = $this->get('spike');
106			$exitCode = $this->doRunCommand($command, $this->input, $this->output);
107			} else {
108			$exitCode = $this->runClient();
109			}
110			return $exitCode;
111			}
112
113			/**
114			* Start the client
115			* @codeCoverageIgnore
116			*/
117			protected function runClient()
118			{
119			foreach ($this->getSubscribers() as $subscriber) {
120			$this->dispatcher->addSubscriber($subscriber);
121			}
122			$this->client->run();
123			return 0;
124			}
125
126			/**
127			* {@inheritdoc}
128			*/
129			public function getEvents()
130			{
131			return [
132			EventStore::CANNOT_CONNECT_TO_SERVER => 'onCannotConnectToServer',
133			EventStore::AUTH_ERROR => 'onAuthError',
134			EventStore::REGISTER_TUNNEL_ERROR => 'onRegisterTunnelError',
135			EventStore::DISCONNECT_SERVER => 'onDisconnectFromServer'
136			];
137			}
138
139			/**
140			* @codeCoverageIgnore
141			*/
142			public function onAuthError(Event $event)
			0 ignored issues – show Unused Code introduced 2017-06-22 14:05 UTC by Report Bug Copy Issue Report The parameter `$event` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
143			{
144			$this->output->writeln('Auth error, please checks your configuration file');
145			$this->client->close();
146			}
147
148			/**
149			* @codeCoverageIgnore
150			*/
151			public function onRegisterTunnelError(Event $event)
152			{
153			$this->output->writeln(sprintf('Registers the tunnel "%s" error, message: %s',
154			$event->getArgument('tunnel'),
155			$event->getArgument('errorMessage')
156			));
157			$this->client->close();
158			}
159
160			/**
161			* @codeCoverageIgnore
162			*/
163			public function onCannotConnectToServer(Event $event)
			0 ignored issues – show Unused Code introduced 2017-06-21 05:24 UTC by Report Bug Copy Issue Report The parameter `$event` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
164			{
165			$this->client->close();
166			}
167
168			/**
169			* @codeCoverageIgnore
170			*/
171			public function onDisconnectFromServer(Event $event)
			0 ignored issues – show Unused Code introduced 2017-07-03 13:09 UTC by Report Bug Copy Issue Report The parameter `$event` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
172			{
173			$this->output->writeln('Disconnect from the server');
174			$this->client->close();
175			}
176
177			/**
178			* {@inheritdoc}
179			*/
180			public function getDefaultCommands()
181			{
182			return array_merge(parent::getDefaultCommands(), [
			0 ignored issues – show Best Practice introduced 2017-06-22 14:05 UTC by Report Bug Copy Issue Report The expression `return array_merge(paren...d\InitCommand($this)));` seems to be an `array`, but some of its elements' types (`Spike\Client\Command\Spi...ent\Command\InitCommand`) are incompatible with the return type of the parent method `Symfony\Component\Consol...ion::getDefaultCommands` of type `array<Symfony\Component\...le\Command\ListCommand>`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return new Author('Johannes'); } } class BlogPost extends Post { public function getAuthor() { return 'Johannes'; } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
183			new SpikeCommand($this),
184			new ShowProxyHostsCommand($this),
185			new InitCommand($this),
186			]);
187			}
188
189			/**
190			* Gets all subscribers
191			* @return array
192			*/
193			public function getSubscribers()
194			{
195			return [
196			$this,
197			new LoggerSubscriber($this)
198			];
199			}
200
201			/**
202			* {@inheritdoc}
203			*/
204			protected function getDefaultInputDefinition()
205			{
206			$definition = new InputDefinition([
207			new InputOption('config', null, InputOption::VALUE_OPTIONAL,
208			'The configuration file, support json,ini,xml and yaml format')
209			]);
210			$defaultDefinition = parent::getDefaultInputDefinition();
211			$definition->addArguments($defaultDefinition->getArguments());
212			$definition->addOptions($defaultDefinition->getOptions());
213			return $definition;
214			}
215			}

slince / spike

Push — master ( ca8586...ca93ac )

Application::onDisconnectFromServer() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like