How is a payment method's getConfigData() used?

dmitry_fedyuk · February 15, 2016, 8:37am

Declaration

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/MethodInterface.php#L324-L332


/**
 * Retrieve information from payment configuration
 *
 * @param string $field
 * @param int|string|null|\Magento\Store\Model\Store $storeId
 *
 * @return mixed
 */
public function getConfigData($field, $storeId = null);

Definition

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/AbstractMethod.php#L742-L760


/**
 * Retrieve information from payment configuration
 *
 * @param string $field
 * @param int|string|null|\Magento\Store\Model\Store $storeId
 *
 * @return mixed
 */
public function getConfigData($field, $storeId = null)
{
    if ('order_place_redirect_url' === $field) {
        return $this->getOrderPlaceRedirectUrl();
    }
    if (null === $storeId) {
        $storeId = $this->getStore();
    }
    $path = 'payment/' . $this->getCode() . '/' . $field;
    return $this->_scopeConfig->getValue($path, \Magento\Store\Model\ScopeInterface::SCOPE_STORE, $storeId);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Braintree/Model/PaymentMethod.php#L944-L958


/**
 * Retrieve information from payment configuration
 *
 * @param string $field
 * @param int|string|null|\Magento\Store\Model\Store $storeId
 *
 * @return mixed
 */
public function getConfigData($field, $storeId = null)
{
    if ('order_place_redirect_url' === $field) {
        return $this->getOrderPlaceRedirectUrl();
    }
    return $this->config->getConfigData($field, $storeId);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Braintree/Model/PaymentMethod/PayPal.php#L130-L144


/**
 * Retrieve information from payment configuration
 *
 * @param string $field
 * @param int|string|null|\Magento\Store\Model\Store $storeId
 *
 * @return mixed
 */
public function getConfigData($field, $storeId = null)
{
    if ('order_place_redirect_url' === $field) {
        return $this->getOrderPlaceRedirectUrl();
    }
    return $this->payPalConfig->getConfigData($field, $storeId);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/Adapter.php#L369-L372


public function getConfigData($field, $storeId = null)
{
    return $this->getConfiguredValue($field, $storeId);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Direct.php#L280-L294


public function getConfigData($field, $storeId = null)
{
    $value = null;
    switch ($field) {
        case 'cctypes':
            $value = $this->getAllowedCcTypes();
            break;
        case 'order_place_redirect_url':
            $value = $this->getOrderPlaceRedirectUrl();
            break;
        default:
            $value = $this->_pro->getConfig()->getValue($field);
    }
    return $value;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Paypal/Model/Express.php#L342-L356


/**
 * Custom getter for payment configuration
 *
 * @param string $field
 * @param int|null $storeId
 * @return mixed
 * @SuppressWarnings(PHPMD.UnusedFormalParameter)
 */
public function getConfigData($field, $storeId = null)
{
    if ('order_place_redirect_url' === $field) {
        return $this->getOrderPlaceRedirectUrl();
    }
    return $this->_pro->getConfig()->getValue($field);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Vault/Model/Method/Vault.php#L543-L546


public function getConfigData($field, $storeId = null)
{
    return $this->getConfiguredValue($field, $storeId);
}

Usage

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Block/Form/Cc.php#L36-L56


/**
 * Retrieve availables credit card types
 *
 * @return array
 * @SuppressWarnings(PHPMD.UnusedLocalVariable)
 */
public function getCcAvailableTypes()
{
    $types = $this->_paymentConfig->getCcTypes();
    if ($method = $this->getMethod()) {
        $availableTypes = $method->getConfigData('cctypes');
        if ($availableTypes) {
            $availableTypes = explode(',', $availableTypes);
            foreach ($types as $code => $name) {
                if (!in_array($code, $availableTypes)) {
                    unset($types[$code]);
                }
            }
        }
    }
    return $types;

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Block/Form/Cc.php#L91-L106


/**
 * Retrieve has verification configuration
 *
 * @return bool
 */
public function hasVerification()
{
    if ($this->getMethod()) {
        $configData = $this->getMethod()->getConfigData('useccv');
        if ($configData === null) {
            return true;
        }
        return (bool)$configData;
    }
    return true;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Block/Form/Cc.php#L108-L121


/**
 * Whether switch/solo card type available
 *
 * @return bool
 */
public function hasSsCardType()
{
    $availableTypes = explode(',', $this->getMethod()->getConfigData('cctypes'));
    $ssPresenations = array_intersect(['SS', 'SM', 'SO'], $availableTypes);
    if ($availableTypes && count($ssPresenations) > 0) {
        return true;
    }
    return false;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Block/Transparent/Form.php#L164-L177


/**
 * Retrieve config data value by field name
 *
 * @param string $fieldName
 * @return mixed
 */
public function getMethodConfigData($fieldName)
{
    $method = $this->getMethod();
    if ($method instanceof TransparentInterface) {
        return $method->getConfigInterface()->getValue($fieldName);
    }
    return $method->getConfigData($fieldName);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Helper/Data.php#L147-L160


@uasort(
    $res,
    function (MethodInterface $a, MethodInterface $b) {
        if ((int)$a->getConfigData('sort_order') < (int)$b->getConfigData('sort_order')) {
            return -1;
        }


        if ((int)$a->getConfigData('sort_order') > (int)$b->getConfigData('sort_order')) {
            return 1;
        }


        return 0;
    }
);

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Helper/Data.php#L265-L274


foreach ($this->getPaymentMethods() as $code => $data) {
    if (isset($data['title'])) {
        $methods[$code] = $data['title'];
    } else {
        $methods[$code] = $this->getMethodInstance($code)->getConfigData('title', $store);
    }
    if ($asLabelValue && $withGroups && isset($data['group'])) {
        $groupRelations[$code] = $data['group'];
    }
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/CcGenericConfigProvider.php#L105-L124


/**
 * Retrieve availables credit card types
 *
 * @param string $methodCode
 * @return array
 */
protected function getCcAvailableTypes($methodCode)
{
    $types = $this->ccConfig->getCcAvailableTypes();
    $availableTypes = $this->methods[$methodCode]->getConfigData('cctypes');
    if ($availableTypes) {
        $availableTypes = explode(',', $availableTypes);
        foreach (array_keys($types) as $code) {
            if (!in_array($code, $availableTypes)) {
                unset($types[$code]);
            }
        }
    }
    return $types;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/CcGenericConfigProvider.php#L126-L140


/**
 * Retrieve has verification configuration
 *
 * @param string $methodCode
 * @return bool
 */
protected function hasVerification($methodCode)
{
    $result = $this->ccConfig->hasVerification();
    $configData = $this->methods[$methodCode]->getConfigData('useccv');
    if ($configData !== null) {
        $result = (bool)$configData;
    }
    return $result;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/CcGenericConfigProvider.php#L142-L157


/**
 * Whether switch/solo card type available
 *
 * @param string $methodCode
 * @return bool
 */
protected function hasSsCardType($methodCode)
{
    $result = false;
    $availableTypes = explode(',', $this->methods[$methodCode]->getConfigData('cctypes'));
    $ssPresentations = array_intersect(['SS', 'SM', 'SO'], $availableTypes);
    if ($availableTypes && count($ssPresentations) > 0) {
        $result = true;
    }
    return $result;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Config.php#L85-L105


/**
 * Retrieve active system payments
 *
 * @return array
 * @api
 */
public function getActiveMethods()
{
    $methods = [];
    foreach ($this->_scopeConfig->getValue('payment', ScopeInterface::SCOPE_STORE, null) as $code => $data) {
        if (isset($data['active']) && (bool)$data['active'] && isset($data['model'])) {
            /** @var AbstractMethod|null $methodModel Actually it's wrong interface */
            $methodModel = $this->_paymentMethodFactory->create($data['model']);
            $methodModel->setId($code);
            $methodModel->setStore(null);
            if ($methodModel->getConfigData('active', null)) {
                $methods[$code] = $methodModel;
            }
        }
    }
    return $methods;

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/IframeConfigProvider.php#L218-L230


/**
 * Retrieve config data value by field name
 *
 * @param string $fieldName
 * @return mixed
 */
protected function getMethodConfigData($fieldName)
{
    if ($this->method instanceof TransparentInterface) {
        return $this->method->getConfigInterface()->getValue($fieldName);
    }
    return $this->method->getConfigData($fieldName);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Checks/TotalMinMax.php#L23-L39


/**
 * Check whether payment method is applicable to quote
 *
 * @param MethodInterface $paymentMethod
 * @param \Magento\Quote\Model\Quote $quote
 * @return bool
 */
public function isApplicable(MethodInterface $paymentMethod, Quote $quote)
{
    $total = $quote->getBaseGrandTotal();
    $minTotal = $paymentMethod->getConfigData(self::MIN_ORDER_TOTAL);
    $maxTotal = $paymentMethod->getConfigData(self::MAX_ORDER_TOTAL);
    if (!empty($minTotal) && $total < $minTotal || !empty($maxTotal) && $total > $maxTotal) {
        return false;
    }
    return true;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/AbstractMethod.php#L464-L482


/**
 * To check billing country is allowed for the payment method
 *
 * @param string $country
 * @return bool
 */
public function canUseForCountry($country)
{
    /*
    for specific country, the flag will set up as 1
    */
    if ($this->getConfigData('allowspecific') == 1) {
        $availableCountries = explode(',', $this->getConfigData('specificcountry'));
        if (!in_array($country, $availableCountries)) {
            return false;
        }
    }
    return true;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/AbstractMethod.php#L732-L740


/**
 * Retrieve payment method title
 *
 * @return string
 */
public function getTitle()
{
    return $this->getConfigData('title');
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/AbstractMethod.php#L827-L836


/**
 * Is active
 *
 * @param int|null $storeId
 * @return bool
 */
public function isActive($storeId = null)
{
    return (bool)(int)$this->getConfigData('active', $storeId);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/AbstractMethod.php#L854-L864


/**
 * Get config payment action url
 * Used to universalize payment actions when processing payment place
 *
 * @return string
 * @api
 */
public function getConfigPaymentAction()
{
    return $this->getConfigData('payment_action');
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/AbstractMethod.php#L881-L891


/**
 * Define if debugging is enabled
 *
 * @return bool
 * @SuppressWarnings(PHPMD.BooleanGetMethodName)
 * @api
 */
public function getDebugFlag()
{
    return (bool)(int)$this->getConfigData('debug');
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/Cc.php#L101-L111


$availableTypes = explode(',', $this->getConfigData('cctypes'));


$ccNumber = $info->getCcNumber();


// remove credit card number delimiters such as "-" and space
$ccNumber = preg_replace('/[\-\s]+/', '', $ccNumber);
$info->setCcNumber($ccNumber);


$ccType = '';


if (in_array($info->getCcType(), $availableTypes)) {

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/Cc.php#L187-L198


/**
 * @return bool
 * @api
 */
public function hasVerification()
{
    $configData = $this->getConfigData('useccv');
    if ($configData === null) {
        return true;
    }
    return (bool)$configData;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Model/Method/Cc.php#L298-L307


/**
 * Check whether there are CC types set in configuration
 *
 * @param \Magento\Quote\Api\Data\CartInterface|null $quote
 * @return bool
 */
public function isAvailable(\Magento\Quote\Api\Data\CartInterface $quote = null)
{
    return $this->getConfigData('cctypes', $quote ? $quote->getStoreId() : null) && parent::isAvailable($quote);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Payment/Observer/UpdateOrderStatusForPaymentMethodsObserver.php#L49-L67


public function execute(\Magento\Framework\Event\Observer $observer)
{
    if ($observer->getEvent()->getState() != \Magento\Sales\Model\Order::STATE_NEW) {
        return;
    }
    $status = $observer->getEvent()->getStatus();
    $defaultStatus = $this->_salesOrderConfig->getStateDefaultStatus(\Magento\Sales\Model\Order::STATE_NEW);
    $methods = $this->_paymentConfig->getActiveMethods();
    foreach ($methods as $method) {
        if ($method->getConfigData('order_status') == $status) {
            $this->_resourceConfig->saveConfig(
                'payment/' . $method->getCode() . '/order_status',
                $defaultStatus,
                'default',
                0
            );
        }
    }
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Quote/Model/Quote/Payment.php#L204-L216


/**
 * Checkout order place redirect URL getter
 *
 * @return string
 */
public function getOrderPlaceRedirectUrl()
{
    $method = $this->getMethodInstance();
    if ($method) {
        return $method->getConfigData('order_place_redirect_url');
    }
    return '';
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Block/Adminhtml/Order/Create/Billing/Method/Form.php#L100-L113


/**
 * Whether switch/solo card type available
 *
 * @return true
 */
public function hasSsCardType()
{
    $availableTypes = explode(',', $this->getQuote()->getPayment()->getMethod()->getConfigData('cctypes'));
    $ssPresenations = array_intersect(['SS', 'SM', 'SO'], $availableTypes);
    if ($availableTypes && count($ssPresenations) > 0) {
        return true;
    }
    return false;
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Payment.php#L329-L329


$orderStatus = $methodInstance->getConfigData('order_status');

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Sales/Model/Order/Payment.php#L340-L340


$methodInstance->initialize($methodInstance->getConfigData('payment_action'), $stateObject);

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Vault/Model/Method/Vault.php#L213-L217


public function canAuthorize()
{
    return $this->getVaultProvider()->canAuthorize()
    && $this->getVaultProvider()->getConfigData(static::CAN_AUTHORIZE);
}

github.com

magento/magento2/blob/6ce74b2/app/code/Magento/Vault/Model/Method/Vault.php#L222-L226


public function canCapture()
{
    return $this->getVaultProvider()->canCapture()
    && $this->getVaultProvider()->getConfigData(static::CAN_CAPTURE);
}

dmitry_fedyuk · February 15, 2016, 8:38am