Studioforty9_Recaptcha_Helper_Response

Complexity

Total Complexity

12

Size/Duplication

Total Lines	151
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	0

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	setSuccess()	0	6	1
A	setErrorCodes()	0	6	1
A	isSuccess()	0	4	1
A	isFailure()	0	4	1
A	hasErrors()	0	4	1
A	getErrors()	0	9	2
A	getErrorDescription()	0	8	2
A	log()	0	15	2

<?php
/**
 * Studioforty9_Recaptcha
 *
 * @category  Studioforty9
 * @package   Studioforty9_Recaptcha
 * @author    StudioForty9 <info@studioforty9.com>
 * @copyright 2015 StudioForty9 (http://www.studioforty9.com)
 * @license   https://github.com/studioforty9/recaptcha/blob/master/LICENCE BSD
 * @version   1.5.7
 * @link      https://github.com/studioforty9/recaptcha
 */

/**
 * Studioforty9_Recaptcha_Helper_Response
 *
 * @category   Studioforty9
 * @package    Studioforty9_Recaptcha
 * @subpackage Helper
 * @author     StudioForty9 <info@studioforty9.com>
 */
class Studioforty9_Recaptcha_Helper_Response extends Mage_Core_Helper_Abstract
{
    const MISSING_INPUT_SECRET   = 'missing-input-secret';
    const INVALID_INPUT_SECRET   = 'invalid-input-secret';
    const MISSING_INPUT_RESPONSE = 'missing-input-response';
    const INVALID_INPUT_RESPONSE = 'invalid-input-response';

    /**
     * @var bool $_success
     */
    protected $_success = false;

    /**
     * @var array $_errorCodes
     */
    protected $_errorCodes = array();

    /**
     * @var array $_errorDescriptions
     */
    protected $_errorDescriptions = array(
        self::MISSING_INPUT_SECRET   => 'The secret parameter is missing.',
        self::INVALID_INPUT_SECRET   => 'The secret parameter is invalid or malformed.',
        self::MISSING_INPUT_RESPONSE => 'The response parameter is missing.',
        self::INVALID_INPUT_RESPONSE => 'The response parameter is invalid or malformed.'
    );

    /**
     * The constructor allows for a shortcut method of setting the $success and
     * $errorCodes properties.
     *
     * @param bool  $success    A boolean flag to determine success
     * @param array $errorCodes An array of error codes
     */
    public function __construct($success, $errorCodes = array())
    {
        $this->setSuccess($success);
        $this->setErrorCodes($errorCodes);
    }

    /**
     * Set the success flag.
     *
     * @param bool $success A boolean flag to determine success
     *
     * @return $this
     */
    public function setSuccess($success)
    {
        $this->_success = $success;
        
        return $this;
    }

    /**
     * Set the array of error codes from the response.
     *
     * @param array $errorCodes An array of error codes
     *
     * @return $this
     */
    public function setErrorCodes($errorCodes)
    {
        $this->_errorCodes = $errorCodes;
        
        return $this;
    }

    /**
     * Is the response a success.
     *
     * @return bool
     */
    public function isSuccess()
    {
        return ($this->_success === true);
    }

    /**
     * Is the response a failure.
     *
     * @return bool
     */
    public function isFailure()
    {
        return !$this->isSuccess();
    }

    /**
     * Are there any errors passed in from the response.
     *
     * @return bool
     */
    public function hasErrors()
    {
        return ! empty($this->_errorCodes);
    }

    /**
     * An array of descriptive errors.
     *
     * @return array
     */
    public function getErrors()
    {
        $errors = array();
        foreach ($this->_errorCodes as $errorCode) {
            $errors[] = $this->getErrorDescription($errorCode);
        }

        return $errors;
    }

    /**
     * Get the error description.
     *
     * @param string $errorCode The human readable translation of the error code
     *
     * @return string
     */
    public function getErrorDescription($errorCode)
    {
        if (!array_key_exists($errorCode, $this->_errorDescriptions)) {
            return 'Unknown error.';
        }

        return $this->_errorDescriptions[$errorCode];
    }

    /**
     * Log the error to file.
     * 
     * @codeCoverageIgnore
     * @return bool
     */
    public function log()
    {
        if (Mage::getStoreConfigFlag('dev/log/active')) {
            return false;
        }
        
        Mage::log(
            sprintf(
                'reCAPTCHA Errors: %1$s',
                implode(', ', $this->getErrors())
            )
        );
        
        return true;
    }
}