Allowspecific Class Reference

Inheritance diagram for Allowspecific:

Public Member Functions
	getAfterElementHtml ()
	getHtml ()
Public Member Functions inherited from Select
	__construct (Factory $factoryElement, CollectionFactory $factoryCollection, Escaper $escaper, $data=[])
	getElementHtml ()
	getHtmlAttributes ()
Public Member Functions inherited from AbstractElement
	__construct (Factory $factoryElement, CollectionFactory $factoryCollection, Escaper $escaper, $data=[])
	addElement (AbstractElement $element, $after=false)
	isAdvanced ()
	setAdvanced ($advanced)
	getId ()
	getType ()
	getForm ()
	setId ($id)
	getHtmlId ()
	getName ()
	setType ($type)
	setForm ($form)
	removeField ($elementId)
	getHtmlAttributes ()
	addClass ($class)
	removeClass ($class)
	getEscapedValue ($index=null)
	setRenderer (RendererInterface $renderer)
	getRenderer ()
	getElementHtml ()
	getBeforeElementHtml ()
	getAfterElementHtml ()
	getAfterElementJs ()
	getLabelHtml ($idSuffix='', $scopeLabel='')
	getDefaultHtml ()
	getHtml ()
	toHtml ()
	serialize ($attributes=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	getReadonly ()
	getHtmlContainerId ()
	addElementValues ($values, $overwrite=false)
	lock ()
	isLocked ()
Public Member Functions inherited from AbstractForm
	__construct (Factory $factoryElement, CollectionFactory $factoryCollection, $data=[])
	addType ($type, $className)
	getElements ()
	setReadonly ($readonly, $useDisabled=false)
	addElement (AbstractElement $element, $after=null)
	addField ($elementId, $type, $config, $after=false)
	removeField ($elementId)
	addFieldset ($elementId, $config, $after=false, $isAdvanced=false)
	addColumn ($elementId, $config)
	convertToArray (array $arrAttributes=[])
	addCustomAttribute ($key, $value)
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
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)

Protected Member Functions
	_getSpecificCountryElementId ()
Protected Member Functions inherited from Select
	_optionToHtml ($option, $selected)
	_prepareOptions ()
Protected Member Functions inherited from AbstractElement
	_escape ($string)
	_getUiId ($suffix=null)
Protected Member Functions inherited from AbstractForm
	_construct ()
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

Additional Inherited Members
Protected Attributes inherited from AbstractElement
	$_id
	$_type
	$_form
	$_elements
	$_renderer
	$_advanced = false
	$_escaper
Protected Attributes inherited from AbstractForm
	$_elements
	$_types = []
	$_factoryElement
	$_factoryCollection
	$customAttributes = []
Protected Attributes inherited from DataObject
	$_data = []
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Definition at line 14 of file Allowspecific.php.

Member Function Documentation

_getSpecificCountryElementId()

_getSpecificCountryElementId ( )

protected

Returns

string

Definition at line 66 of file Allowspecific.php.

    {
        return substr($this->getId(), 0, strrpos($this->getId(), 'allowspecific')) . 'specificcountry';
    }

getAfterElementHtml()

getAfterElementHtml

(

)

Add additional Javascript code

Returns

string

Definition at line 21 of file Allowspecific.php.

    {
        $elementId = $this->getHtmlId();
        $countryListId = $this->_getSpecificCountryElementId();
        $useDefaultElementId = $countryListId . '_inherit';

        $elementJavaScript = <<<HTML
<script type="text/javascript">
//<![CDATA[
document.getElementById('{$elementId}').addEventListener('change', function(event) {
    var isCountrySpecific = event.target.value == 1,
        specificCountriesElement = document.getElementById('{$countryListId}'),
        // 'Use Default' checkbox of the related county list UI element
        useDefaultElement = document.getElementById('{$useDefaultElementId}');

    if (isCountrySpecific) {
        // enable related country select only if its 'Use Default' checkbox is absent or is unchecked
        specificCountriesElement.disabled = useDefaultElement ? useDefaultElement.checked : false;
    } else {
        // disable related country select if all countries are used
        specificCountriesElement.disabled = true;
    }
});
//]]>
</script>
HTML;

        return $elementJavaScript . parent::getAfterElementHtml();
    }

getHtml()

getHtml

(

)

Returns

string

Definition at line 54 of file Allowspecific.php.

    {
        if (!$this->getValue() || 1 != $this->getValue()) {
            $element = $this->getForm()->getElement($this->_getSpecificCountryElementId());
            $element->setDisabled('disabled');
        }
        return parent::getHtml();
    }

---

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

• vendor/magento/module-config/Block/System/Config/Form/Field/Select/Allowspecific.php