rugk / xenforo-threema-gateway

src/library/ThreemaGateway/Model/Messages.php

Doc Comments +7 added lines, -8 removed lines

@@ -84,8 +84,8 @@ 
      * option call it this way: injectFetchOption('where', []).
      *
      * @param string $option The option name to inject
-     * @param mixed  $value  The value of the option to set.
-     * @param mixed  $append If set to true, the value is not overriden, but
+     * @param string  $value  The value of the option to set.
+     * @param boolean  $append If set to true, the value is not overriden, but
      *                       just appended as an array. (default: false)
      */
     public function injectFetchOption($option, $value, $append = false)
@@ -147,7 +147,7 @@ 
      * If you want to limit the types you want to query this method would be a
      * good way for you to use.
      *
-     * @param string $typeCode one (string) or more (array) mtype codes
+     * @param string $typeCodes one (string) or more (array) mtype codes
      */
     public function setTypeCode($typeCodes)
     {
@@ -197,7 +197,6 @@ 
      * Limit the result to a number of datasets.
      *
      * @param int $limit    oldest date of messages
-     * @param int $date_max latest date of messages (optional)
      */
     public function setResultLimit($limit)
     {
@@ -518,9 +517,9 @@ 
      * submit additional conditions with the first parameter.
      * Attention: This ignores the limit/offset clause for simplicity.
      *
-     * @param array $additionalConditions Add additional where conditions if
+     * @param string[] $additionalConditions Add additional where conditions if
      *                                    neccessary.
-     * @param array $removeOnlyField      When set only the passed fields are
+     * @param string[] $removeOnlyField      When set only the passed fields are
      *                                    updated to "null" rather than deleting
      *                                    the whole record.
      */
@@ -582,7 +581,7 @@ 
      *
      * @param array $baseArray  the main array, where the key/value pairs get to
      * @param array $subArray   the array, which keys should be removed
-     * @param array $removeKeys an array of keys, which should be removed
+     * @param string[] $removeKeys an array of keys, which should be removed
      *
      * @throws XenForo_Exception
      * @return false|array
@@ -611,7 +610,7 @@ 
      * Groups an array by using the value of a specific index in it.
      *
      * @param array      $array       the array, which is sued as the base
-     * @param string|int $indexKey    the value of the key, which should be used
+     * @param string $indexKey    the value of the key, which should be used
      *                                for indexing
      * @param bool       $ignoreIndex Set to true to ignore multiple values in
      *                                $array. If activated only the last key of

src/library/ThreemaGateway/Option/ReceiveCallback.php

Doc Comments -1 removed lines

@@ -50,7 +50,6 @@
     /**
      * Verifies whether the dir of the file is valid (can be created) and is writable.
      *
-     * @param string             $filepath  Input
      * @param XenForo_DataWriter $dw
      * @param string             $fieldName Name of field/option
      *

src/library/ThreemaGateway/Option/ThreemaGatewaySecret.php

Doc Comments -1 removed lines

@@ -53,7 +53,6 @@
     /**
      * Verifies the Threema Gateway Secret format.
      *
-     * @param string             $threemaid Input threema ID
      * @param XenForo_DataWriter $dw
      * @param string             $fieldName Name of field/option
      *

src/library/ThreemaGateway/Tfa/AbstractProvider.php

Doc Comments -4 removed lines

@@ -207,9 +207,7 @@ 
      * Currently this is not correctly implemented in XenForo.
      * See {@link https://xenforo.com/community/threads/1-5-documentation-for-two-step-authentication.102846/#post-1031047}
      *
-     * @param XenForo_Input $input
      * @param array         $user
-     * @param array         $error
      *
      * @return string HTML code
      */
@@ -392,8 +390,6 @@ 
     /**
      * Called when verifying displaying the choose 2FA mode.
      *
-     * @param array  $user
-     * @param object $error
      *
      * @return bool
      */

Indentation +2 added lines, -2 removed lines

@@ -422,8 +422,8 @@
     abstract protected function generateDefaultData();
 
     /**
-    * Adjust the view params for managing the 2FA mode, e.g. add special
-    * params needed by your template.
+     * Adjust the view params for managing the 2FA mode, e.g. add special
+     * params needed by your template.
      *
      * @param array  $viewParams
      * @param string $context

Spacing +1 added lines, -1 removed lines

@@ -726,7 +726,7 @@
             $displayTime = floor($hours / 24) . ' ' . new XenForo_Phrase('threemagw_days');
         }
 
-        return (string)$displayTime;
+        return (string) $displayTime;
     }
 
     /**

src/library/ThreemaGateway/Installer/TfaProvider.php

Indentation +1 added lines, -1 removed lines

@@ -55,7 +55,7 @@
         $db->query('INSERT INTO `xf_tfa_provider`
                   (`provider_id`, `provider_class`, `priority`, `active`)
                   VALUES (?, ?, ?, ?)',
-                  [$this->TfaId, $this->TfaClass, $this->TfaPriority, (int) $enabled]);
+                    [$this->TfaId, $this->TfaClass, $this->TfaPriority, (int) $enabled]);
     }
 
     /**

src/library/ThreemaGateway/Handler/Action/GatewayServer.php

Spacing +2 added lines, -2 removed lines

@@ -59,7 +59,7 @@ 
     public function lookupMail($mail)
     {
         // check permission
-        if (! $this->permissions->hasPermission('lookup')) {
+        if (!$this->permissions->hasPermission('lookup')) {
             throw new XenForo_Exception(new XenForo_Phrase('threemagw_permission_error'));
         }
 
@@ -86,7 +86,7 @@ 
     public function getCapabilities($threemaId)
     {
         // check permission
-        if (! $this->permissions->hasPermission('lookup')) {
+        if (!$this->permissions->hasPermission('lookup')) {
             throw new XenForo_Exception(new XenForo_Phrase('threemagw_permission_error'));
         }
 

src/library/ThreemaGateway/Handler/Permissions.php

Indentation +1 added lines, -1 removed lines

@@ -131,7 +131,7 @@
         // check whether visitor is user
         /** @var bool $userIsAlreadyVisitor Whether the new user is already the default user and the
                         old user is the default user too.
-        */
+         */
         $userIsAlreadyVisitor = $this->userIsDefault($newUser) && $this->userIsDefault($oldUserId);
         // prevent unnecessary changes
         if ($oldUserId == $newUserId || $userIsAlreadyVisitor) {

src/library/ThreemaGateway/Helper/Message.php

Spacing +2 added lines, -2 removed lines

@@ -57,9 +57,9 @@
     public static function getOldestPossibleReplayAttackDate()
     {
         /** @var XenForo_Options $options */
-        $options   = XenForo_Application::getOptions();
+        $options = XenForo_Application::getOptions();
         /** @var int $rejectOlDefault the default maximum age of a message according*/
-        $rejectOlDefault = strtotime('-14 days', XenForo_Application::$time);;
+        $rejectOlDefault = strtotime('-14 days', XenForo_Application::$time); ;
         /** @var int $rejectOld the maximum age of a message according to the options */
         $rejectOldOption = '';
         if ($options->threema_gateway_verify_receive_time && $options->threema_gateway_verify_receive_time['enabled']) {

src/library/ThreemaGateway/Helper/Emoji.php

Indentation +12 added lines, -12 removed lines

@@ -8,17 +8,17 @@ 
  * @license MIT
  */
 
- class ThreemaGateway_Helper_Emoji
- {
-     /**
-     * Replaces unicode escape sequence with the correct UNICODE character.
-     *
-     * XenForo template helper: emojiparseunicode.
-     * You need to pass it as surrogate pairs, e.g. \ud83d\udd11.
-     *
-     * @param  string $string
-     * @return string
-     */
+    class ThreemaGateway_Helper_Emoji
+    {
+        /**
+         * Replaces unicode escape sequence with the correct UNICODE character.
+         *
+         * XenForo template helper: emojiparseunicode.
+         * You need to pass it as surrogate pairs, e.g. \ud83d\udd11.
+         *
+         * @param  string $string
+         * @return string
+         */
     public static function parseUnicode($string)
     {
         // uses json_decode as a hackish way to encode unicode strings
@@ -47,4 +47,4 @@ 
         // https://regex101.com/r/aQ3eA3/1
         return preg_replace('/(\d)/', '\1\\u20e3', $string);
     }
- }
+    }

Spacing +1 added lines, -1 removed lines

@@ -25,7 +25,7 @@
         // https://stackoverflow.com/questions/6058394/unicode-character-in-php-string
 
         // RegEx: https://regex101.com/r/yS2zX8/3
-        return preg_replace_callback('/(\\\\u([0-9a-fA-F]{4}))+/', function ($match) {
+        return preg_replace_callback('/(\\\\u([0-9a-fA-F]{4}))+/', function($match) {
             return json_decode('"' . $match[0] . '"');
         }, $string);
     }