IframeConfigProvider Class Reference

Inheritance diagram for IframeConfigProvider:

Public Member Functions
	__construct (Repository $assetRepo, RequestInterface $request, UrlInterface $urlBuilder, LoggerInterface $logger, PaymentHelper $paymentHelper, $methodCode)
	getConfig ()

Data Fields
const	TIMEOUT_TIME = 30000
const	DEFAULT_YEAR_LENGTH = 2
const	CHECKOUT_IDENTIFIER = 'checkout_flow'

Protected Member Functions
	getDateDelim ()
	getExpireDateYearLength ()
	getCardFieldsMap ()
	getViewFileUrl ($fileId, array $params=[])
	getPlaceOrderUrl ()
	getSaveOrderUrl ()
	getCgiUrl ()
	getMethodConfigData ($fieldName)

Protected Attributes
	$assetRepo
	$request
	$urlBuilder
	$logger
	$methodCode
	$method

Detailed Description

Definition at line 29 of file IframeConfigProvider.php.

Constructor & Destructor Documentation

__construct()

__construct	(	Repository	$assetRepo,
		RequestInterface	$request,
		UrlInterface	$urlBuilder,
		LoggerInterface	$logger,
		PaymentHelper	$paymentHelper,
			$methodCode
	)

Parameters

Repository	$assetRepo
RequestInterface	$request
UrlInterface	$urlBuilder
LoggerInterface	$logger
PaymentHelper	$paymentHelper
string	$methodCode

Definition at line 86 of file IframeConfigProvider.php.

      {
        $this->assetRepo = $assetRepo;
        $this->request = $request;
        $this->urlBuilder = $urlBuilder;
        $this->logger = $logger;
        $this->methodCode = $methodCode;
        $this->method = $paymentHelper->getMethodInstance($methodCode);
    }

Member Function Documentation

getCardFieldsMap()

getCardFieldsMap ( )

protected

Get map of cc_code, cc_num, cc_expdate for gateway Returns json formatted string

Returns

string

Definition at line 158 of file IframeConfigProvider.php.

    {
        $result = [];
        if ($this->method->isAvailable()) {
            $configData = $this->getMethodConfigData('ccfields');
            $keys = ['cccvv', 'ccexpdate', 'ccnum'];
            $result = array_combine($keys, explode(',', $configData));
        }

        return $result;
    }

getCgiUrl()

getCgiUrl ( )

protected

Retrieve gateway url

Returns

string

Definition at line 218 of file IframeConfigProvider.php.

    {
        return (bool)$this->getMethodConfigData('sandbox_flag')
            ? $this->getMethodConfigData('cgi_url_test_mode')
            : $this->getMethodConfigData('cgi_url');
    }

getConfig()

getConfig

(

)

{Retrieve assoc array of checkout configuration

Returns

array

}

Implements ConfigProviderInterface.

Definition at line 105 of file IframeConfigProvider.php.

    {
        return [
            'payment' => [
                'iframe' => [
                    'timeoutTime' => [$this->methodCode => self::TIMEOUT_TIME],
                    'dateDelim' => [$this->methodCode => $this->getDateDelim()],
                    'cardFieldsMap' => [$this->methodCode => $this->getCardFieldsMap()],
                    'source' =>  [$this->methodCode => $this->getViewFileUrl('blank.html')],
                    'controllerName' => [$this->methodCode => self::CHECKOUT_IDENTIFIER],
                    'cgiUrl' => [$this->methodCode => $this->getCgiUrl()],
                    'placeOrderUrl' => [$this->methodCode => $this->getPlaceOrderUrl()],
                    'saveOrderUrl' => [$this->methodCode => $this->getSaveOrderUrl()],
                    'expireYearLength' => [$this->methodCode => $this->getExpireDateYearLength()]
                ]
            ]
        ];
    }

getDateDelim()

getDateDelim ( )

protected

Get delimiter for date

Returns

string

Definition at line 129 of file IframeConfigProvider.php.

    {
        $result = '';
        if ($this->method->isAvailable()) {
            $configData = $this->getMethodConfigData('date_delim');
            if ($configData !== null) {
                $result = $configData;
            }
        }

        return  $result;
    }

getExpireDateYearLength()

getExpireDateYearLength ( )

protected

Returns Cc expire year length

Returns

int

Definition at line 147 of file IframeConfigProvider.php.

    {
         return (int)$this->getMethodConfigData('cc_year_length') ?: self::DEFAULT_YEAR_LENGTH;
    }

getMethodConfigData()

getMethodConfigData (   $fieldName )

protected

Retrieve config data value by field name

Parameters

string

$fieldName

Returns

mixed

Definition at line 231 of file IframeConfigProvider.php.

    {
        if ($this->method instanceof TransparentInterface) {
            return $this->method->getConfigInterface()->getValue($fieldName);
        }
        return $this->method->getConfigData($fieldName);
    }

getPlaceOrderUrl()

getPlaceOrderUrl ( )

protected

Retrieve place order url on front

Returns

string

Definition at line 193 of file IframeConfigProvider.php.

    {
        return $this->urlBuilder->getUrl(
            $this->getMethodConfigData('place_order_url'),
            [
                '_secure' => $this->request->isSecure()
            ]
        );
    }

getSaveOrderUrl()

getSaveOrderUrl ( )

protected

Retrieve save order url on front

Returns

string

Definition at line 208 of file IframeConfigProvider.php.

    {
        return $this->urlBuilder->getUrl('checkout/onepage/saveOrder', ['_secure' => $this->request->isSecure()]);
    }

getViewFileUrl()

getViewFileUrl (   $fileId, array  $params = []  )

protected

Retrieve url of a view file

Parameters

string	$fileId
array	$params

Returns

string[]

Definition at line 177 of file IframeConfigProvider.php.

    {
        try {
            $params = array_merge(['_secure' => $this->request->isSecure()], $params);
            return $this->assetRepo->getUrlWithParams($fileId, $params);
        } catch (LocalizedException $e) {
            $this->logger->critical($e);
            return $this->urlBuilder->getUrl('', ['_direct' => 'core/index/notFound']);
        }
    }

Field Documentation

$assetRepo

$assetRepo

protected

Definition at line 49 of file IframeConfigProvider.php.

$logger

$logger

protected

Definition at line 64 of file IframeConfigProvider.php.

$method

$method

protected

Definition at line 76 of file IframeConfigProvider.php.

$methodCode

$methodCode

protected

Definition at line 71 of file IframeConfigProvider.php.

$request

$request

protected

Definition at line 54 of file IframeConfigProvider.php.

$urlBuilder

$urlBuilder

protected

Definition at line 59 of file IframeConfigProvider.php.

CHECKOUT_IDENTIFIER

const CHECKOUT_IDENTIFIER = 'checkout_flow'

Checkout identifier for transparent iframe payments

Definition at line 44 of file IframeConfigProvider.php.

DEFAULT_YEAR_LENGTH

const DEFAULT_YEAR_LENGTH = 2

Default length of Cc year field

Definition at line 39 of file IframeConfigProvider.php.

TIMEOUT_TIME

const TIMEOUT_TIME = 30000

30 sec

Definition at line 34 of file IframeConfigProvider.php.

---

The documentation for this class was generated from the following file:

• vendor/magento/module-payment/Model/IframeConfigProvider.php