Added Util::newRequest(), with a test for it;

CS fix in Response.

Author: boenrobot

docs/wiki

@@ -39,6 +39,8 @@ class NotSupportedException extends E implements Exception
 {
 
     const CODE_CONTROL_BYTE = 1601;
+    
+    const CODE_MENU_MISMATCH = 60000; 
 
     /**
      * @var mixed The unsupported value.

src/PEAR2/Net/RouterOS/NotSupportedException.php

@@ -276,7 +276,7 @@ public function getType()
      * @return string|resource|null The value of the specified argument.
      *     Returns NULL if such an argument is not set.
      *
-     * @deprecated 1.0.0b5 Use {@link static::getProperty()} instead.
+     * @deprecated         1.0.0b5 Use {@link static::getProperty()} instead.
      *     This method will be removed upon final release, and is currently
      *     left standing merely because it can't be easily search&replaced in
      *     existing code, due to the fact the name "getArgument()" is shared

src/PEAR2/Net/RouterOS/Response.php

@@ -417,7 +417,7 @@ public function __construct(Client $client)
     /**
      * Gets the current menu.
      *
-     * @return string The current menu.
+     * @return string The absolute path to current menu, using API syntax.
      */
     public function getMenu()
     {
@@ -457,6 +457,50 @@ public function setMenu($newMenu)
         return $this;
     }
 
+    /**
+     * Creates a Request object.
+     * 
+     * Creates a {@link Request} object, with a command that's relative to the
+     * current menu. The request can then be sent using {@link Client}.
+     * 
+     * @param string      $command The command of the request, not including
+     *     the menu. The request will have that command at the current menu.
+     * @param array       $args    Arguments of the request.
+     *     Follows the same rules as with {@link Util::getAll()}.
+     * @param Query|null  $query   The {@link Query} of the request.
+     * @param string|null $tag     The tag of the request.
+     * 
+     * @return Request The {@link Request} object.
+     * 
+     * @throws NotSupportedException On an attempt to call a command in a
+     *     different menu.
+     */
+    public function newRequest(
+        $command,
+        array $args = array(),
+        Query $query = null,
+        $tag = null
+    ) {
+        if (false !== strpos($command, '/')) {
+            throw new NotSupportedException(
+                'Command tried to go to a different menu',
+                NotSupportedException::CODE_MENU_MISMATCH,
+                null,
+                $command
+            );
+        }
+        $request = new Request('/menu', $query, $tag);
+        $request->setCommand("{$this->menu}/{$command}");
+        foreach ($args as $name => $value) {
+            if (is_int($name)) {
+                $request->setArgument($value);
+            } else {
+                $request->setArgument($name, $value);
+            }
+        }
+        return $request;
+    }
+
     /**
      * Executes a RouterOS script.
      *

src/PEAR2/Net/RouterOS/Util.php

@@ -3,6 +3,8 @@
 namespace PEAR2\Net\RouterOS\Test\Util;
 
 use PEAR2\Net\RouterOS\Client;
+use PEAR2\Net\RouterOS\NotSupportedException;
+use PEAR2\Net\RouterOS\InvalidArgumentException;
 use PEAR2\Net\RouterOS\Query;
 use PEAR2\Net\RouterOS\Request;
 use PEAR2\Net\RouterOS\Response;
@@ -57,6 +59,72 @@ public function testSetGetMenu()
         );
     }
 
+    public function testNewRequest()
+    {
+        //Simple request
+        $request = $this->util->setMenu('/queue simple')->newRequest('print');
+        $this->assertInstanceOf(ROS_NAMESPACE . '\Request', $request);
+        $this->assertSame('/queue/simple/print', $request->getCommand());
+        $this->assertEmpty($request->getIterator()->getArrayCopy());
+        $this->assertNull($request->getQuery());
+        $this->assertNull($request->getTag());
+
+        //Complex request
+        $request = $this->util->setMenu('/queue simple')->newRequest(
+            'print',
+            array('detail', 'from'=> TEST_QUEUE_NAME),
+            Query::where('target', HOSTNAME_INVALID . '/32'),
+            'test'
+        );
+        $this->assertInstanceOf(ROS_NAMESPACE . '\Request', $request);
+        $this->assertSame('/queue/simple/print', $request->getCommand());
+        $this->assertSame(
+            array(
+                'detail' => '',
+                'from'=> TEST_QUEUE_NAME
+            ),
+            $request->getIterator()->getArrayCopy()
+        );
+        $this->assertInstanceOf(ROS_NAMESPACE . '\Query', $request->getQuery());
+        $this->assertSame('test', $request->getTag());
+
+        //Failed request (API syntax)
+        try {
+            $request = $this->util->setMenu('/queue simple')->newRequest(
+                '../tree/print',
+                array('detail'),
+                Query::where('target', HOSTNAME_INVALID . '/32'),
+                'test'
+            );
+            $this->fail('Exception for invalid request not thrown');
+        } catch (NotSupportedException $e) {
+            $this->assertSame(
+                NotSupportedException::CODE_MENU_MISMATCH,
+                $e->getCode()
+            );
+            $this->assertSame(
+                '../tree/print',
+                $e->getValue()
+            );
+        }
+        
+        //Failed request (CLI syntax)
+        try {
+            $request = $this->util->setMenu('/queue simple')->newRequest(
+                '.. tree print',
+                array('detail'),
+                Query::where('target', HOSTNAME_INVALID . '/32'),
+                'test'
+            );
+            $this->fail('Exception for invalid request not thrown');
+        } catch (InvalidArgumentException $e) {
+            $this->assertSame(
+                InvalidArgumentException::CODE_CMD_INVALID,
+                $e->getCode()
+            );
+        }
+    }
+
     public function testFindByQuery()
     {
         $this->util->setMenu('/queue/simple');