Inheritance diagram for Success:

Public Member Functions
	__construct (\Magento\Framework\View\Element\Template\Context $context, \Magento\Checkout\Model\Session $checkoutSession, \Magento\Sales\Model\Order\Config $orderConfig, \Magento\Framework\App\Http\Context $httpContext, array $data=[])

	getAdditionalInfoHtml ()

	getContinueUrl ()

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
	_beforeToHtml ()

	prepareBlockData ()

	isVisible (Order $order)

	canViewOrder (Order $order)

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
	$_checkoutSession

	$_orderConfig

	$httpContext

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

One page checkout success page

@api

Since: 100.0.2

Definition at line 17 of file Success.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Framework\View\Element\Template\Context	$context,
		\Magento\Checkout\Model\Session	$checkoutSession,
		\Magento\Sales\Model\Order\Config	$orderConfig,
		\Magento\Framework\App\Http\Context	$httpContext,
		array	$data = `[]`
	)

Parameters

\Magento\Framework\View\Element\Template\Context	$context
\Magento\Checkout\Model\Session	$checkoutSession
\Magento\Sales\Model\Order\Config	$orderConfig
\Magento\Framework\App\Http\Context	$httpContext
array	$data

Definition at line 41 of file Success.php.

       {
         parent::__construct($context, $data);
         $this->_checkoutSession = $checkoutSession;
         $this->_orderConfig = $orderConfig;
         $this->_isScopePrivate = true;
         $this->httpContext = $httpContext;
     }

Member Function Documentation

◆ _beforeToHtml()

_beforeToHtml ( )

protected

Initialize data and prepare it for output

Returns: string

Definition at line 70 of file Success.php.

     {
         $this->prepareBlockData();
         return parent::_beforeToHtml();
     }

◆ canViewOrder()

canViewOrder ( Order $order )

protected

Can view order

Parameters

Order $order

Returns: bool

Definition at line 123 of file Success.php.

     {
         return $this->httpContext->getValue(Context::CONTEXT_AUTH)
             && $this->isVisible($order);
     }

◆ getAdditionalInfoHtml()

getAdditionalInfoHtml ( )

Render additional order information lines and return result html

Returns: string

Definition at line 60 of file Success.php.

     {
         return $this->_layout->renderElement('order.success.additional.info');
     }

◆ getContinueUrl()

getContinueUrl ( )

Returns: string

Since: 100.2.0

Definition at line 133 of file Success.php.

     {
         return $this->_storeManager->getStore()->getBaseUrl();
     }

◆ isVisible()

isVisible ( Order $order )

protected

Is order visible

Parameters

Order $order

Returns: bool

Definition at line 109 of file Success.php.

     {
         return !in_array(
             $order->getStatus(),
             $this->_orderConfig->getInvisibleOnFrontStatuses()
         );
     }

◆ prepareBlockData()

prepareBlockData ( )

protected

Prepares block data

Returns: void

Definition at line 81 of file Success.php.

     {
         $order = $this->_checkoutSession->getLastRealOrder();
 
         $this->addData(
             [
                 'is_order_visible' => $this->isVisible($order),
                 'view_order_url' => $this->getUrl(
                     'sales/order/view/',
                     ['order_id' => $order->getEntityId()]
                 ),
                 'print_url' => $this->getUrl(
                     'sales/order/print',
                     ['order_id' => $order->getEntityId()]
                 ),
                 'can_print_order' => $this->isVisible($order),
                 'can_view_order'  => $this->canViewOrder($order),
                 'order_id'  => $order->getIncrementId()
             ]
         );
     }

Field Documentation

◆ $_checkoutSession

$_checkoutSession

protected

Definition at line 22 of file Success.php.

◆ $_orderConfig

$_orderConfig

protected

Definition at line 27 of file Success.php.

◆ $httpContext

$httpContext

protected

Definition at line 32 of file Success.php.

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

vendor/magento/module-checkout/Block/Onepage/Success.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _beforeToHtml()

◆ canViewOrder()

◆ getAdditionalInfoHtml()

◆ getContinueUrl()

◆ isVisible()

◆ prepareBlockData()

Field Documentation

◆ $_checkoutSession

◆ $_orderConfig

◆ $httpContext