Passed
Push — master ( e6b641...f65816 )
by Dani
01:36
created

src/HttpClients/ClientInterface.php (1 issue)

Look for PHPDoc comments for non-existent parameters and make alternative suggestion.

Documentation Minor

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
namespace Postpay\HttpClients;
4
5
use Postpay\Http\Request;
6
7
interface ClientInterface
8
{
9
    /**
10
     * Sends a request to the server and returns the response.
11
     *
12
     * @param Request  $request Request to send.
13
     * @param int|null $timeOut The timeout for the request.
0 ignored issues
show
There is no parameter named $timeOut. Did you maybe mean $timeout?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit.

Consider the following example. The parameter $ireland is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was changed, but the annotation was not.

Loading history...
14
     *
15
     * @return \Postpay\Http\Response Response from the server.
16
     *
17
     * @throws \Postpay\Exceptions\PostpayException
18
     */
19
    public function send(Request $request, $timeout = null);
20
}
21