Spell check fixes;

Refactored the firewall rule explanation, and made it include the fix from the GitHub wiki.

Author: boenrobot

data/roscon.xml

@@ -21,7 +21,7 @@
     </option>
     <option name="conTime">
         <long_name>--cTimeout</long_name>
-        <description>Time in seconds to wait for the connection to be estabilished. If "--timeout" is specified, its value will be used when this option is not specified.
+        <description>Time in seconds to wait for the connection to be established. If "--timeout" is specified, its value will be used when this option is not specified.
 Defaults to PHP's default_socket_timeout ini option.</description>
         <action>StoreInt</action>
     </option>

scripts/roscon.bat

@@ -7,7 +7,7 @@ REM 4. Whatever %PHP_PEAR_PHP_BIN% points to.
 REM
 REM Once a binary is found, a file is looked for that has the same name as
 REM this batch file.
-REM Prefered extensions are ".php" and then no extension.
+REM Preferred extensions are ".php" and then no extension.
 goto SET_BIN
 :PHP_ERR
 echo PHP interpreter not found. Please set the %%PHPBIN%% or %%PHP_PEAR_PHP_BIN%% environment variable to one, or add one to your %%PATH%%.

scripts/roscon.php

@@ -129,7 +129,6 @@
 // 1. The PHP_PEAR_DATA_DIR environment variable, if available
 // 2. The data folder at "mypear" (filled at install time by Pyrus/PEAR)
 // 3. The source layout's data folder (also used when running in PHAR).
-// NOTE: using dirname(__FILE__) instead of __DIR__ to elegantly support PHAR.
 $dataDir = (false != ($pearDataDir = getenv('PHP_PEAR_DATA_DIR')))
     ? realpath($pearDataDir . '/@PACKAGE_CHANNEL@/@PACKAGE_NAME@')
     : false;
@@ -301,13 +300,24 @@
    to allow you to make outgoing connections to the ip:port you've set the API
    service on.
 
-6. The router has a filter/mangle/nat rule that overrides the settings at
-   "/ip service".
-   This is a very rare scenario, but if you want to be sure, try to disable all
-   rules that may cause such a thing, or (if you can afford it) set up a fresh
-   RouterOS in place of the existing one, and see if you can connect to it
-   instead. If you still can't connect, such a rule is certainly not the (only)
-   reason.
+6. The router has a firewall filter/mangle/nat rule that overrides the settings
+   at "/ip service".
+   Usually, those are rules in the "input" chain.
+   Theoretically, rules in the "prerouting" and/or "output" chains can also
+   have such an effect.
+   By default, RouterBOARD devices have a filter rule in the "input" chain that
+   drops any incoming connections to the router from its WAN interface, so if
+   your web server is not in the LAN, the connection may be dropped because of
+   that.
+   If that's the case, either disable that rule, or explicitly whitelist the
+   API port. You can whitelist the API port on all interfaces by issuing the
+   following command from a terminal:
+   ```
+   /ip firewall filter
+       add place-before=[find where chain="input" && action="drop"] \
+           chain="input" action="accept" \
+           dst-port=[/ip service get "api" "port"]
+   ```
 
 HEREDOC
         );

src/PEAR2/Net/RouterOS/Client.php

@@ -178,7 +178,7 @@ public function __construct(
      * the class is invoked and its returned value is returned by this function.
      * 
      * @param mixed $arg Value can be either a {@link Request} to send, which
-     *     would be sent asynchoniously if it has a tag, and synchroniously if
+     *     would be sent asynchronously if it has a tag, and synchronously if
      *     not, a number to loop with or NULL to complete all pending requests.
      *     Any other value is converted to string and treated as the tag of a
      *     request to complete.
@@ -205,7 +205,7 @@ public function __invoke($arg = null)
      * @param string       $username The RouterOS username.
      * @param string       $password The RouterOS password.
      * @param int|null     $timeout  The time to wait for each response. NULL
-     *     waits indefinetly.
+     *     waits indefinitely.
      * 
      * @return bool TRUE on success, FALSE on failure.
      */
@@ -258,7 +258,7 @@ public static function login(
      * @param string       $password The RouterOS password. Potentially parsed
      *     already by iconv.
      * @param int|null     $timeout  The time to wait for each response. NULL
-     *     waits indefinetly.
+     *     waits indefinitely.
      * 
      * @return bool TRUE on success, FALSE on failure.
      */
@@ -393,7 +393,7 @@ public function sendAsync(Request $request, $callback = null)
      * pending request and/or has responses that are not yet extracted.
      * 
      * @param string $tag    The tag of the request to look for.
-     * @param int    $filter One of the FILTER_* consntants. Limits the search
+     * @param int    $filter One of the FILTER_* constants. Limits the search
      *     to the specified places.
      * 
      * @return bool TRUE if the request is active, FALSE otherwise.
@@ -593,7 +593,7 @@ public function getPendingRequestsCount()
      * Cancels a request.
      * 
      * Cancels an active request. Using this function in favor of a plain call
-     * to the "/cancel" command is highly reccomended, as it also updates the
+     * to the "/cancel" command is highly recommended, as it also updates the
      * counter of pending requests properly. Note that canceling a request also
      * removes any responses for it that were not previously extracted with
      * {@link static::extractNewResponses()}.
@@ -775,8 +775,8 @@ protected function send(Request $request)
      * Dispatches the next response in queue, i.e. it executes the associated
      * callback if there is one, or places the response in the response buffer.
      * 
-     * @param int $sTimeout  If a response is not immediatly available, wait
-     *     this many seconds. If NULL, wait indefinetly.
+     * @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.
      * 
      * @throws SocketException When there's no response within the time limit.

src/PEAR2/Net/RouterOS/Communicator.php

@@ -29,7 +29,7 @@
  * A RouterOS communicator.
  * 
  * Implementation of the RouterOS API protocol. Unlike the other classes in this
- * package, this class doesn't provide any conviniences beyond the low level
+ * package, this class doesn't provide any conveniences beyond the low level
  * implementation details (automatic word length encoding/decoding, charset
  * translation and data integrity), and because of that, its direct usage is
  * strongly discouraged.
@@ -170,7 +170,7 @@ public function __construct(
      *     next word as a string.
      * 
      * @return int|string If a string is provided, returns the number of bytes
-     *     sent, otherwise retuns the next word as a string.
+     *     sent, otherwise returns the next word as a string.
      */
     public function __invoke($string = null)
     {
@@ -310,7 +310,7 @@ public static function seekableStreamLength($stream)
      * used for all future words. When sending, {@link self::CHARSET_LOCAL} is
      * converted to {@link self::CHARSET_REMOTE}, and when receiving,
      * {@link self::CHARSET_REMOTE} is converted to {@link self::CHARSET_LOCAL}.
-     * Setting  NULL to either charset will disable charset convertion, and data
+     * Setting  NULL to either charset will disable charset conversion, and data
      * will be both sent and received "as is".
      * 
      * @param mixed $charset     The charset to set. If $charsetType is
@@ -478,7 +478,7 @@ protected static function verifyLengthSupport($length)
     }
 
     /**
-     * Encodes the length as requred by the RouterOS API.
+     * Encodes the length as required by the RouterOS API.
      * 
      * @param int $length The length to encode.
      * 
@@ -596,9 +596,9 @@ public function getNextWordAsStream()
     }
 
     /**
-     * Decodes the lenght of the incoming message.
+     * Decodes the length of the incoming message.
      * 
-     * Decodes the lenght of the incoming message, as specified by the RouterOS
+     * Decodes the length of the incoming message, as specified by the RouterOS
      * API.
      * 
      * @param T\Stream $trans The transmitter from which to decode the length of
@@ -618,9 +618,9 @@ public static function decodeLength(T\Stream $trans)
     }
 
     /**
-     * Decodes the lenght of the incoming message.
+     * Decodes the length of the incoming message.
      * 
-     * Decodes the lenght of the incoming message, as specified by the RouterOS
+     * Decodes the length of the incoming message, as specified by the RouterOS
      * API.
      * 
      * Difference with the non private function is that this one doesn't perform

src/PEAR2/Net/RouterOS/Message.php

@@ -31,7 +31,7 @@
 use IteratorAggregate;
 
 /**
- * Requred for IteratorAggregate::getIterator() to work properly with foreach.
+ * Required for IteratorAggregate::getIterator() to work properly with foreach.
  */
 use ArrayObject;
 
@@ -49,7 +49,7 @@ abstract class Message implements IteratorAggregate, Countable
 
     /**
      * @var array An array with message attributes. Each array key is the the
-     *     name of an attribute, and the correspding array value is the value
+     *     name of an attribute, and the corresponding array value is the value
      *     for that attribute.
      */
     protected $attributes = array();
@@ -205,7 +205,7 @@ public function count($mode = COUNT_NORMAL)
      *     seekable stream.
      *     Setting the value to NULL removes an argument of this name.
      *     If a seekable stream is provided, it is sent from its current
-     *     posistion to its end, and the pointer is seeked back to its current
+     *     position to its end, and the pointer is seeked back to its current
      *     position after sending.
      *     Non seekable streams, as well as all other types, are casted to a
      *     string.

src/PEAR2/Net/RouterOS/NotSupportedException.php

@@ -41,7 +41,7 @@ class NotSupportedException extends E implements Exception
     const CODE_CONTROL_BYTE = 1601;
 
     /**
-     * @var mixed The unsuppported value.
+     * @var mixed The unsupported value.
      */
     private $_value;
 

src/PEAR2/Net/RouterOS/Query.php

@@ -58,7 +58,7 @@ class Query
     const OP_LT = '<';
 
     /**
-     * Checks if the property is greather than a certain value.
+     * Checks if the property is greater than a certain value.
      */
     const OP_GT = '>';
 
@@ -112,7 +112,7 @@ protected static function sanitizeOperator($operator)
      * @param string|resource|null $value    Value of the property as a string
      *     or seekable stream. Not required for existence tests.
      *     If a seekable stream is provided, it is sent from its current
-     *     posistion to its end, and the pointer is seeked back to its current
+     *     position to its end, and the pointer is seeked back to its current
      *     position after sending.
      *     Non seekable streams, as well as all other types, are casted to a
      *     string.
@@ -148,7 +148,7 @@ public function not()
      * @param string|resource|null $value    Value of the property as a string
      *     or seekable stream. Not required for existence tests.
      *     If a seekable stream is provided, it is sent from its current
-     *     posistion to its end, and the pointer is seeked back to its current
+     *     position to its end, and the pointer is seeked back to its current
      *     position after sending.
      *     Non seekable streams, as well as all other types, are casted to a
      *     string.
@@ -170,7 +170,7 @@ public function orWhere($name, $value = null, $operator = self::OP_EX)
      * @param string|resource|null $value    Value of the property as a string
      *     or seekable stream. Not required for existence tests.
      *     If a seekable stream is provided, it is sent from its current
-     *     posistion to its end, and the pointer is seeked back to its current
+     *     position to its end, and the pointer is seeked back to its current
      *     position after sending.
      *     Non seekable streams, as well as all other types, are casted to a
      *     string.
@@ -246,7 +246,7 @@ private function _send(Communicator $com)
      * @param string|resource|null $value    Value of the property as a string
      *     or seekable stream. Not required for existence tests.
      *     If a seekable stream is provided, it is sent from its current
-     *     posistion to its end, and the pointer is seeked back to its current
+     *     position to its end, and the pointer is seeked back to its current
      *     position after sending.
      *     Non seekable streams, as well as all other types, are casted to a
      *     string.

src/PEAR2/Net/RouterOS/Registry.php

@@ -118,7 +118,7 @@ public function isTaglessModeOwner()
     /**
      * Sets the "tagless mode" setting.
      * 
-     * While in tagless mode, this instance will claim owhership of any
+     * While in tagless mode, this instance will claim ownership of any
      * responses without a tag. While not in this mode, any requests without a
      * tag will be given to all instances.
      * 

src/PEAR2/Net/RouterOS/Request.php

@@ -222,7 +222,7 @@ public function setTag($tag)
      *     seekable stream.
      *     Setting the value to NULL removes an argument of this name.
      *     If a seekable stream is provided, it is sent from its current
-     *     posistion to its end, and the pointer is seeked back to its current
+     *     position to its end, and the pointer is seeked back to its current
      *     position after sending.
      *     Non seekable streams, as well as all other types, are casted to a
      *     string.