Doc and CS fixes (suggested by Scrutinizer-CI).

Author: boenrobot

src/PEAR2/Net/RouterOS/Client.php

@@ -105,24 +105,25 @@ class Client
      * Creates a new instance of a RouterOS API client with the specified
      * settings.
      *
-     * @param string   $host     Hostname (IP or domain) of the RouterOS server.
-     * @param string   $username The RouterOS username.
-     * @param string   $password The RouterOS password.
-     * @param int|null $port     The port on which the RouterOS server provides
-     *     the API service. You can also specify NULL, in which case the port
-     *     will automatically be chosen between 8728 and 8729, depending on the
-     *     value of $crypto.
-     * @param bool     $persist  Whether or not the connection should be a
+     * @param string        $host     Hostname (IP or domain) of RouterOS.
+     * @param string        $username The RouterOS username.
+     * @param string        $password The RouterOS password.
+     * @param int|null      $port     The port on which the RouterOS host
+     *     provides the API service. You can also specify NULL, in which case
+     *     the port will automatically be chosen between 8728 and 8729,
+     *     depending on the value of $crypto.
+     * @param bool          $persist  Whether or not the connection should be a
      *     persistent one.
-     * @param float    $timeout  The timeout for the connection.
-     * @param string   $crypto   The encryption for this connection. Must be one
-     *     of the PEAR2\Net\Transmitter\NetworkStream::CRYPTO_* constants. Off
-     *     by default. RouterOS currently supports only TLS, but the setting is
-     *     provided in this fashion for forward compatibility's sake. And for
-     *     the sake of simplicity, if you specify an encryption, don't specify a
-     *     context and your default context uses the value "DEFAULT" for
-     *     ciphers, "ADH" will be automatically added to the list of ciphers.
-     * @param resource $context  A context for the socket.
+     * @param double|null   $timeout  The timeout for the connection.
+     * @param string        $crypto   The encryption for this connection.
+     *     Must be one of the PEAR2\Net\Transmitter\NetworkStream::CRYPTO_*
+     *     constants. Off by default. RouterOS currently supports only TLS, but
+     *     the setting is provided in this fashion for forward compatibility's
+     *     sake. And for the sake of simplicity, if you specify an encryption,
+     *     don't specify a context and your default context uses the value
+     *     "DEFAULT" for ciphers, "ADH" will be automatically added to the list
+     *     of ciphers.
+     * @param resource|null $context  A context for the socket.
      *
      * @see sendSync()
      * @see sendAsync()
@@ -350,14 +351,15 @@ public function getCharset($charsetType)
     /**
      * Sends a request and waits for responses.
      *
-     * @param Request  $request  The request to send.
-     * @param callback $callback Optional. A function that is to be executed
-     *     when new responses for this request are available. The callback takes
-     *     two parameters. The {@link Response} object as the first, and the
-     *     {@link Client} object as the second one. If the function returns
-     *     TRUE, the request is canceled. Note that the callback may be executed
-     *     one last time after that with a response that notifies about the
-     *     canceling.
+     * @param Request       $request  The request to send.
+     * @param callback|null $callback Optional. A function that is to be
+     *     executed when new responses for this request are available.
+     *     The callback takes two parameters. The {@link Response} object as
+     *     the first, and the {@link Client} object as the second one. If the
+     *     callback returns TRUE, the request is canceled. Note that the
+     *     callback may be executed at least two times after that. Once with a
+     *     {@link Response::TYPE_ERROR} response that notifies about the
+     *     canceling, plus the {@link Response::TYPE_FINAL} response.
      *
      * @return $this The client object.
      *

src/PEAR2/Net/RouterOS/Communicator.php

@@ -91,24 +91,25 @@ class Communicator
     /**
      * Creates a new connection with the specified options.
      *
-     * @param string   $host    Hostname (IP or domain) of the RouterOS server.
-     * @param int|null $port    The port on which the RouterOS server provides
-     *     the API service. You can also specify NULL, in which case the port
-     *     will automatically be chosen between 8728 and 8729, depending on the
-     *     value of $crypto.
-     * @param bool     $persist Whether or not the connection should be a
+     * @param string        $host    Hostname (IP or domain) of RouterOS.
+     * @param int|null      $port    The port on which the RouterOS host
+     *     provides the API service. You can also specify NULL, in which case
+     *     the port will automatically be chosen between 8728 and 8729,
+     *     depending on the value of $crypto.
+     * @param bool          $persist Whether or not the connection should be a
      *     persistent one.
-     * @param float    $timeout The timeout for the connection.
-     * @param string   $key     A string that uniquely identifies the
+     * @param double|null   $timeout The timeout for the connection.
+     * @param string        $key     A string that uniquely identifies the
      *     connection.
-     * @param string   $crypto  The encryption for this connection. Must be one
-     *     of the PEAR2\Net\Transmitter\NetworkStream::CRYPTO_* constants. Off
-     *     by default. RouterOS currently supports only TLS, but the setting is
-     *     provided in this fashion for forward compatibility's sake. And for
-     *     the sake of simplicity, if you specify an encryption, don't specify a
-     *     context and your default context uses the value "DEFAULT" for
-     *     ciphers, "ADH" will be automatically added to the list of ciphers.
-     * @param resource $context A context for the socket.
+     * @param string        $crypto  The encryption for this connection.
+     *     Must be one of the PEAR2\Net\Transmitter\NetworkStream::CRYPTO_*
+     *     constants. Off by default. RouterOS currently supports only TLS, but
+     *     the setting is provided in this fashion for forward compatibility's
+     *     sake. And for the sake of simplicity, if you specify an encryption,
+     *     don't specify a context and your default context uses the value
+     *     "DEFAULT" for ciphers, "ADH" will be automatically added to the list
+     *     of ciphers.
+     * @param resource|null $context A context for the socket.
      *
      * @see sendWord()
      */
@@ -176,8 +177,8 @@ public function __construct(
      * function. Depending on the argument given, one of the other functions in
      * the class is invoked and its returned value is returned by this function.
      *
-     * @param string $string A string of the word to send, or NULL to get the
-     *     next word as a string.
+     * @param string|null $string A string of the word to send, or NULL to get
+     *     the next word as a string.
      *
      * @return int|string If a string is provided, returns the number of bytes
      *     sent, otherwise returns the next word as a string.

src/PEAR2/Net/RouterOS/LengthException.php

@@ -25,6 +25,11 @@
  */
 use LengthException as L;
 
+/**
+ * Used in $previous
+ */
+use Exception as E;
+
 /**
  * Exception thrown when there is a problem with a word's length.
  *
@@ -42,23 +47,23 @@ class LengthException extends L implements Exception
     const CODE_BEYOND_SHEME = 1301;
 
     /**
-     * @var mixed The problematic length.
+     * @var int|double|null The problematic length.
      */
     private $_length;
 
     /**
      * Creates a new LengthException.
      *
-     * @param string     $message  The Exception message to throw.
-     * @param int        $code     The Exception code.
-     * @param \Exception $previous The previous exception used for the exception
-     *     chaining.
-     * @param number     $length   The length.
+     * @param string          $message  The Exception message to throw.
+     * @param int             $code     The Exception code.
+     * @param E|null          $previous The previous exception used for the
+     *     exception chaining.
+     * @param int|double|null $length   The length.
      */
     public function __construct(
         $message,
         $code = 0,
-        $previous = null,
+        E $previous = null,
         $length = null
     ) {
         parent::__construct($message, $code, $previous);
@@ -68,7 +73,7 @@ public function __construct(
     /**
      * Gets the length.
      *
-     * @return number The length.
+     * @return int|double|null The length.
      */
     public function getLength()
     {

src/PEAR2/Net/RouterOS/Message.php

@@ -66,8 +66,8 @@ abstract class Message implements IteratorAggregate, Countable
      * function. Depending on the argument given, one of the other functions in
      * the class is invoked and its returned value is returned by this function.
      *
-     * @param string $name The name of an attribute to get the value of, or NULL
-     *     to get the tag.
+     * @param string|null $name The name of an attribute to get the value of,
+     *     or NULL to get the tag.
      *
      * @return string|resource The value of the specified attribute,
      *     or the tag if NULL is provided.

src/PEAR2/Net/RouterOS/NotSupportedException.php

@@ -52,16 +52,16 @@ class NotSupportedException extends E implements Exception
     /**
      * Creates a new NotSupportedException.
      *
-     * @param string     $message  The Exception message to throw.
-     * @param int        $code     The Exception code.
-     * @param \Exception $previous The previous exception used for the exception
+     * @param string $message  The Exception message to throw.
+     * @param int    $code     The Exception code.
+     * @param E|null $previous The previous exception used for the exception
      *     chaining.
-     * @param mixed      $value    The unsupported value.
+     * @param mixed  $value    The unsupported value.
      */
     public function __construct(
         $message,
         $code = 0,
-        $previous = null,
+        E $previous = null,
         $value = null
     ) {
         parent::__construct($message, $code, $previous);

src/PEAR2/Net/RouterOS/Query.php

@@ -74,7 +74,7 @@ class Query
      * This class is not to be instantiated normally, but by static methods
      * instead. Use {@link static::where()} to create an instance of it.
      */
-    private function __construct()
+    protected function __construct()
     {
 
     }

src/PEAR2/Net/RouterOS/Request.php

@@ -50,10 +50,10 @@ class Request extends Message
     /**
      * Creates a request to send to RouterOS.
      *
-     * @param string $command The command to send. Can also contain arguments
-     *     expressed in a shell-like syntax.
-     * @param Query  $query   A query to associate with the request.
-     * @param string $tag     The tag for the request.
+     * @param string      $command The command to send.
+     *     Can also contain arguments expressed in a shell-like syntax.
+     * @param Query|null  $query   A query to associate with the request.
+     * @param string|null $tag     The tag for the request.
      *
      * @see setCommand()
      * @see setArgument()
@@ -177,8 +177,8 @@ public function getCommand()
     /**
      * Sets the query to send with the command.
      *
-     * @param Query $query The query to be set. Setting NULL will remove the
-     *     currently associated query.
+     * @param Query|null $query The query to be set.
+     *     Setting NULL will remove the  currently associated query.
      *
      * @return $this The request object.
      *
@@ -193,7 +193,7 @@ public function setQuery(Query $query = null)
     /**
      * Gets the currently associated query
      *
-     * @return Query The currently associated query.
+     * @return Query|null The currently associated query.
      *
      * @see setQuery()
      */
@@ -208,7 +208,7 @@ public function getQuery()
      * Sets the tag to associate the request with. Setting NULL erases the
      * currently set tag.
      *
-     * @param string $tag The tag to set.
+     * @param string|null $tag The tag to set.
      *
      * @return $this The request object.
      *
@@ -269,8 +269,8 @@ public function removeAllArguments()
     /**
      * Sends a request over a communicator.
      *
-     * @param Communicator $com The communicator to send the request over.
-     * @param Registry     $reg An optional registry to sync the request with.
+     * @param Communicator  $com The communicator to send the request over.
+     * @param Registry|null $reg An optional registry to sync the request with.
      *
      * @return int The number of bytes sent.
      *

src/PEAR2/Net/RouterOS/Response.php

@@ -76,14 +76,14 @@ class Response extends Message
     /**
      * Extracts a new response from a communicator.
      *
-     * @param Communicator $com       The communicator from which to extract
+     * @param Communicator  $com       The communicator from which to extract
      *     the new response.
-     * @param bool         $asStream  Whether to populate the argument values
+     * @param bool          $asStream  Whether to populate the argument values
      *     with streams instead of strings.
-     * @param int          $sTimeout  If a response is not immediately
+     * @param int           $sTimeout  If a response is not immediately
      *     available, wait this many seconds. If NULL, wait indefinitely.
-     * @param int          $usTimeout Microseconds to add to the waiting time.
-     * @param Registry     $reg       An optional registry to sync the
+     * @param int|null      $usTimeout Microseconds to add to the waiting time.
+     * @param Registry|null $reg       An optional registry to sync the
      *     response with.
      *
      * @see getType()
@@ -154,7 +154,7 @@ public function __construct(
      *     available, wait this many seconds. If NULL, wait indefinitely.
      *     Note that if an empty sentence is received, the timeout will be
      *     reset for another sentence receiving.
-     * @param int          $usTimeout Microseconds to add to the waiting time.
+     * @param int|null     $usTimeout Microseconds to add to the waiting time.
      *
      * @return void
      */

src/PEAR2/Net/RouterOS/UnexpectedValueException.php

@@ -20,8 +20,16 @@
  */
 namespace PEAR2\Net\RouterOS;
 
+/**
+ * The base for this exception.
+ */
 use UnexpectedValueException as U;
 
+/**
+ * Used in $previous.
+ */
+use Exception as E;
+
 /**
  * Exception thrown when encountering an invalid value in a function argument.
  *
@@ -45,16 +53,16 @@ class UnexpectedValueException extends U implements Exception
     /**
      * Creates a new UnexpectedValueException.
      *
-     * @param string     $message  The Exception message to throw.
-     * @param int        $code     The Exception code.
-     * @param \Exception $previous The previous exception used for the exception
+     * @param string $message  The Exception message to throw.
+     * @param int    $code     The Exception code.
+     * @param E|null $previous The previous exception used for the exception
      *     chaining.
-     * @param mixed      $value    The unexpected value.
+     * @param mixed  $value    The unexpected value.
      */
     public function __construct(
         $message,
         $code = 0,
-        $previous = null,
+        E $previous = null,
         $value = null
     ) {
         parent::__construct($message, $code, $previous);