rugk / xenforo-threema-gateway

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

Doc Comments +2 added lines, -1 removed lines

@@ -296,6 +296,7 @@ 
      *
      * @param array|string $log         string or array
      * @param string       $stringToAdd
+     * @param string $stringToAddDetail
      */
     public function addLog(&$log, $stringToAdd, $stringToAddDetail = null)
     {
@@ -358,7 +359,7 @@ 
      * In case nothing could be found, this returns "null".
      *
      * @param  string            $key
-     * @return string|array|null
+     * @return string
      */
     public function getRequest($key = null)
     {

src/library/ThreemaGateway/Handler/Action/TfaCallback/Abstract.php

Doc Comments +1 added lines, -3 removed lines

@@ -263,7 +263,6 @@ 
      * @param mixed $filterData  any data the filter uses
      * @param bool  $failOnError whether the filter should fail on errors (true)
      *                           or silently ignore them (false)
-     * @param bool  $saveMessage
      */
     public function addFilter($filterType, $filterData, $failOnError = true)
     {
@@ -332,7 +331,6 @@ 
      *
      * @param array $confirmRequest the confirm request
      * @param array $providerData   old data read
-     * @param array $setData        new data to set
      * @param array $processOptions custom options (optional)
      *
      * @throws XenForo_Exception
@@ -351,7 +349,7 @@ 
      * essential!
      *
      * @throws XenForo_Exception
-     * @return bool
+     * @return false|null
      */
     protected function preProcessPending()
     {

src/library/ThreemaGateway/Handler/Action/TfaCallback/TextMessage.php

Doc Comments +1 added lines, -1 removed lines

@@ -89,7 +89,7 @@
      * Returns "false" if the process should be canceled. Otherwise "true".
      *
      * @throws XenForo_Exception
-     * @return bool
+     * @return false|null
      */
     protected function preProcessPending()
     {

src/library/ThreemaGateway/Handler/Settings.php

Doc Comments +1 added lines, -1 removed lines

@@ -250,7 +250,7 @@
      * Checks whether the string actually is a private key.
      *
      * @param  string $privateKey The string to check.
-     * @return bool
+     * @return integer
      */
     protected function isPrivateKey($privateKey)
     {

src/library/ThreemaGateway/Helper/Key.php

Doc Comments +2 added lines, -3 removed lines

@@ -60,8 +60,7 @@ 
      *
      * XenForo template helper: threemaisvalidpubkey.
      *
-     * @param  string $threemaid Threema ID
-     * @return string
+     * @return integer
      */
     public static function checkPublic($pubKey)
     {
@@ -76,7 +75,7 @@ 
      * @param string the public key
      * @param string optional suffix (usually 'private:' or 'public:') (default: '')
      *
-     * @return bool whether the key is valid (true) or not (false)
+     * @return integer whether the key is valid (true) or not (false)
      */
     public static function check($publicKey, $suffix = '')
     {

src/library/ThreemaGateway/Helper/Random.php

Doc Comments +1 added lines, -1 removed lines

@@ -86,7 +86,7 @@
      * Generates some random bytes.
      *
      * @link https://paragonie.com/book/pecl-libsodium/read/02-random-data.md
-     * @param  int    $bytes Number of bytes to return
+     * @param integer $number
      * @return string
      */
     public static function getRandomBytes($number)

Spacing +1 added lines, -1 removed lines

@@ -61,7 +61,7 @@
     public static function getRandomString($length, $keyspace = 'abcdefghijklmnopqrstuvwxyz01234567')
     {
         /** @var string $output */
-        $output  = '';
+        $output = '';
         if (self::canUseLibsodium()) {
             /** @var int $keysize */
             $keysize = strlen($keyspace);

src/library/ThreemaGateway/Installer/Permissions.php

Doc Comments +1 added lines, -1 removed lines

@@ -26,7 +26,7 @@
      *                                   2 = registered
      *                                   3 = administrator
      *                                   4 = moderator
-     * @param string $applyPermissionId  The permission id
+     * @param string $permissionId  The permission id
      * @param string $permissionValue    (optional) The value of the permission: allow, deny
      *                                   use_int
      * @param int    $permissionValueInt (optional) When using an integer (use_int)

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/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
      */