<?php

/**
 * The MIT License
 *
 * Copyright (c) 2020 "YooMoney", NBСO LLC
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

namespace YooKassa\Model\Confirmation;

use YooKassa\Common\Exceptions\InvalidPropertyValueTypeException;
use YooKassa\Helpers\TypeCast;
use YooKassa\Model\ConfirmationType;

/**
 * Сценарий, при котором необходимо отправить плательщика на веб-страницу ЮKassa или партнера для
 * подтверждения платежа
 *
 * @property bool $enforce Требование принудительного подтверждения платежа покупателем, требование 3-D Secure для
 * оплаты банковскими картами. По умолчанию определяется политикой платежной системы.
 * @property string $returnUrl URL на который вернется плательщик после подтверждения или отмены платежа на
 * странице партнера.
 * @property string $return_url URL на который вернется плательщик после подтверждения или отмены платежа на
 * странице партнера.
 * @property string $confirmationUrl URL на который необходимо перенаправить плательщика для подтверждения оплаты.
 * @property string $confirmation_url URL на который необходимо перенаправить плательщика для подтверждения оплаты.
 */
class ConfirmationRedirect extends AbstractConfirmation
{
    /**
     * @var bool Требование принудительного подтверждения платежа покупателем, требование 3-D Secure для оплаты
     * банковскими картами. По умолчанию определяется политикой платежной системы.
     */
    private $_enforce;

    /**
     * @var string URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера.
     */
    private $_returnUrl;

    /**
     * @var string URL на который необходимо перенаправить плательщика для подтверждения оплаты.
     */
    private $_confirmationUrl;

    public function __construct()
    {
        $this->_setType(ConfirmationType::REDIRECT);
    }

    /**
     * @return bool Требование принудительного подтверждения платежа покупателем, требование 3-D Secure для
     * оплаты банковскими картами. По умолчанию определяется политикой платежной системы.
     */
    public function getEnforce()
    {
        return $this->_enforce;
    }

    /**
     * @param bool $value Требование принудительного подтверждения платежа покупателем, требование 3-D Secure
     * для оплаты банковскими картами. По умолчанию определяется политикой платежной системы.
     */
    public function setEnforce($value)
    {
        if ($value === null || $value === '') {
            $this->_enforce = null;
        } elseif (TypeCast::canCastToBoolean($value)) {
            $this->_enforce = (bool)$value;
        } else {
            throw new InvalidPropertyValueTypeException(
                'Invalid enforce value type', 0, 'confirmationRedirect.enforce', $value
            );
        }
    }

    /**
     * @return string URL на который вернется плательщик после подтверждения или отмены платежа на странице партнера.
     */
    public function getReturnUrl()
    {
        return $this->_returnUrl;
    }

    /**
     * @param string $value URL на который вернется плательщик после подтверждения или отмены платежа на
     * странице партнера.
     */
    public function setReturnUrl($value)
    {
        if ($value === null || $value === '') {
            $this->_returnUrl = null;
        } elseif (TypeCast::canCastToString($value)) {
            $this->_returnUrl = (string)$value;
        } else {
            throw new InvalidPropertyValueTypeException(
                'Invalid returnUrl value type', 0, 'confirmationRedirect.returnUrl', $value
            );
        }
    }

    /**
     * @return string URL на который необходимо перенаправить плательщика для подтверждения оплаты.
     */
    public function getConfirmationUrl()
    {
        return $this->_confirmationUrl;
    }

    /**
     * @param string $value URL на который необходимо перенаправить плательщика для подтверждения оплаты.
     */
    public function setConfirmationUrl($value)
    {
        if ($value === null || $value === '') {
            $this->_confirmationUrl = null;
        } elseif (TypeCast::canCastToString($value)) {
            $this->_confirmationUrl = (string)$value;
        } else {
            throw new InvalidPropertyValueTypeException(
                'Invalid confirmationUrl value type', 0, 'confirmationRedirect.confirmationUrl', $value
            );
        }
    }
}
