Button Class Reference

Inheritance diagram for Button:

Public Member Functions
	getType ()
	getAttributesHtml ()
	getOnClick ()
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 ()
	getTemplatePath ()
	prepareAttributes ($title, $classes, $disabled)
	attributesToHtml ($attributes)
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)

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_'
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 = []
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Class Button

Definition at line 14 of file Button.php.

Member Function Documentation

_construct()

_construct ( )

protected

Define block template

Returns

void

Definition at line 21 of file Button.php.

    {
        $this->setTemplate($this->getTemplatePath());

        parent::_construct();
    }

attributesToHtml()

attributesToHtml (   $attributes )

protected

Attributes list to html

Parameters

array

$attributes

Returns

string

Definition at line 130 of file Button.php.

    {
        $html = '';
        foreach ($attributes as $attributeKey => $attributeValue) {
            if ($attributeValue === null || $attributeValue == '') {
                continue;
            }
            $html .= $attributeKey . '="' . $this->escapeHtmlAttr($attributeValue, false) . '" ';
        }

        return $html;
    }

getAttributesHtml()

getAttributesHtml

(

)

Retrieve attributes html

Returns

string

Definition at line 57 of file Button.php.

    {
        $disabled = $this->getDisabled() ? 'disabled' : '';
        $title = $this->getTitle();
        if (empty($title)) {
            $title = $this->getLabel();
        }
        $classes = ['action-', 'scalable'];
        if ($this->hasData('class')) {
            $classes[] = $this->getClass();
        }
        if ($disabled) {
            $classes[] = $disabled;
        }

        return $this->attributesToHtml($this->prepareAttributes($title, $classes, $disabled));
    }

getOnClick()

getOnClick

(

)

Retrieve onclick handler

Returns

string|null

Definition at line 80 of file Button.php.

    {
        if ($this->hasData('on_click')) {
            return $this->getData('on_click');
        } else {
            $url = $this->hasData('url') ? $this->getData('url') : $this->getUrl();
            if (!empty($url)) {
                return sprintf("location.href = '%s';", $url);
            }

            return null;
        }
    }

getTemplatePath()

getTemplatePath ( )

protected

Retrieve template path

Returns

string

Definition at line 33 of file Button.php.

    {
        return 'Magento_Ui::control/button/default.phtml';
    }

getType()

getType

(

)

Retrieve button type

Returns

string

Definition at line 43 of file Button.php.

    {
        if (in_array($this->getData('type'), ['reset', 'submit'])) {
            return $this->getData('type');
        }

        return 'button';
    }

prepareAttributes()

prepareAttributes (   $title,   $classes,   $disabled  )

protected

Prepare attributes

Parameters

string	$title
array	$classes
string	$disabled

Returns

array

Definition at line 102 of file Button.php.

    {
        $attributes = [
            'id' => $this->getId(),
            'name' => $this->getElementName(),
            'title' => $title,
            'type' => $this->getType(),
            'class' => implode(' ', $classes),
            'onclick' => $this->getOnClick(),
            'style' => $this->getStyle(),
            'value' => $this->getValue(),
            'disabled' => $disabled,
        ];
        if ($this->getDataAttribute()) {
            foreach ($this->getDataAttribute() as $key => $attr) {
                $attributes['data-' . $key] = is_scalar($attr) ? $attr : json_encode($attr);
            }
        }

        return $attributes;
    }

---

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

• vendor/magento/module-ui/Component/Control/Button.php