Client::postCommand() - Code Metrics - Inspection of "Add POST command" - RobinvdVleuten/php-nntp - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#18)

unknown

created 2016-02-09 01:06 UTC

Client::postCommand() A

↳ Parent: Client

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	4
ccs	0
cts	2
cp	0
rs	10
cc	1
eloc	2
nc	1
nop	0
crap	2

<?php

/*
 * This file is part of the NNTP library.
 *
 * (c) Robin van der Vleuten <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Rvdv\Nntp;

use Rvdv\Nntp\Command\CommandInterface;
use Rvdv\Nntp\Connection\ConnectionInterface;
use Rvdv\Nntp\Exception\RuntimeException;
use Rvdv\Nntp\Response\Response;

/**
 * @author Robin van der Vleuten <[email protected]>
 */
class Client implements ClientInterface
{
    /**
     * @var ConnectionInterface
     */
    private $connection;

    /**
     * Constructor
     *
     * @param ConnectionInterface $connection
     */
    public function __construct(ConnectionInterface $connection)
    {
        $this->connection = $connection;
    }

    /**
     * Get the connection instance.
     *
     * @return ConnectionInterface
     */
    public function getConnection()
    {
        return $this->connection;
    }

    /**
     * {@inheritdoc}
     */
    public function connect()
    {
        return $this->connection->connect();
    }

    /**
     * {@inheritdoc}
     */
    public function disconnect()
    {
        if (!$this->connection->disconnect()) {
            throw new RuntimeException('Error while disconnecting from NNTP server');
        }

        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function authenticate($username, $password = null)
    {
        $command = $this->authInfo(Command\AuthInfoCommand::AUTHINFO_USER, (string) $username);
        $response = $command->getResponse();

        if ($response->getStatusCode() === Response::PASSWORD_REQUIRED) {
            if (null === $password) {
                throw new RuntimeException('NNTP server asks for further authentication but no password is given');
            }

            $command = $this->authInfo(Command\AuthInfoCommand::AUTHINFO_PASS, (string) $password);
            $response = $command->getResponse();
        }

        if ($response->getStatusCode() !== Response::AUTHENTICATION_ACCEPTED) {
            throw new RuntimeException(sprintf('Could not authenticate with given username/password: %s', (string) $response));
        }

        return $response;
    }

    /**
     * {@inheritdoc}
     */
    public function connectAndAuthenticate($username = null, $password = null)
    {
        $response = $this->connect();

        if (!in_array($response->getStatusCode(), array(Response::POSTING_ALLOWED, RESPONSE::POSTING_PROHIBITED))) {
            throw new RuntimeException(sprintf('Unsuccessful response received: %s', (string) $response));
        }

        if ($username !== null) {
            return $this->authenticate($username, $password);
        }

        return $response;
    }

    /**
     * {@inheritdoc}
     */
    public function authInfo($type, $value)
    {
        return $this->sendCommand(new Command\AuthInfoCommand($type, $value));
    }

    /**
     * {@inheritdoc}
     */
    public function group($name)
    {
        return $this->sendCommand(new Command\GroupCommand($name));
    }

    /**
     * {@inheritdoc}
     */
    public function help()
    {
        return $this->sendCommand(new Command\HelpCommand());
    }

    /**
     * {@inheritdoc}
     */
    public function overviewFormat()
    {
        return $this->sendCommand(new Command\OverviewFormatCommand());
    }
    
    /**
     * {@inheritdoc}
     */
	public function post($groups, $subject, $body, $from, $headers = null)
	{
		$command = $this->postCommand(new Command\PostCommand());

        $response = $command->getResponse();
        
        if ($response->getStatusCode() === Response::SEND_ARTICLE) {
            $command = $this->postArticle($groups, $subject, $body, $from, $headers);
            $response = $command->getResponse();
        }

        if ($response->getStatusCode() !== Response::ARTICLE_RECEIVED) {
            throw new RuntimeException(sprintf('Posting failed: %s', (string) $response));
        }
        
        return $response;
	}
	
    /**
     * {@inheritdoc}
     */
    public function postArticle($groups, $subject, $body, $from, $headers = null)
    {
    	return $this->sendArticle(new Command\PostArticleCommand($groups, $subject, $body, $from, $headers));
class Author {
    private $name;

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

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

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

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

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

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }
    
    /**
     * {@inheritdoc}
     */
    public function postCommand()
    {
    	return $this->sendCommand(new Command\PostCommand());
    }

    /**
     * {@inheritdoc}
     */
    public function quit()
    {
        return $this->sendCommand(new Command\QuitCommand());
    }

    /**
     * {@inheritdoc}
     */
    public function xfeature($feature)
    {
        return $this->sendCommand(new Command\XFeatureCommand($feature));
    }

    /**
     * {@inheritdoc}
     */
    public function xover($from, $to, array $format)
    {
        return $this->sendCommand(new Command\XoverCommand($from, $to, $format));
    }

    /**
     * {@inheritdoc}
     */
    public function xzver($from, $to, array $format)
    {
        return $this->sendCommand(new Command\XzverCommand($from, $to, $format));
    }

    /**
     * {@inheritdoc}
     */
    public function sendCommand(CommandInterface $command)
    {
        return $this->connection->sendCommand($command);
    }
    
    /**
     * {@inheritdoc}
     */
    public function sendArticle(CommandInterface $command)
    {
        return $this->connection->sendArticle($command);
    }
}


1		<?php
2
3		/*
4		* This file is part of the NNTP library.
5		*
6		* (c) Robin van der Vleuten <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Rvdv\Nntp;
13
14		use Rvdv\Nntp\Command\CommandInterface;
15		use Rvdv\Nntp\Connection\ConnectionInterface;
16		use Rvdv\Nntp\Exception\RuntimeException;
17		use Rvdv\Nntp\Response\Response;
18
19		/**
20		* @author Robin van der Vleuten <[email protected]>
21		*/
22		class Client implements ClientInterface
23		{
24		/**
25		* @var ConnectionInterface
26		*/
27		private $connection;
28
29		/**
30		* Constructor
31		*
32		* @param ConnectionInterface $connection
33		*/
34	9	public function __construct(ConnectionInterface $connection)
35		{
36	9	$this->connection = $connection;
37	9	}
38
39		/**
40		* Get the connection instance.
41		*
42		* @return ConnectionInterface
43		*/
44	1	public function getConnection()
45		{
46	1	return $this->connection;
47		}
48
49		/**
50		* {@inheritdoc}
51		*/
52	1	public function connect()
53		{
54	1	return $this->connection->connect();
55		}
56
57		/**
58		* {@inheritdoc}
59		*/
60	2	public function disconnect()
61		{
62	2	if (!$this->connection->disconnect()) {
63	1	throw new RuntimeException('Error while disconnecting from NNTP server');
64		}
65
66	1	return true;
67		}
68
69		/**
70		* {@inheritdoc}
71		*/
72	4	public function authenticate($username, $password = null)
73		{
74	4	$command = $this->authInfo(Command\AuthInfoCommand::AUTHINFO_USER, (string) $username);
75	4	$response = $command->getResponse();
76
77	4	if ($response->getStatusCode() === Response::PASSWORD_REQUIRED) {
78	2	if (null === $password) {
79	1	throw new RuntimeException('NNTP server asks for further authentication but no password is given');
80		}
81
82	1	$command = $this->authInfo(Command\AuthInfoCommand::AUTHINFO_PASS, (string) $password);
83	1	$response = $command->getResponse();
84	1	}
85
86	3	if ($response->getStatusCode() !== Response::AUTHENTICATION_ACCEPTED) {
87	1	throw new RuntimeException(sprintf('Could not authenticate with given username/password: %s', (string) $response));
88		}
89
90	2	return $response;
91		}
92
93		/**
94		* {@inheritdoc}
95		*/
96		public function connectAndAuthenticate($username = null, $password = null)
97		{
98		$response = $this->connect();
99
100		if (!in_array($response->getStatusCode(), array(Response::POSTING_ALLOWED, RESPONSE::POSTING_PROHIBITED))) {
101		throw new RuntimeException(sprintf('Unsuccessful response received: %s', (string) $response));
102		}
103
104		if ($username !== null) {
105		return $this->authenticate($username, $password);
106		}
107
108		return $response;
109		}
110
111		/**
112		* {@inheritdoc}
113		*/
114	5	public function authInfo($type, $value)
115		{
116	5	return $this->sendCommand(new Command\AuthInfoCommand($type, $value));
117		}
118
119		/**
120		* {@inheritdoc}
121		*/
122	1	public function group($name)
123		{
124	1	return $this->sendCommand(new Command\GroupCommand($name));
125		}
126
127		/**
128		* {@inheritdoc}
129		*/
130	1	public function help()
131		{
132	1	return $this->sendCommand(new Command\HelpCommand());
133		}
134
135		/**
136		* {@inheritdoc}
137		*/
138	1	public function overviewFormat()
139		{
140	1	return $this->sendCommand(new Command\OverviewFormatCommand());
141		}
142
143		/**
144		* {@inheritdoc}
145		*/
146		public function post($groups, $subject, $body, $from, $headers = null)
147		{
148		$command = $this->postCommand(new Command\PostCommand());
		0 ignored issues – show Unused Code introduced 2016-02-02 18:14 UTC by Report Bug Copy Issue Report The call to `Client::postCommand()` has too many arguments starting with `new \Rvdv\Nntp\Command\PostCommand()`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
149		$response = $command->getResponse();
150
151		if ($response->getStatusCode() === Response::SEND_ARTICLE) {
152		$command = $this->postArticle($groups, $subject, $body, $from, $headers);
153		$response = $command->getResponse();
154		}
155
156		if ($response->getStatusCode() !== Response::ARTICLE_RECEIVED) {
157		throw new RuntimeException(sprintf('Posting failed: %s', (string) $response));
158		}
159
160		return $response;
161		}
162
163		/**
164		* {@inheritdoc}
165		*/
166		public function postArticle($groups, $subject, $body, $from, $headers = null)
167		{
168		return $this->sendArticle(new Command\PostArticleCommand($groups, $subject, $body, $from, $headers));
		0 ignored issues – show Bug Best Practice introduced 2016-02-02 18:14 UTC by Report Bug Copy Issue Report The return type of `return $this->sendArticl...ody, $from, $headers));` (`Rvdv\Nntp\Command\CommandInterface`) is incompatible with the return type declared by the interface `Rvdv\Nntp\ClientInterface::postArticle` of type `Rvdv\Nntp\Response\ResponseInterface`. 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 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('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...
169		}
170
171		/**
172		* {@inheritdoc}
173		*/
174		public function postCommand()
175		{
176		return $this->sendCommand(new Command\PostCommand());
177		}
178
179		/**
180		* {@inheritdoc}
181		*/
182	1	public function quit()
183		{
184	1	return $this->sendCommand(new Command\QuitCommand());
185		}
186
187		/**
188		* {@inheritdoc}
189		*/
190	1	public function xfeature($feature)
191		{
192	1	return $this->sendCommand(new Command\XFeatureCommand($feature));
193		}
194
195		/**
196		* {@inheritdoc}
197		*/
198	1	public function xover($from, $to, array $format)
199		{
200	1	return $this->sendCommand(new Command\XoverCommand($from, $to, $format));
201		}
202
203		/**
204		* {@inheritdoc}
205		*/
206	1	public function xzver($from, $to, array $format)
207		{
208	1	return $this->sendCommand(new Command\XzverCommand($from, $to, $format));
209		}
210
211		/**
212		* {@inheritdoc}
213		*/
214	5	public function sendCommand(CommandInterface $command)
215		{
216	5	return $this->connection->sendCommand($command);
217		}
218
219		/**
220		* {@inheritdoc}
221		*/
222		public function sendArticle(CommandInterface $command)
223		{
224		return $this->connection->sendArticle($command);
225		}
226		}
227

RobinvdVleuten / php-nntp

Pull Request — master (#18)

Client::postCommand() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like