Sender\Otp\OtpBuildClass

Complexity

Total Complexity

43

Size/Duplication

Total Lines	312
Duplicated Lines	0 %

Test Coverage

Coverage

76.92%

Importance

Changes

0

19 Methods

Rating	Name	Duplication	Size	Complexity
A	addMessage()	0	6	2
A	addOneTimePass()	0	4	1
A	addOtp()	0	6	2
A	addOtpExpiry()	0	6	2
A	buildRetryType()	0	7	2
A	buildMessage()	0	7	2
A	addOtpLength()	0	6	2
A	buildOneTimePass()	0	8	2
A	buildOtpExpiry()	0	8	2
A	addSender()	0	6	2
A	buildOtp()	0	7	2
A	addRetryType()	0	4	1
A	buildOtpLength()	0	9	3
A	buildResendAndVerifyOtpArrtibutes()	0	17	4
A	hasAuthKey()	0	8	3
A	validOtpExpiry()	0	7	2
A	hasMobile()	0	8	3
A	buildSender()	0	11	3
A	checkOtpLength()	0	8	3

<?php
namespace Sender\Otp;

use Sender\Deliver;
use Sender\Validation;
use Sender\Otp\OtpSend;
use Sender\MobileNumber;
use Sender\Traits\OtpBuildTrait;
use Sender\Traits\SmsOtpCommonTrait;
use Sender\Config\Config as ConfigClass;
use Sender\ExceptionClass\ParameterException;

/**
 * This Class for build OTP
 *
 * @package    Sender\OtpClass
 * @author     VenkatS <venkatsamuthiram5@gmail.com>
 * @link       https://github.com/tesark/msg91-php
 * @license    MIT
 */

class OtpBuildClass extends OtpDefineClass
{
    use SmsOtpCommonTrait;
    use OtpBuildTrait;
    /**
     * This function used for build Retype data
     * @param string $key
     * @param array $data
     *
     * @return array
     */
    public function buildRetryType($key, $data)
    {
        if ($this->setRetryType()) {
            $value = $this->getRetryType();
            $data  = $this->addDataArray($key, $value, $data, 'string');
        }
        return $data;
    }
    /**
     * This function used for build Retryp data
     * @param string $key
     * @param array $data
     *
     * @return array
     */
    public function buildOneTimePass($data)
    {
        if ($this->setOneTimePass()) {
            $key = 'otp';
            $value = $this->getOneTimePass();
            $data  = $this->addDataArray($key, $value, $data, 'int');
        }
        return $data;
    }
    /**
     * This function used for build Resend and Verify Otp Atrributes atrributes
     * @param string $key
     * @param array $data
     *
     * @throws ParameterException missing parameters or return empty
     * @return  array
     */
    public function buildResendAndVerifyOtpArrtibutes($key, $data)
    {
        if ($this->isKeyExists($key, $data)) {
            switch ($key) {
                case 'retrytype':
                    $data = $this->buildRetryType($key, $data);
                    break;
                case 'oneTime':
                    $data = $this->buildOneTimePass($data);
                    break;
                default:
                    $message = "parameter".$key."Missing";
                    throw ParameterException::missinglogic($message);
                    break;
            }
        }
        return $data;
    }
    /**
     * This function used for build message data
     * @param string $key
     * @param array $data
     *
     * @return array
     */
    public function buildMessage($key, $data)
    {
        if ($this->setMessage()) {
            $value = $this->getMessage();
            $data  = $this->addDataArray($key, $value, $data, 'string');
        }
        return $data;
    }
    /**
     * This function used for build sender data
     * @param string $key
     * @param array $data
     *
     * @return array
     */
    public function buildSender($key, $data)
    {
        if ($this->setSender()) {
            $value = $this->getSender();
            if ($this->isString($value)) {
                $data = $this->validLength($key, $value, $data, 'otp');
            } else {
                throw ParameterException::invalidArrtibuteType($key, "string", $value);
            }
        }
        return $data;
    }
    /**
     * This function used for build otp data
     * @param string $key
     * @param array $data
     *
     * @return array
     */
    public function buildOtp($key, $data)
    {
        if ($this->setOtp()) {
            $value = $this->getOtp();
            $data  = $this->addDataArray($key, $value, $data, 'int');
        }
        return $data;
    }
    /**
     * Check OtpExpiry limit
     * @param string $key
     * @param int $value
     *
     */
    public function validOtpExpiry($key, $value)
    {
        if ($value >= 1) {
            return $value;
        } else {
            $message = "otp expiry min 1 mintues default 1 day. you given $value";
            throw ParameterException::invalidInput($key, "int", $value, $message);
        }
    }
    /**
     * This function used for build otpExpiry data
     * @param string $key
     * @param array $data
     *
     * @return array
     */
    public function buildOtpExpiry($key, $data)
    {
        if ($this->setOtpExpiry()) {
            $value = $this->getOtpExpiry();
            $value = $this->validOtpExpiry($key, $value);
            $data  = $this->addDataArray($key, $value, $data, 'int');
        }
        return $data;
    }
    /**
     * This function used for Check otpLength data
     * @param string $key
     * @param int $value
     * @param array $data
     *
     * @return array
     */
    public function checkOtpLength($key, $value, $data)
    {
        if ($value >= 4 && $value < 10) {
            $data = $this->addArray($key, $value, $data);
            return $data;
        } else {
            $message = "otp length min 4 to max 9. you given $value";
            throw ParameterException::invalidInput($key, "int", $value, $message);
        }
    }
    /**
     * This function used for build otpLength data
     * @param string $key
     * @param int $value
     * @param array $data
     *
     * @return array
     */
    public function buildOtpLength($key, $data)
    {
        if ($this->setOtpLength()) {
            $value = $this->getOtpLength();
            if ($this->isInterger($value)) {
                $data = $this->checkOtpLength($key, $value, $data);
                return $data;
            } else {
                throw ParameterException::invalidArrtibuteType($key, "int", $value);
            }
        }
    }
    /**
     * Add otp on the array
     * @param array $inputData
     * @param array $data
     *
     * @throws ParameterException missing parameters or return empty
     * @return array condition correct value add to the $data array
     */
    public function addMessage($inputData, $data)
    {
        if ($this->isKeyExists('message', $inputData)) {
            $data = $this->buildMessage('message', $data);
        }
        return $data;
    }
    /**
     * Add sender on the Array
     * @param array $inputData
     * @param array $data
     *
     * @throws ParameterException missing parameters or return empty
     * @return array condition correct value add to the $data array
     */
    public function addSender($inputData, $data)
    {
        if ($this->isKeyExists('sender', $inputData)) {
            $data = $this->buildSender('sender', $data);
        }
        return $data;
    }
    /**
     * Add otp on the array
     * @param array $inputData
     * @param array $data
     *
     * @throws ParameterException missing parameters or return empty
     * @return array condition correct value add to the $data array
     */
    public function addOtp($inputData, $data)
    {
        if ($this->isKeyExists('otp', $inputData)) {
            $data = $this->buildOtp('otp', $data);
        }
        return $data;
    }
    /**
     * Add otp_expiry on the array
     * @param array $inputData
     * @param array $data
     *
     * @throws ParameterException missing parameters or return empty
     * @return array condition correct value add to the $data array
     */
    public function addOtpExpiry($inputData, $data)
    {
        if ($this->isKeyExists('otp_expiry', $inputData)) {
            $data = $this->buildOtpExpiry('otp_expiry', $data);
        }
        return $data;
    }
    /**
     * Add otp_length on the array
     * @param array $inputData
     * @param array $data
     *
     * @throws ParameterException missing parameters or return empty
     * @return array condition correct value add to the $data array
     */
    public function addOtpLength($inputData, $data)
    {
        if ($this->isKeyExists('otp_length', $inputData)) {
            $data = $this->buildOtpLength('otp_length', $data);
        }
        return $data;
    }
    /**
     * This function for buils Auth key
     * @param string $parameter
     *
     * @return bool
     */
    public function hasAuthKey($parameter)
    {
        if ($this->setAuthkey()) {
            $value = $this->getAuthkey();
            if ($this->isString($value)) {
                return true;
            } else {
                throw ParameterException::invalidArrtibuteType($parameter, "string", $value);
            }
        }
    }
    /**
     * This function for buils Mobile
     * @param string $parameter
     *
     * @return bool
     */
    public function hasMobile($parameter)
    {
        if ($this->setmobile()) {
            $value = $this->getmobile();
            if ($this->isInterger($value)) {
                return true;
            } else {
                throw ParameterException::invalidArrtibuteType($parameter, "int", $value);
            }
        }
    }
    /**
     * Add retry type
     *
     * @param array $data
     *
     * @throws ParameterException missing parameters or return empty
     * @return array Msg91 Json response
     */
    public function addRetryType($data)
    {
        $data = $this->buildResendAndVerifyOtpArrtibutes('retrytype', $data);
        return $data;
    }
    /**
     * Add otp on the array
     * @param   array $data
     *
     * @throws ParameterException missing parameters or return empty
     * @return  array condition correct value add to the $data array
     */
    public function addOneTimePass($data)
    {
        $data = $this->buildResendAndVerifyOtpArrtibutes('oneTime', $data);
        return $data;
    }
}