rugk / xenforo-threema-gateway

docs/examples/MessageCallback.php

<?php
/**
 * Threema message callback listener. (example).
 *
 * @package ThreemaGateway
 * @author rugk
 * @copyright Copyright (c) 2015-2016 rugk
 * @license MIT
 */

/**
 * Listeners for custom activity when a text message is received.
 */
class ThreemaGateway_Listener_MessageCallback
{
    /**
     * Receives text messages.
     *
     * @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 static function testCallbackPreSave(ThreemaGateway_Handler_Action_Callback $handler,
                                        Threema\MsgApi\Helpers\ReceiveMessageResult $receiveResult,
                                        Threema\MsgApi\Messages\ThreemaMessage $threemaMsg,
                                        &$output,
                                        &$saveMessage,
                                        $debugMode)

The parameter $debugMode is not used and could be removed.

    {
        // for performance reasons you should check first, whether the message
        // meets your requirements respectively needs to be handled by the
        // listener.
        if ($threemaMsg->getText() != 'test message') {
            // IMPORTANT: Do not return false as this would cause all other
            // registered listeners to stop! You may not want to do that.
            return;
        }

        // first check whether message has already been saved to prevent replay attacks
        $handler->assertNoReplayAttack($receiveResult->getMessageId());

        // it is useful to add some logging messages for easier debugging
        $handler->addLog($output, 'Message will not be saved to database!');

        // here you can do something with your text messages
        $saveMessage = false; // e.g. prevent saving!
    }

    /**
     * Receives text messages after saving them.
     *
     * @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                                        $debugMode
     */
    public static function testCallbackPostSave(ThreemaGateway_Handler_Action_Callback $handler,
                                        Threema\MsgApi\Helpers\ReceiveMessageResult $receiveResult,

The parameter $receiveResult is not used and could be removed.

                                        Threema\MsgApi\Messages\ThreemaMessage $threemaMsg,

The parameter $threemaMsg is not used and could be removed.

                                        &$output,
                                        $messageSaved,
                                        $debugMode)

The parameter $debugMode is not used and could be removed.

    {
        if (!$messageSaved) {
            // this should only be shown when testCallbackPreSave has been executed
            // or another listener prevented saving of the data.
            $handler->addLog($output, 'This is the message, which has not been saved!');
        }
    }
}