How is Magento\Payment\Model\Method\Substitution implemented and used?

dmitry_fedyuk · May 9, 2017, 4:24pm

Implementation

magento/magento2/blob/2.1.6/app/code/Magento/Payment/Model/Method/Substitution.php#L7-L45


namespace Magento\Payment\Model\Method;


/**
* Substitution payment method for non-existing payments
*
* @method \Magento\Quote\Api\Data\PaymentMethodExtensionInterface getExtensionAttributes()
*/
class Substitution extends AbstractMethod
{
   /**
    * Method code
    */
   const CODE = 'substitution';


   /**
    * Key of title in instance additional information
    */
   const INFO_KEY_TITLE = 'method_title';


   /**
    * @var string
    */
   protected $_code = self::CODE;


   /**
    * @var string
    */
   protected $_infoBlockType = \Magento\Payment\Block\Info\Substitution::class;


   /**
    * Retrieve payment method title
    *
    * @return string
    */
   public function getTitle()
   {
       return $this->getInfoInstance()->getAdditionalInformation(self::INFO_KEY_TITLE);
   }
}

Usages

1. Magento\Sales\Model\Order\Payment\Info::getMethodInstance()

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Sales/Model/Order/Payment/Info.php#L99-L122


/**
 * Retrieve payment method model object
 *
 * @return \Magento\Payment\Model\MethodInterface
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function getMethodInstance()
{
    if (!$this->hasMethodInstance()) {
        if (!$this->getMethod()) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('The payment method you requested is not available.')
            );
        }
        try {
            $instance = $this->paymentData->getMethodInstance($this->getMethod());
        } catch (\UnexpectedValueException $e) {
            $instance = $this->paymentData->getMethodInstance(Substitution::CODE);
        }
        $instance->setInfoInstance($this);
        $this->setMethodInstance($instance);
    }
    return $this->getData('method_instance');
}

2. Magento\Payment\Model\Info::getMethodInstance() (is is just a copy/paste of the method above, an example of the «nice» Magento 2 architecture)

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Payment/Model/Info.php#L91-L117


/**
 * Retrieve payment method model object
 *
 * @return \Magento\Payment\Model\MethodInterface
 * @throws \Magento\Framework\Exception\LocalizedException
 */
public function getMethodInstance()
{
    if (!$this->hasMethodInstance()) {
        if (!$this->getMethod()) {
            throw new \Magento\Framework\Exception\LocalizedException(
                __('The payment method you requested is not available.')
            );
        }


        try {
            $instance = $this->_paymentData->getMethodInstance($this->getMethod());
        } catch (\UnexpectedValueException $e) {
            $instance = $this->_paymentData->getMethodInstance(Method\Substitution::CODE);
        }


        $instance->setInfoInstance($this);
        $this->setMethodInstance($instance);
    }


    return $this->_getData('method_instance');
}

3. Magento\Quote\Model\Quote\Payment\ToOrderPayment::convert()

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Quote/Model/Quote/Payment/ToOrderPayment.php#L50-L80


/**
 * @param Payment $object
 * @param array $data
 * @return OrderPaymentInterface
 */
public function convert(Payment $object, $data = [])
{
    $paymentData = $this->objectCopyService->getDataFromFieldset(
        'quote_convert_payment',
        'to_order_payment',
        $object
    );


    $orderPayment = $this->orderPaymentRepository->create();
    $this->dataObjectHelper->populateWithArray(
        $orderPayment,
        array_merge($paymentData, $data),
        '\Magento\Sales\Api\Data\OrderPaymentInterface'
    );
    $orderPayment->setAdditionalInformation(
        array_merge(
            $object->getAdditionalInformation(),
            [Substitution::INFO_KEY_TITLE => $object->getMethodInstance()->getTitle()]
        )
    );
    // set directly on the model
    $orderPayment->setCcNumber($object->getCcNumber());
    $orderPayment->setCcCid($object->getCcCid());


    return $orderPayment;
}

4. Magento\Payment\Model\PaymentMethodList::getList()

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Payment/Model/PaymentMethodList.php#L37-L76


/**
 * {@inheritdoc}
 */
public function getList($storeId)
{
    $methodsCodes = array_keys($this->helper->getPaymentMethods());


    $methodsInstances = array_map(
        function ($code) {
            return $this->helper->getMethodInstance($code);
        },
        $methodsCodes
    );


    $methodsInstances = array_filter($methodsInstances, function (MethodInterface $method) {
        return !($method instanceof \Magento\Payment\Model\Method\Substitution);
    });


    @uasort(
        $methodsInstances,
        function (MethodInterface $a, MethodInterface $b) use ($storeId) {
            return (int)$a->getConfigData('sort_order', $storeId) - (int)$b->getConfigData('sort_order', $storeId);
        }
    );


    $methodList = array_map(
        function (MethodInterface $methodInstance) use ($storeId) {


            return $this->methodFactory->create([
                'code' => (string)$methodInstance->getCode(),
                'title' => (string)$methodInstance->getTitle(),
                'storeId' => (int)$storeId,
                'isActive' => (bool)$methodInstance->isActive($storeId)
            ]);
        },
        $methodsInstances
    );


    return array_values($methodList);
}

5. Magento_Payment/etc/config.xml

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Payment/etc/config.xml#L19-L23


<substitution>
    <active>0</active>
    <model>Magento\Payment\Model\Method\Substitution</model>
    <allowspecific>0</allowspecific>
</substitution>

6. Magento\Payment\Block\Info\Substitution

github.com

magento/magento2/blob/2.1.6/app/code/Magento/Payment/Block/Info/Substitution.php#L6-L36


namespace Magento\Payment\Block\Info;


/**
* Substitution payment info
*/
class Substitution extends \Magento\Payment\Block\Info
{
   /**
    * Add additional info block
    *
    * @return $this
    */
   protected function _beforeToHtml()
   {
       $parentBlock = $this->getParentBlock();
       if (!$parentBlock) {
           return $this;
       }


       $container = $parentBlock->getParentBlock();
       if ($container) {
           $block = $this->_layout->createBlock(
               \Magento\Framework\View\Element\Template::class,
               '',
               ['data' => ['method' => $this->getMethod(), 'template' => 'Magento_Payment::info/substitution.phtml']]
           );
           $container->setChild('order_payment_additional', $block);
       }
       return $this;
   }
}