Items Class Reference

Inheritance diagram for Items:

Public Member Functions
	__construct (\Magento\Backend\Block\Template\Context $context, \Magento\GiftMessage\Helper\Message $messageHelper, array $data=[])
	getItem ()
	getDefaultSender ()
	getDefaultRecipient ()
	getFieldName ($name)
	getFieldId ($id)
	getFieldIdPrefix ()
	getMessage ()
	getSaveUrl ()
	getHtmlId ()
	canDisplayGiftmessage ()
	getSender ()
	getRecipient ()
	getMessageText ()
Public Member Functions inherited from Template
	__construct (\Magento\Backend\Block\Template\Context $context, array $data=[])
	getFormKey ()
	isOutputEnabled ($moduleName=null)
	getAuthorization ()
	getToolbar ()
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
	_initMessage ()
Protected Member Functions inherited from Template
	_toHtml ()
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
	$_giftMessage = []
	$_messageHelper
Protected Attributes inherited from Template
	$_authorization
	$mathRandom
	$_backendSession
	$formKey
	$nameBuilder
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

Gift message adminhtml sales order view items

@api

Author

Magento Core Team core@.nosp@m.mage.nosp@m.ntoco.nosp@m.mmer.nosp@m.ce.co.nosp@m.m

Since

100.0.2

Definition at line 15 of file Items.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Backend\Block\Template\Context	$context,
		\Magento\GiftMessage\Helper\Message	$messageHelper,
		array	$data = []
	)

Parameters

\Magento\Backend\Block\Template\Context	$context
\Magento\GiftMessage\Helper\Message	$messageHelper
array	$data

Definition at line 34 of file Items.php.

      {
        $this->_messageHelper = $messageHelper;
        parent::__construct($context, $data);
    }

Member Function Documentation

_initMessage()

_initMessage ( )

protected

Initialize gift message for entity

Returns

$this

Definition at line 140 of file Items.php.

    {
        $this->_giftMessage[$this->getItem()->getGiftMessageId()] = $this->_messageHelper->getGiftMessage(
            $this->getItem()->getGiftMessageId()
        );

        // init default values for giftmessage form
        if (!$this->getMessage()->getSender()) {
            $this->getMessage()->setSender($this->getDefaultSender());
        }
        if (!$this->getMessage()->getRecipient()) {
            $this->getMessage()->setRecipient($this->getDefaultRecipient());
        }

        return $this;
    }

canDisplayGiftmessage()

canDisplayGiftmessage

(

)

Indicates that block can display giftmessages form

Returns

boolean

Definition at line 201 of file Items.php.

    {
        return $this->getItem()->getGiftMessageId();
    }

getDefaultRecipient()

getDefaultRecipient

(

)

Retrieve default value for giftmessage recipient

Returns

string

Definition at line 77 of file Items.php.

    {
        if (!$this->getItem()) {
            return '';
        }

        if ($this->getItem()->getOrder()) {
            if ($this->getItem()->getOrder()->getShippingAddress()) {
                return $this->getItem()->getOrder()->getShippingAddress()->getName();
            } elseif ($this->getItem()->getOrder()->getBillingAddress()) {
                return $this->getItem()->getOrder()->getBillingAddress()->getName();
            }
        }

        if ($this->getItem()->getShippingAddress()) {
            return $this->getItem()->getShippingAddress()->getName();
        } elseif ($this->getItem()->getBillingAddress()) {
            return $this->getItem()->getBillingAddress()->getName();
        }

        return '';
    }

getDefaultSender()

getDefaultSender

(

)

Retrieve default value for giftmessage sender

Returns

string

Definition at line 59 of file Items.php.

    {
        if (!$this->getItem()) {
            return '';
        }

        if ($this->getItem()->getOrder()) {
            return $this->getItem()->getOrder()->getBillingAddress()->getName();
        }

        return $this->getItem()->getBillingAddress()->getName();
    }

getFieldId()

getFieldId

(

$id

)

Retrieve real html id for field

Parameters

string

$id

Returns

string @codeCoverageIgnore

Definition at line 119 of file Items.php.

    {
        return $this->getFieldIdPrefix() . $id;
    }

getFieldIdPrefix()

getFieldIdPrefix

(

)

Retrieve field html id prefix

Returns

string @codeCoverageIgnore

Definition at line 130 of file Items.php.

    {
        return 'giftmessage_' . $this->getItem()->getId() . '_';
    }

getFieldName()

getFieldName

(

$name

)

Retrieve real name for field

Parameters

string

$name

Returns

string @codeCoverageIgnore

Definition at line 107 of file Items.php.

    {
        return 'giftmessage[' . $this->getItem()->getId() . '][' . $name . ']';
    }

getHtmlId()

getHtmlId

(

)

Retrieve block html id

Returns

string @codeCoverageIgnore

Definition at line 191 of file Items.php.

    {
        return substr($this->getFieldIdPrefix(), 0, -1);
    }

getItem()

getItem

(

)

Get Order Item

Returns

\Magento\Sales\Model\Order\Item @codeCoverageIgnore

Definition at line 49 of file Items.php.

    {
        return $this->getParentBlock()->getItem();
    }

getMessage()

getMessage

(

)

Retrieve gift message for entity

Returns

\Magento\GiftMessage\Model\Message

Definition at line 162 of file Items.php.

    {
        if (!isset($this->_giftMessage[$this->getItem()->getGiftMessageId()])) {
            $this->_initMessage();
        }

        return $this->_giftMessage[$this->getItem()->getGiftMessageId()];
    }

getMessageText()

getMessageText

(

)

Retrieve gift message text

Returns

string

Definition at line 231 of file Items.php.

    {
        return $this->escapeHtml($this->getMessage()->getMessage());
    }

getRecipient()

getRecipient

(

)

Retrieve gift message recipient

Returns

string

Definition at line 221 of file Items.php.

    {
        return $this->escapeHtml($this->getMessage()->getRecipient());
    }

getSaveUrl()

getSaveUrl

(

)

Retrieve save url

Returns

array @codeCoverageIgnore

Definition at line 177 of file Items.php.

    {
        return $this->getUrl(
            'sales/order_view_giftmessage/save',
            ['entity' => $this->getItem()->getId(), 'type' => 'order_item', 'reload' => true]
        );
    }

getSender()

getSender

(

)

Retrieve gift message sender

Returns

string

Definition at line 211 of file Items.php.

    {
        return $this->escapeHtml($this->getMessage()->getSender());
    }

Field Documentation

$_giftMessage

$_giftMessage = []

protected

Definition at line 22 of file Items.php.

$_messageHelper

$_messageHelper

protected

Definition at line 27 of file Items.php.

---

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

• vendor/magento/module-gift-message/Block/Adminhtml/Sales/Order/View/Items.php