Container Class Reference

Inheritance diagram for Container:

Public Member Functions
	getBackUrl ()
	getDeleteUrl ()
	getSaveUrl ()
	getFormActionUrl ()
	getFormHtml ()
	getFormInitScripts ()
	getFormScripts ()
	getHeaderWidth ()
	getHeaderCssClass ()
	getHeaderHtml ()
	setDataObject ($object)
Public Member Functions inherited from Container
	__construct (\Magento\Backend\Block\Widget\Context $context, array $data=[])
	addButton ($buttonId, $data, $level=0, $sortOrder=0, $region='toolbar')
	removeButton ($buttonId)
	updateButton ($buttonId, $key, $data)
	getHeaderText ()
	getHeaderCssClass ()
	getHeaderHtml ()
	hasFooterButtons ()
	canRender (Button\Item $item)
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 ()
Public Member Functions inherited from ContextInterface
	canRender (\Magento\Backend\Block\Widget\Button\Item $item)

Data Fields
const	PARAM_BLOCK_GROUP = 'block_group'
const	PARAM_MODE = 'mode'
Data Fields inherited from Container
const	PARAM_CONTROLLER = 'controller'
const	PARAM_HEADER_TEXT = 'header_text'
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_'

Protected Member Functions
	_construct ()
	_prepareLayout ()
	_buildFormClassName ()
Protected Member Functions inherited from Container
	_construct ()
	_prepareLayout ()
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
	$_objectId = 'id'
	$_formScripts = []
	$_formInitScripts = []
	$_mode = 'edit'
	$_blockGroup = 'Magento_Backend'
	$_template = 'Magento_Backend::widget/form/container.phtml'
Protected Attributes inherited from Container
	$_controller = 'empty'
	$_headerText = 'Container Widget Header'
	$buttonList
	$toolbar
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)
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Backend form container block

@api

Deprecated:

100.2.0 in favour of UI component implementation @SuppressWarnings(PHPMD.NumberOfChildren)

Since

100.0.2

Definition at line 16 of file Container.php.

Member Function Documentation

_buildFormClassName()

_buildFormClassName ( )

protected

Build child form class name

Returns

string

Definition at line 136 of file Container.php.

    {
        return $this->nameBuilder->buildClassName(
            [$this->_blockGroup, 'Block', $this->_controller, $this->_mode, 'Form']
        );
    }

_construct()

_construct ( )

protected

Returns

void

Definition at line 61 of file Container.php.

    {
        parent::_construct();
        if ($this->hasData(self::PARAM_BLOCK_GROUP)) {
            $this->_blockGroup = $this->_getData(self::PARAM_BLOCK_GROUP);
        }
        if ($this->hasData(self::PARAM_MODE)) {
            $this->_mode = $this->_getData(self::PARAM_MODE);
        }

        $this->addButton(
            'back',
            [
                'label' => __('Back'),
                'onclick' => 'setLocation(\'' . $this->getBackUrl() . '\')',
                'class' => 'back'
            ],
            -1
        );
        $this->addButton(
            'reset',
            ['label' => __('Reset'), 'onclick' => 'setLocation(window.location.href)', 'class' => 'reset'],
            -1
        );

        $objId = $this->getRequest()->getParam($this->_objectId);

        if (!empty($objId)) {
            $this->addButton(
                'delete',
                [
                    'label' => __('Delete'),
                    'class' => 'delete',
                    'onclick' => 'deleteConfirm(\'' . __(
                        'Are you sure you want to do this?'
                    ) . '\', \'' . $this->getDeleteUrl() . '\', {data: {}})'
                ]
            );
        }

        $this->addButton(
            'save',
            [
                'label' => __('Save'),
                'class' => 'save primary',
                'data_attribute' => [
                    'mage-init' => ['button' => ['event' => 'save', 'target' => '#edit_form']],
                ]
            ],
            1
        );
    }

_prepareLayout()

_prepareLayout ( )

protected

Create form block

Returns

$this

Definition at line 119 of file Container.php.

    {
        if ($this->_blockGroup && $this->_controller && $this->_mode && !$this->_layout->getChildName(
            $this->_nameInLayout,
            'form'
        )
        ) {
            $this->addChild('form', $this->_buildFormClassName());
        }
        return parent::_prepareLayout();
    }

getBackUrl()

getBackUrl

(

)

Get URL for back (reset) button

Returns

string

Definition at line 148 of file Container.php.

    {
        return $this->getUrl('*/*/');
    }

getDeleteUrl()

getDeleteUrl

(

)

Returns

string

Definition at line 156 of file Container.php.

    {
        return $this->getUrl('*/*/delete', [$this->_objectId => $this->getRequest()->getParam($this->_objectId)]);
    }

getFormActionUrl()

getFormActionUrl

(

)

Get form action URL

Returns

string

Definition at line 177 of file Container.php.

    {
        if ($this->hasFormActionUrl()) {
            return $this->getData('form_action_url');
        }
        return $this->getUrl('*/*/save');
    }

getFormHtml()

getFormHtml

(

)

Returns

string

Definition at line 188 of file Container.php.

    {
        $this->getChildBlock('form')->setData('action', $this->getSaveUrl());
        return $this->getChildHtml('form');
    }

getFormInitScripts()

getFormInitScripts

(

)

Returns

string

Definition at line 197 of file Container.php.

    {
        if (!empty($this->_formInitScripts) && is_array($this->_formInitScripts)) {
            return '<script>' . implode("\n", $this->_formInitScripts) . '</script>';
        }
        return '';
    }

getFormScripts()

getFormScripts

(

)

Returns

string

Definition at line 208 of file Container.php.

    {
        if (!empty($this->_formScripts) && is_array($this->_formScripts)) {
            return '<script>' . implode("\n", $this->_formScripts) . '</script>';
        }
        return '';
    }

getHeaderCssClass()

getHeaderCssClass

(

)

Returns

string

Definition at line 227 of file Container.php.

    {
        return 'icon-head head-' . strtr($this->_controller, '_', '-');
    }

getHeaderHtml()

getHeaderHtml

(

)

Returns

string

Definition at line 235 of file Container.php.

    {
        return '<h3 class="' . $this->getHeaderCssClass() . '">' . $this->getHeaderText() . '</h3>';
    }

getHeaderWidth()

getHeaderWidth

(

)

Returns

string

Definition at line 219 of file Container.php.

    {
        return '';
    }

getSaveUrl()

getSaveUrl

(

)

Get form save URL

See also

getFormActionUrl()

Returns

string

Definition at line 167 of file Container.php.

    {
        return $this->getFormActionUrl();
    }

setDataObject()

setDataObject

(

$object

)

Set data object and pass it to form

Parameters

\Magento\Framework\DataObject

$object

Returns

$this

Definition at line 246 of file Container.php.

    {
        $this->getChildBlock('form')->setDataObject($object);
        return $this->setData('data_object', $object);
    }

Field Documentation

$_blockGroup

$_blockGroup = 'Magento_Backend'

protected

Definition at line 41 of file Container.php.

$_formInitScripts

$_formInitScripts = []

protected

Definition at line 31 of file Container.php.

$_formScripts

$_formScripts = []

protected

Definition at line 26 of file Container.php.

$_mode

$_mode = 'edit'

protected

Definition at line 36 of file Container.php.

$_objectId

$_objectId = 'id'

protected

Definition at line 21 of file Container.php.

$_template

$_template = 'Magento_Backend::widget/form/container.phtml'

protected

Definition at line 56 of file Container.php.

PARAM_BLOCK_GROUP

const PARAM_BLOCK_GROUP = 'block_group'

Definition at line 46 of file Container.php.

PARAM_MODE

const PARAM_MODE = 'mode'

Definition at line 51 of file Container.php.

---

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

• vendor/magento/module-backend/Block/Widget/Form/Container.php