Removed Message::getAllArguments() in favor of Message::getIterator()@IteratorAggregate;

Changed Message::__invoke() with no arguments to be a shortcut of getTag();
Added Message::count()@countable;
Added .scrutinizer.yml;
Minor clean ups and polishes.

Author: boenrobot

.scrutinizer.yml

@@ -0,0 +1,9 @@
+imports:
+    - php
+inherit: true
+tools:
+    php_sim: false
+    php_cpd: true
+    php_code_sniffer:
+        config:
+            standard: PEAR

RELEASE-1.0.0b5

@@ -1,14 +1,19 @@
 Console and some overall improvements.
 
 * The PHAR file is now also a console. When installed, the console is available from the executable "roscon".
+* __BREAKING CHANGES:__
+    - Removed Message::getAllArguments() in favor of IteratorAggregate implementation that returns an ArrayObject. For most intents and purposes, you should be able to just search&replace "->getAllArguments()" with an empty string (that will implicitly call getIterator()). If you require the arguments as a "real" array, you can replace "->getAllArguments()" with "->getIterator()->getArrayCopy()".
+    - Message::\_\_invoke() without arguments is now a shortcut for getTag() instead of getting all arguments.
+    - Util::changeMenu() now returns the Util object itself, except when you supply an empty string, when the current menu is returned (as before).
 * New Util methods:
     - getall()
     - count()
     - prepareScript()
+* Message now implements Countable, reporting the number of arguments.
 * Util::get() now uses RouterOS' "get" command, unless it returns an empty !done response (as it does for RouterOS versions prior to 6.0), in which case it automatically fallbacks to a print with a query.
 * Util::escapeValue() and Util::parseValue() now support associative arrays (introduced in RouterOS 6.2).
+* Util::escapeValue() now correctly converts DateTime objects to DateInterval objects relative to UNIX epoch time in UTC. Previously, the current time zone was used instead of UTC.
 * Util::add() and Util::set()/Util::edit() now support flags as values with a numeric key.
-* Util::changeMenu() now returns the Util object itself, except when you supply an empty string, when the current menu is returned (as before).
 * ResponseCollection can now be searched by argument values, if you first designate an argument name with the new ResponseCollection::setIndex() method.
 * ResponseCollection can now produce a sorted response collection based on user defined criteria using the new ResponseCollection::orderBy() method.
 * Doc fixes (Notably: Clarified the acceptability of seekable streams as argument values, which has been present for a long time, but never documented).

packagexmlsetup.php

@@ -96,9 +96,7 @@
 ) {
 
     $tasksNs = $package->getTasksNs();
-    if ($compatible) {
-        $cTasksNs = $compatible->getTasksNs();
-    }
+    $cTasksNs = $compatible ? $compatible->getTasksNs() : '';
 
     $oldCwd = getcwd();
     chdir(__DIR__);

src/PEAR2/Net/RouterOS/Client.php

@@ -30,6 +30,11 @@
  */
 use PEAR2\Net\Transmitter\NetworkStream as N;
 
+/**
+ * Catches arbitrary exceptions at some points.
+ */
+use Exception as E;
+
 /**
  * A RouterOS client.
  * 
@@ -228,7 +233,7 @@ public static function login(
                 return $result;
             }
             return self::_login($com, $username, $password, $timeout);
-        } catch (\Exception $e) {
+        } catch (E $e) {
             if ($com->getTransmitter()->isPersistent() && null !== $old) {
                 $com->getTransmitter()->lock($old, true);
             }
@@ -596,7 +601,7 @@ public function getPendingRequestsCount()
      * @param string $tag Tag of the request to cancel. Setting NULL will cancel
      *     all requests.
      * 
-     * @return self|Client The client object.
+     * @return $this The client object.
      * @see sendAsync()
      * @see close()
      */
@@ -710,7 +715,7 @@ public function close()
                 if (null !== $this->registry) {
                     $this->registry->setTaglessMode(false);
                 }
-                $result = $response->getType() === Response::TYPE_FATAL;
+                $result = $response[0]->getType() === Response::TYPE_FATAL;
             }
             $result = $result && $this->com->close();
         } catch (SocketException $e) {
@@ -744,7 +749,7 @@ public function __destruct()
      * 
      * @param Request $request The request to send.
      * 
-     * @return self|Client The client object.
+     * @return $this The client object.
      * @see sendSync()
      * @see sendAsync()
      */

src/PEAR2/Net/RouterOS/Message.php

@@ -20,6 +20,21 @@
  */
 namespace PEAR2\Net\RouterOS;
 
+/**
+ * Implements this interface.
+ */
+use Countable;
+
+/**
+ * Implements this interface.
+ */
+use IteratorAggregate;
+
+/**
+ * Requred for IteratorAggregate::getIterator() to work properly with foreach.
+ */
+use ArrayObject;
+
 /**
  * Represents a RouterOS message.
  * 
@@ -29,7 +44,7 @@
  * @license  http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
  * @link     http://pear2.php.net/PEAR2_Net_RouterOS
  */
-abstract class Message
+abstract class Message implements IteratorAggregate, Countable
 {
 
     /**
@@ -59,7 +74,7 @@ abstract class Message
     public function __invoke($name = null)
     {
         if (null === $name) {
-            return $this->getAllArguments();
+            return $this->getTag();
         }
         return $this->getArgument($name);
     }
@@ -120,7 +135,7 @@ public function getTag()
      * 
      * @param string $tag The tag to set.
      * 
-     * @return self|Message The message object.
+     * @return $this The message object.
      * @see getTag()
      */
     protected function setTag($tag)
@@ -150,14 +165,24 @@ public function getArgument($name)
     /**
      * Gets all arguments in an array.
      * 
-     * @return array An array with the keys as argument names, and the array
-     *     values as argument values.
+     * @return ArrayObject An ArrayObject with the keys being argument names,
+     *     and the array values being argument values.
      * @see getArgument()
      * @see setArgument()
      */
-    public function getAllArguments()
+    public function getIterator()
+    {
+        return new ArrayObject($this->arguments);
+    }
+
+    /**
+     * Counts the number of arguments.
+     * 
+     * @return int The number of arguments.
+     */
+    public function count()
     {
-        return $this->arguments;
+        return count($this->arguments);
     }
 
     /**
@@ -173,7 +198,7 @@ public function getAllArguments()
      *     Non seekable streams, as well as all other types, are casted to a
      *     string.
      * 
-     * @return self|Message The message object.
+     * @return $this The message object.
      * @see getArgument()
      */
     protected function setArgument($name, $value = '')
@@ -190,7 +215,7 @@ protected function setArgument($name, $value = '')
     /**
      * Removes all arguments from the message.
      * 
-     * @return self|Message The message object.
+     * @return $this The message object.
      */
     protected function removeAllArguments()
     {

src/PEAR2/Net/RouterOS/Query.php

@@ -114,7 +114,7 @@ protected static function sanitizeAction($action)
      * @param string $action One of the ACTION_* constants. Describes the
      *     operation to perform.
      * 
-     * @return static The query object.
+     * @return static A new query object.
      */
     public static function where(
         $name,

src/PEAR2/Net/RouterOS/Request.php

@@ -299,7 +299,7 @@ private function _send(Communicator $com)
         if (null !== ($tag = $this->getTag())) {
             $bytes += $com->sendWord('.tag=' . $tag);
         }
-        foreach ($this->getAllArguments() as $name => $value) {
+        foreach ($this->arguments as $name => $value) {
             $prefix = '=' . $name . '=';
             if (is_string($value)) {
                 $bytes += $com->sendWord($prefix . $value);

src/PEAR2/Net/RouterOS/Response.php

@@ -228,7 +228,7 @@ private function _receive(
      * 
      * @param string $type The new response type.
      * 
-     * @return self|Response The response object.
+     * @return $this The response object.
      * @see getType()
      */
     protected function setType($type)

src/PEAR2/Net/RouterOS/ResponseCollection.php

@@ -43,6 +43,19 @@
  * @author   Vasil Rangelov <boen.robot@gmail.com>
  * @license  http://www.gnu.org/copyleft/lesser.html LGPL License 2.1
  * @link     http://pear2.php.net/PEAR2_Net_RouterOS
+ * 
+ * @method string getType()
+ *     Calls {@link Response::getType()}
+ *     on the response pointed by the pointer.
+ * @method string getUnrecognizedWords()
+ *     Calls {@link Response::getUnrecognizedWords()}
+ *     on the response pointed by the pointer.
+ * @method string getArgument(string $name)
+ *     Calls {@link Response::getArgument()}
+ *     on the response pointed by the pointer.
+ * @method string getTag()
+ *     Calls {@link Response::getTag()}
+ *     on the response pointed by the pointer.
  */
 class ResponseCollection implements ArrayAccess, SeekableIterator, Countable
 {
@@ -380,7 +393,8 @@ public function getArgumentMap()
         if (null === $this->argumentMap) {
             $arguments = array();
             foreach ($this->responses as $index => $response) {
-                foreach (array_keys($response->getAllArguments()) as $name) {
+                $names = array_keys($response->getIterator()->getArrayCopy());
+                foreach ($names as $name) {
                     if (!isset($arguments[$name])) {
                         $arguments[$name] = array();
                     }

tests/Client/Safe.php

@@ -774,8 +774,8 @@ public function testStreamEquality()
         );
 
         foreach ($list as $index => $response) {
-            $streamListArgs = $streamList[$index]->getAllArguments();
-            foreach ($response->getAllArguments() as $argName => $value) {
+            $streamListArgs = $streamList[$index]->getIterator();
+            foreach ($response as $argName => $value) {
                 $this->assertArrayHasKey(
                     $argName,
                     $streamListArgs,