Inheritance diagram for Data:

Public Member Functions
	__construct (\Magento\Framework\App\Helper\Context $context, LayoutFactory $layoutFactory, \Magento\Payment\Model\Method\Factory $paymentMethodFactory, \Magento\Store\Model\App\Emulation $appEmulation, \Magento\Payment\Model\Config $paymentConfig, \Magento\Framework\App\Config\Initial $initialConfig)

	getMethodInstance ($code)

	getMethodFormBlock (MethodInterface $method, LayoutInterface $layout)

	getInfoBlock (InfoInterface $info, LayoutInterface $layout=null)

	getInfoBlockHtml (InfoInterface $info, $storeId)

	getPaymentMethods ()

	getPaymentMethodList ($sorted=true, $asLabelValue=false, $withGroups=false, $store=null)

	isZeroSubTotal ($store=null)

	getZeroSubTotalOrderStatus ($store=null)

	getZeroSubTotalPaymentAutomaticInvoice ($store=null)

Public Member Functions inherited from AbstractHelper
	__construct (Context $context)

	isModuleOutputEnabled ($moduleName=null)

Data Fields
const	XML_PATH_PAYMENT_METHODS = 'payment'

Protected Member Functions
	getMethodModelConfigName ($code)

Protected Member Functions inherited from AbstractHelper
	_getRequest ()

	_getModuleName ()

	_getUrl ($route, $params=[])

Protected Attributes
	$_paymentConfig

	$_layout

	$_methodFactory

	$_appEmulation

	$_initialConfig

Protected Attributes inherited from AbstractHelper
	$_moduleName

	$_request

	$_moduleManager

	$_logger

	$_urlBuilder

	$_httpHeader

	$_eventManager

	$_remoteAddress

	$urlEncoder

	$urlDecoder

	$scopeConfig

	$_cacheConfig

Detailed Description

Payment module base helper @SuppressWarnings(PHPMD.CouplingBetweenObjects)

@api

Since: 100.0.2

Definition at line 25 of file Data.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\App\Helper\Context	$context,
		LayoutFactory	$layoutFactory,
		\Magento\Payment\Model\Method\Factory	$paymentMethodFactory,
		\Magento\Store\Model\App\Emulation	$appEmulation,
		\Magento\Payment\Model\Config	$paymentConfig,
		\Magento\Framework\App\Config\Initial	$initialConfig
	)

Construct

Parameters

\Magento\Framework\App\Helper\Context	$context
LayoutFactory	$layoutFactory
\Magento\Payment\Model\Method\Factory	$paymentMethodFactory
\Magento\Store\Model\App\Emulation	$appEmulation
\Magento\Payment\Model\Config	$paymentConfig
\Magento\Framework\App\Config\Initial	$initialConfig

Definition at line 70 of file Data.php.

       {
         parent::__construct($context);
         $this->_layout = $layoutFactory->create();
         $this->_methodFactory = $paymentMethodFactory;
         $this->_appEmulation = $appEmulation;
         $this->_paymentConfig = $paymentConfig;
         $this->_initialConfig = $initialConfig;
     }

Member Function Documentation

◆ getInfoBlock()

getInfoBlock	(	InfoInterface	$info,
		LayoutInterface	$layout = `null`
	)

Retrieve payment information block

Parameters

InfoInterface	$info
\Magento\Framework\View\LayoutInterface	$layout

Returns: Template

Definition at line 182 of file Data.php.

     {
         $layout = $layout ?: $this->_layout;
         $blockType = $info->getMethodInstance()->getInfoBlockType();
         $block = $layout->createBlock($blockType);
         $block->setInfo($info);
         return $block;
     }

◆ getInfoBlockHtml()

getInfoBlockHtml	(	InfoInterface	$info,
			$storeId
	)

Render payment information block

Parameters

InfoInterface	$info
int	$storeId

Returns: string

Exceptions

Definition at line 199 of file Data.php.

     {
         $this->_appEmulation->startEnvironmentEmulation($storeId);
 
         try {
             // Retrieve specified view block from appropriate design package (depends on emulated store)
             $paymentBlock = $this->getInfoBlock($info);
             $paymentBlock->setArea(\Magento\Framework\App\Area::AREA_FRONTEND)
                 ->setIsSecureMode(true);
             $paymentBlock->getMethod()
                 ->setStore($storeId);
             $paymentBlockHtml = $paymentBlock->toHtml();
         } catch (\Exception $exception) {
             $this->_appEmulation->stopEnvironmentEmulation();
             throw $exception;
         }
 
         $this->_appEmulation->stopEnvironmentEmulation();
 
         return $paymentBlockHtml;
     }

◆ getMethodFormBlock()

getMethodFormBlock	(	MethodInterface	$method,
		LayoutInterface	$layout
	)

Retrieve payment method form html

Parameters

MethodInterface	$method
LayoutInterface	$layout

Returns: Form

Definition at line 168 of file Data.php.

     {
         $block = $layout->createBlock($method->getFormBlockType(), $method->getCode());
         $block->setMethod($method);
         return $block;
     }

◆ getMethodInstance()

getMethodInstance ( $code )

Retrieve method model object

Parameters

string $code

Exceptions

Definition at line 103 of file Data.php.

     {
         $class = $this->scopeConfig->getValue(
             $this->getMethodModelConfigName($code),
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE
         );
 
         if (!$class) {
             throw new \UnexpectedValueException('Payment model name is not provided in config!');
         }
 
         return $this->_methodFactory->create($class);
     }

◆ getMethodModelConfigName()

getMethodModelConfigName ( $code )

protected

Parameters

string $code

Returns: string

Definition at line 90 of file Data.php.

     {
         return sprintf('%s/%s/model', self::XML_PATH_PAYMENT_METHODS, $code);
     }

◆ getPaymentMethodList()

getPaymentMethodList	(	$sorted = `true`,
		$asLabelValue = `false`,
		$withGroups = `false`,
		$store = `null`
	)

Retrieve all payment methods list as an array

Possible output: 1) assoc array as => <title> 2) array of array('label' => <title>, 'value' => ) 3) array of array( array('value' => , 'label' => <title>), array('value' => array( 'value' => array(array(<code1> => <title1>, <code2> =>...), 'label' => <group name>=""> )), array('value' => , 'label' => <title>), ... )

Parameters


  
    bool $sorted 
    bool $asLabelValue 
    bool $withGroups 
    Store | null $store


Returns
array @SuppressWarnings(PHPMD.CyclomaticComplexity) @SuppressWarnings(PHPMD.NPathComplexity)

Definition at line 255 of file Data.php.

     {
         $methods = [];
         $groups = [];
         $groupRelations = [];
 
         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'];
             }
         }
         if ($asLabelValue && $withGroups) {
             $groups = $this->_paymentConfig->getGroups();
             foreach ($groups as $code => $title) {
                 $methods[$code] = $title;
             }
         }
         if ($sorted) {
             asort($methods);
         }
         if ($asLabelValue) {
             $labelValues = [];
             foreach ($methods as $code => $title) {
                 $labelValues[$code] = [];
             }
             foreach ($methods as $code => $title) {
                 if (isset($groups[$code])) {
                     $labelValues[$code]['label'] = $title;
                     if (!isset($labelValues[$code]['value'])) {
                         $labelValues[$code]['value'] = null;
                     }
                 } elseif (isset($groupRelations[$code])) {
                     unset($labelValues[$code]);
                     $labelValues[$groupRelations[$code]]['value'][$code] = ['value' => $code, 'label' => $title];
                 } else {
                     $labelValues[$code] = ['value' => $code, 'label' => $title];
                 }
             }
             return $labelValues;
         }
 
         return $methods;
     }

◆ getPaymentMethods()

getPaymentMethods ( )

Retrieve all payment methods

Returns: array

Definition at line 226 of file Data.php.

     {
         return $this->_initialConfig->getData('default')[self::XML_PATH_PAYMENT_METHODS];
     }

◆ getZeroSubTotalOrderStatus()

getZeroSubTotalOrderStatus ( $store = null )

Returns value of Zero Subtotal Checkout / New Order Status

Parameters

null | string | bool | int | Store $store

Returns: string

Definition at line 325 of file Data.php.

     {
         return $this->scopeConfig->getValue(
             \Magento\Payment\Model\Method\Free::XML_PATH_PAYMENT_FREE_ORDER_STATUS,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ getZeroSubTotalPaymentAutomaticInvoice()

getZeroSubTotalPaymentAutomaticInvoice ( $store = null )

Returns value of Zero Subtotal Checkout / Automatically Invoice All Items

Parameters

null | string | bool | int | Store $store

Returns: string

Definition at line 340 of file Data.php.

     {
         return $this->scopeConfig->getValue(
             \Magento\Payment\Model\Method\Free::XML_PATH_PAYMENT_FREE_PAYMENT_ACTION,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

◆ isZeroSubTotal()

isZeroSubTotal ( $store = null )

Returns value of Zero Subtotal Checkout / Enabled

Parameters

null | string | bool | int | Store $store

Returns: bool

Definition at line 310 of file Data.php.

     {
         return $this->scopeConfig->getValue(
             \Magento\Payment\Model\Method\Free::XML_PATH_PAYMENT_FREE_ACTIVE,
             \Magento\Store\Model\ScopeInterface::SCOPE_STORE,
             $store
         );
     }

Field Documentation

◆ $_appEmulation

$_appEmulation

protected

Definition at line 53 of file Data.php.

◆ $_initialConfig

$_initialConfig

protected

Definition at line 58 of file Data.php.

◆ $_layout

$_layout

protected

Definition at line 39 of file Data.php.

◆ $_methodFactory

$_methodFactory

protected

Definition at line 46 of file Data.php.

◆ $_paymentConfig

$_paymentConfig

protected

Definition at line 32 of file Data.php.

◆ XML_PATH_PAYMENT_METHODS

const XML_PATH_PAYMENT_METHODS = 'payment'

Definition at line 27 of file Data.php.

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

vendor/magento/module-payment/Helper/Data.php

bool	$sorted
bool	$asLabelValue
bool	$withGroups
Store \| null	$store

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getInfoBlock()

◆ getInfoBlockHtml()

◆ getMethodFormBlock()

◆ getMethodInstance()

◆ getMethodModelConfigName()

◆ getPaymentMethodList()

◆ getPaymentMethods()

◆ getZeroSubTotalOrderStatus()

◆ getZeroSubTotalPaymentAutomaticInvoice()

◆ isZeroSubTotal()

Field Documentation

◆ $_appEmulation

◆ $_initialConfig

◆ $_layout

◆ $_methodFactory

◆ $_paymentConfig

◆ XML_PATH_PAYMENT_METHODS