rugk / xenforo-threema-gateway

docs/examples/MessageCallback.php

Doc Comments -1 removed lines

@@ -61,7 +61,6 @@
      * @param Threema\MsgApi\Helpers\ReceiveMessageResult $receiveResult
      * @param Threema\MsgApi\Messages\ThreemaMessage      $threemaMsg
      * @param array|string                                $output        [$logType, $debugLog, $publicLog]
-     * @param bool                                        $saveMessage
      * @param bool                                        $debugMode
      */
     public static function testCallbackPostSave(ThreemaGateway_Handler_Action_Callback $handler,

src/library/ThreemaGateway/DataWriter/Messages.php

Doc Comments +1 added lines, -1 removed lines

@@ -261,7 +261,7 @@
      * Gets SQL condition to update the existing record.
      *
      * @see XenForo_DataWriter::_getUpdateCondition()
-     * @return bool
+     * @return string
      */
     protected function _getUpdateCondition($tableName)
     {

Spacing +4 added lines, -4 removed lines

@@ -397,7 +397,7 @@ 
                 /** @var array $tableFields fields of table "files" */
                 $tableFields = $this->_getFields()[ThreemaGateway_Model_Messages::DB_TABLE_FILES];
                 // remove keys, which are automatically set
-                unset($tableFields['file_id']);  // (auto increment)
+                unset($tableFields['file_id']); // (auto increment)
                 unset($tableFields['is_saved']); // (default value=1)
                 // we do only care about the keys
                 /** @var array $tableKeys extracted keys from fields */
@@ -405,7 +405,7 @@ 
 
                 // create insert query for this item
                 $this->_db->query('INSERT INTO `' . ThreemaGateway_Model_Messages::DB_TABLE_FILES . '`
-                    ( `' . implode('`, `',  $tableKeys) . '`)
+                    ( `' . implode('`, `', $tableKeys) . '`)
                     VALUES (' . implode(', ', array_fill(0, count($tableKeys), '?')) . ')', // only (?, ?, ...)
                     [
                         $this->get('message_id'), //message_id
@@ -428,7 +428,7 @@ 
 
                 // create insert query for this item
                 $this->_db->query('INSERT INTO `' . ThreemaGateway_Model_Messages::DB_TABLE_DELIVERY_RECEIPT . '`
-                    ( `' . implode('`, `',  $tableKeys) . '`)
+                    ( `' . implode('`, `', $tableKeys) . '`)
                     VALUES (' . implode(', ', array_fill(0, count($tableKeys), '?')) . ')', // only (?, ?, ...)
                     [
                         $this->get('message_id'), //message_id
@@ -472,7 +472,7 @@ 
 
         // remove values from database
         $this->_db->query('UPDATE `' . ThreemaGateway_Model_Messages::DB_TABLE_MESSAGES . '`
-            SET `' . implode('`=null, `',  $tableKeys) . '`=null,
+            SET `' . implode('`=null, `', $tableKeys) . '`=null,
             `date_received`=' . $this->_db->quote($this->getRoundedReceiveDate()) . '
             WHERE ' . $this->getUpdateCondition(ThreemaGateway_Model_Messages::DB_TABLE_MESSAGES));
     }

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()
     {

Indentation +29 added lines, -29 removed lines

@@ -85,35 +85,35 @@
      */
     protected $pendingRequests;
 
-   /**
-    * Checks whether text messages contain code used for the receiver 2FA.
-    *
-    * You should set the "event hint" to "1" to only pass text messages to the
-    * listener. Otherwise errors may happen.
-    *
-    * @param ThreemaGateway_Handler_Action_Callback      $handler
-    * @param Threema\MsgApi\Helpers\ReceiveMessageResult $receiveResult
-    * @param Threema\MsgApi\Messages\ThreemaMessage      $threemaMsg
-    * @param array|string                                $output        [$logType, $debugLog, $publicLog]
-    * @param bool                                        $saveMessage
-    * @param bool                                        $debugMode
-    *
-    * @throws XenForo_Exception
-    */
-   public function __construct(ThreemaGateway_Handler_Action_Callback $handler,
-                               Threema\MsgApi\Helpers\ReceiveMessageResult $receiveResult,
-                               Threema\MsgApi\Messages\ThreemaMessage $threemaMsg,
-                               &$output,
-                               &$saveMessage,
-                               $debugMode)
-   {
-       $this->callback              = $handler;
-       $this->log                   = $output;
-       $this->receiveResult         = $receiveResult;
-       $this->threemaMsg            = $threemaMsg;
-       $this->saveMessage           = $saveMessage;
-       $this->debugMode             = $debugMode;
-   }
+    /**
+     * Checks whether text messages contain code used for the receiver 2FA.
+     *
+     * You should set the "event hint" to "1" to only pass text messages to the
+     * listener. Otherwise errors may happen.
+     *
+     * @param ThreemaGateway_Handler_Action_Callback      $handler
+     * @param Threema\MsgApi\Helpers\ReceiveMessageResult $receiveResult
+     * @param Threema\MsgApi\Messages\ThreemaMessage      $threemaMsg
+     * @param array|string                                $output        [$logType, $debugLog, $publicLog]
+     * @param bool                                        $saveMessage
+     * @param bool                                        $debugMode
+     *
+     * @throws XenForo_Exception
+     */
+    public function __construct(ThreemaGateway_Handler_Action_Callback $handler,
+                                Threema\MsgApi\Helpers\ReceiveMessageResult $receiveResult,
+                                Threema\MsgApi\Messages\ThreemaMessage $threemaMsg,
+                                &$output,
+                                &$saveMessage,
+                                $debugMode)
+    {
+        $this->callback              = $handler;
+        $this->log                   = $output;
+        $this->receiveResult         = $receiveResult;
+        $this->threemaMsg            = $threemaMsg;
+        $this->saveMessage           = $saveMessage;
+        $this->debugMode             = $debugMode;
+    }
 
     /**
      * Prepare the message handling.

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

Doc Comments +1 added lines, -1 removed lines

@@ -97,7 +97,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/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/PhpSdk.php

Doc Comments +2 added lines, -1 removed lines

@@ -101,6 +101,7 @@ 
      * @param ThreemaGateway_Handler_Settings If you already used the settings
      *                                        you can pass them here, so the
      *                                        class can reuse them.
+     * @param ThreemaGateway_Handler_Settings $settings
      * @throws XenForo_Exception
      * @return void
      */
@@ -126,7 +127,7 @@ 
     /**
      * Returns the feature level of the SDK.
      *
-     * @return string
+     * @return integer
      */
     public function getFeatureLevel()
     {

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 = '')
     {