ThreemaGateway_Option_ReceiveCallback

Complexity

Total Complexity

5

Size/Duplication

Total Lines	67
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	1

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	renderOption()	0	21	2
A	verifyOption()	0	9	2
A	generateDefault()	0	4	1

<?php
/**
 * Receive callback option/display for admins to copy link.
 *
 * @package ThreemaGateway
 * @author rugk
 * @copyright Copyright (c) 2016 rugk
 * @license MIT
 */

class ThreemaGateway_Option_ReceiveCallback
{
    /**
     * @var int The default length of an access token
     */
    const ACCESS_TOKEN_LENGTH = 46;

    /**
     * Renders the debug mode text input field with on/off buttons.
     *
     * @param XenForo_View $view           View object
     * @param string       $fieldPrefix    Prefix for the HTML form field name
     * @param array        $preparedOption Prepared option info
     * @param bool         $canEdit        True if an "edit" link should appear
     *
     * @return XenForo_Template_Abstract Template object
     */
    public static function renderOption(XenForo_View $view, $fieldPrefix, array $preparedOption, $canEdit)

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

    {
        /** @var XenForo_Options $options */
        $options = XenForo_Application::getOptions();

        // set default value
        if (empty($preparedOption['option_value'])) {
            $preparedOption['option_value'] = self::generateDefault();
        }

        //modify array to use custom template
        $preparedOption['edit_format']  = 'template';
        $preparedOption['formatParams'] = [
            'template' => 'threemagw_option_list_receivecallback',
            'basetext' => $options->boardUrl . '/' . ThreemaGateway_Constants::CALLBACK_FILE . '?accesstoken=',
            'placeholder' => ''
        ];

        //pass this to the default handler
        return XenForo_ViewAdmin_Helper_Option::renderPreparedOptionHtml($view, $preparedOption, $canEdit);
    }

    /**
     * Verifies whether the dir of the file is valid (can be created) and is writable.
     *
     * @param XenForo_DataWriter $dataWriter
     * @param string             $fieldName  Name of field/option
     *
     * @return bool
     */
    public static function verifyOption(&$input, XenForo_DataWriter $dataWriter, $fieldName)

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

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

    {
        // set default value
        if (empty($input)) {
            $input = self::generateDefault();
        }

        return true;
    }

    /**
     * Generates the default, which should be used for this option.
     *
     * @return string
     */
    protected static function generateDefault()
    {
        return ThreemaGateway_Helper_Random::getRandomAlphaNum(self::ACCESS_TOKEN_LENGTH);
    }
}