Inheritance diagram for Iframe:

Public Member Functions
	__construct (\Magento\Framework\View\Element\Template\Context $context, \Magento\Sales\Model\OrderFactory $orderFactory, \Magento\Checkout\Model\Session $checkoutSession, \Magento\Paypal\Helper\Hss $hssHelper, \Magento\Framework\Filesystem\Directory\ReadFactory $readFactory, \Magento\Framework\Module\Dir\Reader $reader, array $data=[])

	getFrameActionUrl ()

	getSecureToken ()

	getSecureTokenId ()

	getTransactionUrl ()

	isTestMode ()

Public Member Functions inherited from Form
	getMethod ()

	setMethod (MethodInterface $method)

	getMethodCode ()

	getInfoData ($field)

Public Member Functions inherited from Template
	__construct (Template\Context $context, array $data=[])

	setTemplateContext ($templateContext)

	getTemplate ()

	setTemplate ($template)

	getTemplateFile ($template=null)

	getArea ()

	assign ($key, $value=null)

	fetchView ($fileName)

	getBaseUrl ()

	getObjectData (\Magento\Framework\DataObject $object, $key)

	getCacheKeyInfo ()

Public Member Functions inherited from AbstractBlock
	__construct (\Magento\Framework\View\Element\Context $context, array $data=[])

	getJsLayout ()

	getRequest ()

	getParentBlock ()

	setLayout (\Magento\Framework\View\LayoutInterface $layout)

	getLayout ()

	setNameInLayout ($name)

	getChildNames ()

	setAttribute ($name, $value=null)

	setChild ($alias, $block)

	addChild ($alias, $block, $data=[])

	unsetChild ($alias)

	unsetCallChild ($alias, $callback, $result, $params)

	unsetChildren ()

	getChildBlock ($alias)

	getChildHtml ($alias='', $useCache=true)

	getChildChildHtml ($alias, $childChildAlias='', $useCache=true)

	getBlockHtml ($name)

	insert ($element, $siblingName=0, $after=true, $alias='')

	append ($element, $alias='')

	getGroupChildNames ($groupName)

	getChildData ($alias, $key='')

	getUiId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)

	getJsId ($arg1=null, $arg2=null, $arg3=null, $arg4=null, $arg5=null)

	getUrl ($route='', $params=[])

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

	formatDate ( $date=null, $format=\IntlDateFormatter::SHORT, $showTime=false, $timezone=null)

	formatTime ( $time=null, $format=\IntlDateFormatter::SHORT, $showDate=false)

	getModuleName ()

	escapeHtml ($data, $allowedTags=null)

	escapeJs ($string)

	escapeHtmlAttr ($string, $escapeSingleQuote=true)

	escapeCss ($string)

	stripTags ($data, $allowableTags=null, $allowHtmlEntities=false)

	escapeUrl ($string)

	escapeXssInUrl ($data)

	escapeQuote ($data, $addSlashes=false)

	escapeJsQuote ($data, $quote='\'')

	getNameInLayout ()

	getCacheKeyInfo ()

	getCacheKey ()

	getVar ($name, $module=null)

	isScopePrivate ()

Public Member Functions inherited from DataObject
	__construct (array $data=[])

	addData (array $arr)

	setData ($key, $value=null)

	unsetData ($key=null)

	getData ($key='', $index=null)

	getDataByPath ($path)

	getDataByKey ($key)

	setDataUsingMethod ($key, $args=[])

	getDataUsingMethod ($key, $args=null)

	hasData ($key='')

	toArray (array $keys=[])

	convertToArray (array $keys=[])

	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)

	toJson (array $keys=[])

	convertToJson (array $keys=[])

	toString ($format='')

	__call ($method, $args)

	isEmpty ()

	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')

	debug ($data=null, &$objects=[])

	offsetSet ($offset, $value)

	offsetExists ($offset)

	offsetUnset ($offset)

	offsetGet ($offset)

Public Member Functions inherited from BlockInterface
	toHtml ()

Protected Member Functions
	_construct ()

	_getBlock ()

	_getOrder ()

	_getCheckout ()

	_beforeToHtml ()

	_toHtml ()

	_isAfterPaymentSave ()

Protected Member Functions inherited from Template
	_construct ()

	_toHtml ()

	getRootDirectory ()

	getMediaDirectory ()

Protected Member Functions inherited from AbstractBlock
	_construct ()

	_prepareLayout ()

	_beforeToHtml ()

	_afterToHtml ($html)

	_toHtml ()

	_getNotFoundUrl ($route='', $params=['_direct'=> 'core/index/notFound'])

	getCacheTags ()

	getCacheLifetime ()

	_loadCache ()

	_saveCache ($data)

	_getSidPlaceholder ($cacheKey=null)

Protected Member Functions inherited from DataObject
	_getData ($key)

	_underscore ($name)

Protected Attributes
	$_shouldRender = false

	$_order

	$_paymentMethodCode

	$_block

	$_template = 'Magento_Paypal::hss/js.phtml'

	$_orderFactory

	$_checkoutSession

	$_hssHelper

	$readFactory

	$reader

Protected Attributes inherited from Template
	$_viewVars = []

	$_baseUrl

	$_jsUrl

	$_allowSymlinks

	$_filesystem

	$_template

	$templateEnginePool

	$_storeManager

	$_appState

	$directory

	$templateContext

	$pageConfig

	$resolver

	$validator

Protected Attributes inherited from AbstractBlock
	$_design

	$_session

	$_sidResolver

	$_nameInLayout

	$_layout

	$jsLayout = []

	$_request

	$_urlBuilder

	$_eventManager

	$_frontController

	$_assetRepo

	$_viewConfig

	$_cacheState

	$_logger

	$_escaper

	$filterManager

	$_localeDate

	$inlineTranslation

	$_isScopePrivate = false

	$_scopeConfig

	$_cache

Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Public Member Functions inherited from AbstractBlock
static	extractModuleName ($className)

Data Fields inherited from Template
const	XML_PATH_TEMPLATE_ALLOW_SYMLINK = 'dev/template/allow_symlink'

Data Fields inherited from AbstractBlock
const	CACHE_GROUP = \Magento\Framework\App\Cache\Type\Block::TYPE_IDENTIFIER

const	CACHE_KEY_PREFIX = 'BLOCK_'

Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

HSS iframe block

@api

Since: 100.0.2

Definition at line 14 of file Iframe.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\View\Element\Template\Context	$context,
		\Magento\Sales\Model\OrderFactory	$orderFactory,
		\Magento\Checkout\Model\Session	$checkoutSession,
		\Magento\Paypal\Helper\Hss	$hssHelper,
		\Magento\Framework\Filesystem\Directory\ReadFactory	$readFactory,
		\Magento\Framework\Module\Dir\Reader	$reader,
		array	$data = `[]`
	)

Parameters

\Magento\Framework\View\Element\Template\Context	$context
\Magento\Sales\Model\OrderFactory	$orderFactory
\Magento\Checkout\Model\Session	$checkoutSession
\Magento\Paypal\Helper\Hss	$hssHelper
\Magento\Framework\Filesystem\Directory\ReadFactory	$readFactory
\Magento\Framework\Module\Dir\Reader	$reader
array	$data

Definition at line 83 of file Iframe.php.

       {
         $this->_hssHelper = $hssHelper;
         $this->_orderFactory = $orderFactory;
         $this->_checkoutSession = $checkoutSession;
         $this->_isScopePrivate = true;
         $this->readFactory = $readFactory;
         $this->reader = $reader;
         parent::__construct($context, $data);
     }

Member Function Documentation

◆ _beforeToHtml()

_beforeToHtml ( )

protected

Before rendering html, check if is block rendering needed

Returns: \Magento\Framework\View\Element\AbstractBlock

Definition at line 177 of file Iframe.php.

     {
         if ($this->_getOrder()->getId() &&
             $this->_getOrder()->getQuoteId() == $this->_getCheckout()->getLastQuoteId() &&
             $this->_paymentMethodCode
         ) {
             $this->_shouldRender = true;
         }
 
         if ($this->getGotoSection() || $this->getGotoSuccessPage()) {
             $this->_shouldRender = true;
         }
 
         return parent::_beforeToHtml();
     }

◆ _construct()

_construct ( )

protected

Internal constructor

Returns: void

Definition at line 106 of file Iframe.php.

     {
         parent::_construct();
         $paymentCode = $this->_getCheckout()->getQuote()->getPayment()->getMethod();
         if (in_array($paymentCode, $this->_hssHelper->getHssMethods())) {
             $this->_paymentMethodCode = $paymentCode;
             $templatePath = str_replace('_', '', $paymentCode);
             $templateFile = "Magento_Paypal::{$templatePath}/iframe.phtml";
             $directory = $this->readFactory->create($this->reader->getModuleDir('', 'Magento_Paypal'));
             $file = $this->resolver->getTemplateFileName($templateFile, ['module' => 'Magento_Paypal']);
             if ($file && $directory->isExist($directory->getRelativePath($file))) {
                 $this->setTemplate($templateFile);
             } else {
                 $this->setTemplate('Magento_Paypal::hss/iframe.phtml');
             }
         }
     }

◆ _getBlock()

_getBlock ( )

protected

Get current block instance

Returns: \Magento\Payment\Block\Form

Exceptions

Definition at line 130 of file Iframe.php.

     {
         if (!$this->_block) {
             $this->_block = $this->getLayout()->createBlock(
                 'Magento\\Paypal\\Block\\' . str_replace(
                     ' ',
                     '\\',
                     ucwords(str_replace('_', ' ', $this->_paymentMethodCode))
                 ) . '\\Iframe'
             );
             if (!$this->_block instanceof \Magento\Paypal\Block\Iframe) {
                 throw new \Magento\Framework\Exception\LocalizedException(__('Invalid block type'));
             }
         }
 
         return $this->_block;
     }

◆ _getCheckout()

_getCheckout ( )

protected

Get frontend checkout session object

Returns: \Magento\Checkout\Model\Session

Definition at line 167 of file Iframe.php.

     {
         return $this->_checkoutSession;
     }

◆ _getOrder()

_getOrder ( )

protected

Get order object

Returns: \Magento\Sales\Model\Order

Definition at line 153 of file Iframe.php.

     {
         if (!$this->_order) {
             $incrementId = $this->_getCheckout()->getLastRealOrderId();
             $this->_order = $this->_orderFactory->create()->loadByIncrementId($incrementId);
         }
         return $this->_order;
     }

◆ _isAfterPaymentSave()

_isAfterPaymentSave ( )

protected

Check whether block is rendering after save payment

Returns: bool

Definition at line 215 of file Iframe.php.

     {
         $quote = $this->_getCheckout()->getQuote();
         if ($quote->getPayment()->getMethod() == $this->_paymentMethodCode &&
             $quote->getIsActive() &&
             $this->getTemplate() &&
             $this->getRequest()->getActionName() == 'savePayment'
         ) {
             return true;
         }
 
         return false;
     }

◆ _toHtml()

_toHtml ( )

protected

Render the block if needed

Returns: string

Definition at line 198 of file Iframe.php.

     {
         if ($this->_isAfterPaymentSave()) {
             $this->setTemplate('Magento_Paypal::hss/js.phtml');
             return parent::_toHtml();
         }
         if (!$this->_shouldRender) {
             return '';
         }
         return parent::_toHtml();
     }

◆ getFrameActionUrl()

getFrameActionUrl ( )

Get iframe action URL

Returns: string

Definition at line 234 of file Iframe.php.

     {
         return $this->_getBlock()->getFrameActionUrl();
     }

◆ getSecureToken()

getSecureToken ( )

Get secure token

Returns: string

Definition at line 244 of file Iframe.php.

     {
         return $this->_getBlock()->getSecureToken();
     }

◆ getSecureTokenId()

getSecureTokenId ( )

Get secure token ID

Returns: string

Definition at line 254 of file Iframe.php.

     {
         return $this->_getBlock()->getSecureTokenId();
     }

◆ getTransactionUrl()

getTransactionUrl ( )

Get payflow transaction URL

Returns: string

Definition at line 264 of file Iframe.php.

     {
         return $this->_getBlock()->getTransactionUrl();
     }

◆ isTestMode()

isTestMode ( )

Check sandbox mode

Returns: bool

Definition at line 274 of file Iframe.php.

     {
         return $this->_getBlock()->isTestMode();
     }

Field Documentation

◆ $_block

$_block

protected

Definition at line 42 of file Iframe.php.

◆ $_checkoutSession

$_checkoutSession

protected

Definition at line 57 of file Iframe.php.

◆ $_hssHelper

$_hssHelper

protected

Definition at line 62 of file Iframe.php.

◆ $_order

$_order

protected

Definition at line 28 of file Iframe.php.

◆ $_orderFactory

$_orderFactory

protected

Definition at line 52 of file Iframe.php.

◆ $_paymentMethodCode

$_paymentMethodCode

protected

Definition at line 35 of file Iframe.php.

◆ $_shouldRender

$_shouldRender = false

protected

Definition at line 21 of file Iframe.php.

◆ $_template

$_template = 'Magento_Paypal::hss/js.phtml'

protected

Definition at line 47 of file Iframe.php.

◆ $reader

$reader

protected

Definition at line 72 of file Iframe.php.

◆ $readFactory

$readFactory

protected

Definition at line 67 of file Iframe.php.

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

vendor/magento/module-paypal/Block/Iframe.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _beforeToHtml()

◆ _construct()

◆ _getBlock()

◆ _getCheckout()

◆ _getOrder()

◆ _isAfterPaymentSave()

◆ _toHtml()

◆ getFrameActionUrl()

◆ getSecureToken()

◆ getSecureTokenId()

◆ getTransactionUrl()

◆ isTestMode()

Field Documentation

◆ $_block

◆ $_checkoutSession

◆ $_hssHelper

◆ $_order

◆ $_orderFactory

◆ $_paymentMethodCode

◆ $_shouldRender

◆ $_template

◆ $reader

◆ $readFactory