Edit Class Reference

Inheritance diagram for Edit:

Public Member Functions
	__construct (\Magento\Backend\Block\Widget\Context $context, \Magento\UrlRewrite\Model\UrlRewriteFactory $rewriteFactory, \Magento\Backend\Helper\Data $adminhtmlData, array $data=[])
	getButtonsHtml ($area=null)
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)

Protected Member Functions
	_prepareLayout ()
	_prepareLayoutFeatures ()
	_addEditFormBlock ()
	_addResetButton ()
	_addBackButton ()
	_updateBackButtonLink ($link)
	_addDeleteButton ()
	_addSaveButton ()
	_createEditFormBlock ()
	_addUrlRewriteSelectorBlock ()
	_getUrlRewrite ()
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
	$_controller = 'url_rewrite'
	$_buttonsHtml
	$_adminhtmlData = null
	$_rewriteFactory
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)
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_'
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Block for URL rewrites edit page

Definition at line 11 of file Edit.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Backend\Block\Widget\Context	$context,
		\Magento\UrlRewrite\Model\UrlRewriteFactory	$rewriteFactory,
		\Magento\Backend\Helper\Data	$adminhtmlData,
		array	$data = []
	)

Parameters

\Magento\Backend\Block\Widget\Context	$context
\Magento\UrlRewrite\Model\UrlRewriteFactory	$rewriteFactory
\Magento\Backend\Helper\Data	$adminhtmlData
array	$data

Definition at line 50 of file Edit.php.

      {
        $this->_rewriteFactory = $rewriteFactory;
        $this->_adminhtmlData = $adminhtmlData;
        parent::__construct($context, $data);
    }

Member Function Documentation

_addBackButton()

_addBackButton ( )

protected

Add back button

Returns

void

Definition at line 133 of file Edit.php.

    {
        $this->addButton(
            'back',
            [
                'label' => __('Back'),
                'onclick' => 'setLocation(\'' . $this->_adminhtmlData->getUrl('adminhtml/*/') . '\')',
                'class' => 'back',
                'level' => -1
            ]
        );
    }

_addDeleteButton()

_addDeleteButton ( )

protected

Add delete button

Returns

void

Definition at line 162 of file Edit.php.

    {
        $this->addButton(
            'delete',
            [
                'label' => __('Delete'),
                'onclick' => 'deleteConfirm(' . json_encode(__('Are you sure you want to do this?'))
                    . ','
                    . json_encode(
                        $this->_adminhtmlData->getUrl(
                            'adminhtml/*/delete',
                            ['id' => $this->getUrlRewrite()->getId()]
                        )
                    )
                    . ', {data: {}})',
                'class' => 'scalable delete',
                'level' => -1
            ]
        );
    }

_addEditFormBlock()

_addEditFormBlock ( )

protected

Add child edit form block

Returns

void

Definition at line 98 of file Edit.php.

    {
        $this->setChild('form', $this->_createEditFormBlock());

        if ($this->_getUrlRewrite()->getId()) {
            $this->_addResetButton();
            $this->_addDeleteButton();
        }

        $this->_addSaveButton();
    }

_addResetButton()

_addResetButton ( )

protected

Add reset button

Returns

void

Definition at line 115 of file Edit.php.

    {
        $this->addButton(
            'reset',
            [
                'label' => __('Reset'),
                'onclick' => 'location.reload();',
                'class' => 'scalable',
                'level' => -1
            ]
        );
    }

_addSaveButton()

_addSaveButton ( )

protected

Add save button

Returns

void

Definition at line 188 of file Edit.php.

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

_addUrlRewriteSelectorBlock()

_addUrlRewriteSelectorBlock ( )

protected

Add child URL rewrite selector block

Returns

void

Definition at line 222 of file Edit.php.

    {
        $this->setChild('selector', $this->_getSelectorBlock());
    }

_createEditFormBlock()

_createEditFormBlock ( )

protected

Creates edit form block

Returns

\Magento\UrlRewrite\Block\Edit\Form

Definition at line 208 of file Edit.php.

    {
        return $this->getLayout()->createBlock(
            \Magento\UrlRewrite\Block\Edit\Form::class,
            '',
            ['data' => ['url_rewrite' => $this->_getUrlRewrite()]]
        );
    }

_getUrlRewrite()

_getUrlRewrite ( )

protected

Get or create new instance of URL rewrite

Returns

\Magento\UrlRewrite\Model\UrlRewrite

Definition at line 270 of file Edit.php.

    {
        if (!$this->hasData('url_rewrite')) {
            $this->setUrlRewrite($this->_rewriteFactory->create());
        }
        return $this->getUrlRewrite();
    }

_prepareLayout()

_prepareLayout ( )

protected

Prepare URL rewrite editing layout

Returns

$this

Definition at line 66 of file Edit.php.

    {
        $this->setTemplate('Magento_UrlRewrite::edit.phtml');

        $this->_addBackButton();
        $this->_prepareLayoutFeatures();

        return parent::_prepareLayout();
    }

_prepareLayoutFeatures()

_prepareLayoutFeatures ( )

protected

Prepare featured blocks for layout of URL rewrite editing

Returns

void

Definition at line 81 of file Edit.php.

    {
        if ($this->_getUrlRewrite()->getId()) {
            $this->_headerText = __('Edit URL Rewrite');
        } else {
            $this->_headerText = __('Add New URL Rewrite');
        }

        $this->_addUrlRewriteSelectorBlock();
        $this->_addEditFormBlock();
    }

_updateBackButtonLink()

_updateBackButtonLink (   $link )

protected

Update Back button location link

Parameters

string

$link

Returns

void

Definition at line 152 of file Edit.php.

    {
        $this->updateButton('back', 'onclick', 'setLocation(\'' . $link . '\')');
    }

getButtonsHtml()

getButtonsHtml

(

$area = null

)

Get container buttons HTML

Since buttons are set as children, we remove them as children after generating them not to duplicate them in future

Parameters

string | null

$area

Returns

string @SuppressWarnings(PHPMD.UnusedFormalParameter)

Definition at line 250 of file Edit.php.

    {
        if (null === $this->_buttonsHtml) {
            $this->_buttonsHtml = parent::getButtonsHtml();
            $layout = $this->getLayout();
            foreach ($this->getChildNames() as $name) {
                $alias = $layout->getElementAlias($name);
                if (false !== strpos($alias, '_button')) {
                    $layout->unsetChild($this->getNameInLayout(), $alias);
                }
            }
        }
        return $this->_buttonsHtml;
    }

Field Documentation

$_adminhtmlData

$_adminhtmlData = null

protected

Definition at line 37 of file Edit.php.

$_buttonsHtml

$_buttonsHtml

protected

Definition at line 30 of file Edit.php.

$_controller

$_controller = 'url_rewrite'

protected

Definition at line 23 of file Edit.php.

$_rewriteFactory

$_rewriteFactory

protected

Definition at line 42 of file Edit.php.

---

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

• vendor/magento/module-url-rewrite/Block/Edit.php