Billing Class Reference

Inheritance diagram for Billing:

Public Member Functions
	__construct (\Magento\Framework\View\Element\Template\Context $context, \Magento\Customer\Model\Session $customerSession, \Magento\Checkout\Model\Session $resourceSession, \Magento\Directory\Model\ResourceModel\Country\CollectionFactory $countryCollectionFactory, CustomerRepositoryInterface $customerRepository, \Magento\Framework\App\Http\Context $httpContext, \Magento\Quote\Model\Quote\AddressFactory $addressFactory, array $data=[])
	isUseBillingAddressForShipping ()
	getCountries ()
	getMethod ()
	getFirstname ()
	getLastname ()
	canShip ()
	getSaveUrl ()
	isTaxvatEnabled ()
	getTaxvatHtml ()
	getAddress ()
	getConfig ($path)
	getCheckout ()
	getQuote ()
	isCustomerLoggedIn ()
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 ()
	_getTaxvat ()
	_getCustomer ()
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
	$address
	$taxvat
	$addressFactory
	$customer
	$quote
	$checkoutSession
	$customerSession
	$customerRepository
	$httpContext
	$countryCollectionFactory
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

@SuppressWarnings(PHPMD.CouplingBetweenObjects)

Definition at line 18 of file Billing.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\View\Element\Template\Context	$context,
		\Magento\Customer\Model\Session	$customerSession,
		\Magento\Checkout\Model\Session	$resourceSession,
		\Magento\Directory\Model\ResourceModel\Country\CollectionFactory	$countryCollectionFactory,
		CustomerRepositoryInterface	$customerRepository,
		\Magento\Framework\App\Http\Context	$httpContext,
		\Magento\Quote\Model\Quote\AddressFactory	$addressFactory,
		array	$data = []
	)

Parameters

\Magento\Framework\View\Element\Template\Context	$context
\Magento\Customer\Model\Session	$customerSession
\Magento\Checkout\Model\Session	$resourceSession
\Magento\Directory\Model\ResourceModel\Country\CollectionFactory	$countryCollectionFactory
CustomerRepositoryInterface	$customerRepository
\Magento\Framework\App\Http\Context	$httpContext
Quote\AddressFactory	$addressFactory
array	$data

Definition at line 84 of file Billing.php.

      {
        $this->addressFactory = $addressFactory;
        $this->_isScopePrivate = true;
        $this->httpContext = $httpContext;
        $this->customerRepository = $customerRepository;
        $this->checkoutSession = $resourceSession;
        $this->customerSession = $customerSession;
        $this->countryCollectionFactory = $countryCollectionFactory;
        parent::__construct($context, $data);
    }

Member Function Documentation

_construct()

_construct ( )

protected

Initialize billing address step

Returns

void

Definition at line 109 of file Billing.php.

    {
        $this->getCheckout()->setStepData(
            'billing',
            ['label' => __('Billing Information'), 'is_show' => true]
        );

        if ($this->isCustomerLoggedIn()) {
            $this->getCheckout()->setStepData('billing', 'allow', true);
        }
        parent::_construct();
    }

_getCustomer()

_getCustomer ( )

protected

Get logged in customer

Returns

\Magento\Customer\Api\Data\CustomerInterface

Definition at line 268 of file Billing.php.

    {
        if (empty($this->customer)) {
            $this->customer = $this->customerRepository->getById($this->customerSession->getCustomerId());
        }
        return $this->customer;
    }

_getTaxvat()

_getTaxvat ( )

protected

Get Customer Taxvat Widget block

Returns

\Magento\Customer\Block\Widget\Taxvat

Definition at line 197 of file Billing.php.

    {
        if (!$this->taxvat) {
            $this->taxvat = $this->getLayout()->createBlock(\Magento\Customer\Block\Widget\Taxvat::class);
        }

        return $this->taxvat;
    }

canShip()

canShip

(

)

Check is Quote items can ship to

Returns

bool

Definition at line 180 of file Billing.php.

    {
        return !$this->getQuote()->isVirtual();
    }

getAddress()

getAddress

(

)

Return Sales Quote Address model

Returns

\Magento\Quote\Model\Quote\Address

Definition at line 233 of file Billing.php.

    {
        if ($this->address === null) {
            if ($this->isCustomerLoggedIn() || $this->getQuote()->getBillingAddress()) {
                $this->address = $this->getQuote()->getBillingAddress();
                if (!$this->address->getFirstname()) {
                    $this->address->setFirstname($this->getQuote()->getCustomer()->getFirstname());
                }
                if (!$this->address->getLastname()) {
                    $this->address->setLastname($this->getQuote()->getCustomer()->getLastname());
                }
            } else {
                $this->address = $this->addressFactory->create();
            }
        }

        return $this->address;
    }

getCheckout()

getCheckout

(

)

Retrieve checkout session model

Returns

\Magento\Checkout\Model\Session

Definition at line 281 of file Billing.php.

    {
        return $this->checkoutSession;
    }

getConfig()

getConfig

(

$path

)

Get config

Parameters

string

$path

Returns

string|null

Definition at line 258 of file Billing.php.

    {
        return $this->_scopeConfig->getValue($path, \Magento\Store\Model\ScopeInterface::SCOPE_STORE);
    }

getCountries()

getCountries

(

)

Return country collection

Returns

\Magento\Directory\Model\ResourceModel\Country\Collection

Definition at line 138 of file Billing.php.

    {
        return $this->countryCollectionFactory->create()->loadByStore();
    }

getFirstname()

getFirstname

(

)

Return Customer Address First Name If Sales Quote Address First Name is not defined - return Customer First Name

Returns

string

Definition at line 159 of file Billing.php.

    {
        return $this->getAddress()->getFirstname();
    }

getLastname()

getLastname

(

)

Return Customer Address Last Name If Sales Quote Address Last Name is not defined - return Customer Last Name

Returns

string

Definition at line 170 of file Billing.php.

    {
        return $this->getAddress()->getLastname();
    }

getMethod()

getMethod

(

)

Return checkout method

Returns

string

Definition at line 148 of file Billing.php.

    {
        return $this->getQuote()->getCheckoutMethod();
    }

getQuote()

getQuote

(

)

Retrieve sales quote model

Returns

Quote

Definition at line 291 of file Billing.php.

    {
        if (empty($this->quote)) {
            $this->quote = $this->getCheckout()->getQuote();
        }
        return $this->quote;
    }

getSaveUrl()

getSaveUrl

(

)

Returns

void

Definition at line 188 of file Billing.php.

    {
    }

getTaxvatHtml()

getTaxvatHtml

(

)

Returns

string

Definition at line 219 of file Billing.php.

    {
        return $this->_getTaxvat()
            ->setTaxvat($this->getQuote()->getCustomerTaxvat())
            ->setFieldIdFormat('billing:%s')
            ->setFieldNameFormat('billing[%s]')
            ->toHtml();
    }

isCustomerLoggedIn()

isCustomerLoggedIn

(

)

Returns

bool

Definition at line 302 of file Billing.php.

    {
        return $this->httpContext->getValue(\Magento\Customer\Model\Context::CONTEXT_AUTH);
    }

isTaxvatEnabled()

isTaxvatEnabled

(

)

Check whether taxvat is enabled

Returns

bool

Definition at line 211 of file Billing.php.

    {
        return $this->_getTaxvat()->isEnabled();
    }

isUseBillingAddressForShipping()

isUseBillingAddressForShipping

(

)

Returns

bool

Definition at line 125 of file Billing.php.

    {
        if ($this->getQuote()->getIsVirtual() || !$this->getQuote()->getShippingAddress()->getSameAsBilling()) {
            return false;
        }
        return true;
    }

Field Documentation

$address

$address

protected

Definition at line 25 of file Billing.php.

$addressFactory

$addressFactory

protected

Definition at line 37 of file Billing.php.

$checkoutSession

$checkoutSession

protected

Definition at line 52 of file Billing.php.

$countryCollectionFactory

$countryCollectionFactory

protected

Definition at line 72 of file Billing.php.

$customer

$customer

protected

Definition at line 42 of file Billing.php.

$customerRepository

$customerRepository

protected

Definition at line 62 of file Billing.php.

$customerSession

$customerSession

protected

Definition at line 57 of file Billing.php.

$httpContext

$httpContext

protected

Definition at line 67 of file Billing.php.

$quote

$quote

protected

Definition at line 47 of file Billing.php.

$taxvat

$taxvat

protected

Definition at line 32 of file Billing.php.

---

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

• vendor/magento/module-paypal/Block/Express/Review/Billing.php