ThreemaGateway_Model_TfaPendingMessagesConfirmation

Complexity

Total Complexity

7

Size/Duplication

Total Lines	99
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	0

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getPendingById()	0	15	2
B	getPending()	0	33	4
A	deleteExpired()	0	8	1

<?php
/**
 * Model for querying pending confirmation requests.
 *
 * @package ThreemaGateway
 * @author rugk
 * @copyright Copyright (c) 2015-2016 rugk
 * @license MIT
 */

class ThreemaGateway_Model_TfaPendingMessagesConfirmation extends XenForo_Model
{
    /**
     * @var string database table name
     */
    const DB_TABLE = 'xf_threemagw_tfa_pending_msgs_confirm';

    /**
     * @var int Pending type: a 6 digit code is requested
     */
    const PENDING_REQUEST_CODE = 1;

    /**
     * @var int Pending type: a delivery receipt is requested
     */
    const PENDING_REQUEST_DELIVERY_RECEIPT = 2;

    /**
     * Returns the pending confirmations by a given request ID.
     *
     * @param string $requestId
     *
     * @return null|array
     */
    public function getPendingById($requestId)
    {
        /** @var mixed $result result of SQL query */
        $result = $this->_getDb()->fetchRow(
            $this->_getDb()->select()
                ->from(self::DB_TABLE)
                ->where('request_id = ?', $requestId)
        );

        if (!$result) {
            return null;
        }

        return $result;
    }

    /**
     * Returns the pending confirmations by Threema ID and optionally also by
     * the pending type.
     *
     * @param string $threemaId
     * @param string $providerId  Provider ID of 2FA method
     * @param int    $pendingType use the PENDING_* constants
     *
     * @return null|array
     */
    public function getPending($threemaId, $providerId = null, $pendingType = null)
    {
        /** @var array $conditionsArray */
        $conditionsArray = [
            '`threema_id` = ?'
        ];
        $paramsArray = [
            $threemaId
        ];

        if ($providerId !== null) {
            $conditionsArray[] = '`provider_id` = ?';
            $paramsArray[]     = $providerId;
        }

        if ($pendingType !== null) {
            $conditionsArray[] = '`pending_type` = ?';
            $paramsArray[]     = $pendingType;
        }

        /** @var mixed $result result of SQL query */
        $result = $this->fetchAllKeyed(
            $this->_getDb()->select()
                ->from(self::DB_TABLE)
                ->where($this->getConditionsForClause($conditionsArray)),
            'request_id', $paramsArray);

        if (!$result) {
            return null;
        }

        return $result;
    }

    /**
     * Removes all expired pending requets.
     *
     * This should be executed regularely as otherwise the database gets filled
     * up with unconfirmed/never handled pending requests.
     */
    public function deleteExpired()
    {
        $this->_getDb()->delete(self::DB_TABLE,
            [
                '? > expiry_date' => XenForo_Application::$time
            ]
        );
    }
}