Inheritance diagram for Chooser:

Public Member Functions
	__construct (\Magento\Backend\Block\Template\Context $context, \Magento\Framework\Json\EncoderInterface $jsonEncoder, \Magento\Framework\Data\Form\Element\Factory $elementFactory, array $data=[])

	getSourceUrl ()

	getElement ()

	getConfig ()

	getUniqId ()

	getFieldsetId ()

	getHiddenEnabled ()

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
	_toHtml ()

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
	$_elementFactory

	$_jsonEncoder

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

Chooser widget block.

Definition at line 17 of file Chooser.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(	\Magento\Backend\Block\Template\Context	$context,
		\Magento\Framework\Json\EncoderInterface	$jsonEncoder,
		\Magento\Framework\Data\Form\Element\Factory	$elementFactory,
		array	$data = `[]`
	)

Parameters

\Magento\Backend\Block\Template\Context	$context
\Magento\Framework\Json\EncoderInterface	$jsonEncoder
\Magento\Framework\Data\Form\Element\Factory	$elementFactory
array	$data

Definition at line 35 of file Chooser.php.

       {
         $this->_jsonEncoder = $jsonEncoder;
         $this->_elementFactory = $elementFactory;
         parent::__construct($context, $data);
     }

Member Function Documentation

◆ _toHtml()

_toHtml ( )

protected

Return chooser HTML and init scripts

Returns: string

Definition at line 137 of file Chooser.php.

     {
         $element = $this->getElement();
         /* @var $fieldset \Magento\Framework\Data\Form\Element\Fieldset */
         $fieldset = $element->getForm()->getElement($this->getFieldsetId());
         $chooserId = $this->getUniqId();
         $config = $this->getConfig();
 
         // add chooser element to fieldset
         $chooser = $fieldset->addField(
             'chooser' . $element->getId(),
             'note',
             ['label' => $config->getLabel() ? $config->getLabel() : '', 'value_class' => 'value2']
         );
         $hiddenHtml = '';
         if ($this->getHiddenEnabled()) {
             $hidden = $this->_elementFactory->create('hidden', ['data' => $element->getData()]);
             $hidden->setId("{$chooserId}value")->setForm($element->getForm());
             if ($element->getRequired()) {
                 $hidden->addClass('required-entry');
             }
             $hiddenHtml = $hidden->getElementHtml();
             $element->setValue('');
         }
 
         $buttons = $config->getButtons();
         $chooseButton = $this->getLayout()->createBlock(
             \Magento\Backend\Block\Widget\Button::class
         )->setType(
             'button'
         )->setId(
             $chooserId . 'control'
         )->setClass(
             'btn-chooser'
         )->setLabel(
             $buttons['open']
         )->setOnclick(
             $chooserId . '.choose()'
         )->setDisabled(
             $element->getReadonly()
         );
         $chooser->setData('after_element_html', $hiddenHtml . $chooseButton->toHtml());
 
         // render label and chooser scripts
         $configJson = $this->_jsonEncoder->encode($config->getData());
         return '
             <label class="widget-option-label" id="' .
             $chooserId .
             'label">' .
             ($this->getLabel() ? $this->escapeHtml($this->getLabel()) : __(
                 'Not Selected'
             )) .
             '</label>
             <div id="' .
             $chooserId .
             'advice-container" class="hidden"></div>
             <script>
             require(["prototype", "mage/adminhtml/wysiwyg/widget"], function(){
             //<![CDATA[
                 (function() {
                     var instantiateChooser = function() {
                         window.' .
             $chooserId .
             ' = new WysiwygWidget.chooser(
                             "' .
             $chooserId .
             '",
                             "' .
             $this->getSourceUrl() .
             '",
                             ' .
             $configJson .
             '
                         );
                         if ($("' .
             $chooserId .
             'value")) {
                             $("' .
             $chooserId .
             'value").advaiceContainer = "' .
             $chooserId .
             'advice-container";
                         }
                     }
 
                     jQuery(instantiateChooser);
                 })();
             //]]>
             });
             </script>
         ';
     }

◆ getConfig()

getConfig ( )

Convert Array config to Object

Returns: \Magento\Framework\DataObject

Definition at line 71 of file Chooser.php.

     {
         if ($this->_getData('config') instanceof \Magento\Framework\DataObject) {
             return $this->_getData('config');
         }
 
         $configArray = $this->_getData('config');
         $config = new \Magento\Framework\DataObject();
         $this->setConfig($config);
         if (!is_array($configArray)) {
             return $this->_getData('config');
         }
 
         // define chooser label
         if (isset($configArray['label'])) {
             $config->setData('label', __($configArray['label']));
         }
 
         // chooser control buttons
         $buttons = ['open' => __('Choose...'), 'close' => __('Close')];
         if (isset($configArray['button']) && is_array($configArray['button'])) {
             foreach ($configArray['button'] as $id => $label) {
                 $buttons[$id] = __($label);
             }
         }
         $config->setButtons($buttons);
 
         return $this->_getData('config');
     }

◆ getElement()

getElement ( )

Chooser form element getter

Returns: \Magento\Framework\Data\Form\Element\AbstractElement

Definition at line 61 of file Chooser.php.

     {
         return $this->_getData('element');
     }

◆ getFieldsetId()

getFieldsetId ( )

Form element fieldset id getter for working with form in chooser

Returns: string

Definition at line 116 of file Chooser.php.

     {
         return $this->_getData('fieldset_id');
     }

◆ getHiddenEnabled()

getHiddenEnabled ( )

Flag to indicate include hidden field before chooser or not

Returns: bool @SuppressWarnings(PHPMD.BooleanGetMethodName)

Definition at line 127 of file Chooser.php.

     {
         return $this->hasData('hidden_enabled') ? (bool)$this->_getData('hidden_enabled') : true;
     }

◆ getSourceUrl()

getSourceUrl ( )

Chooser source URL getter

Returns: string

Definition at line 51 of file Chooser.php.

     {
         return $this->_getData('source_url');
     }

◆ getUniqId()

getUniqId ( )

Unique identifier for block that uses Chooser

Returns: string

Definition at line 106 of file Chooser.php.

     {
         return $this->_getData('uniq_id');
     }

Field Documentation

◆ $_elementFactory

$_elementFactory

protected

Definition at line 22 of file Chooser.php.

◆ $_jsonEncoder

$_jsonEncoder

protected

Definition at line 27 of file Chooser.php.

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

vendor/magento/module-widget/Block/Adminhtml/Widget/Chooser.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _toHtml()

◆ getConfig()

◆ getElement()

◆ getFieldsetId()

◆ getHiddenEnabled()

◆ getSourceUrl()

◆ getUniqId()

Field Documentation

◆ $_elementFactory

◆ $_jsonEncoder