How is the isMultiselect parameter passed to the toOptionArray method of \Magento\Framework\Data\OptionSourceInterface?

dmitry_fedyuk · May 13, 2016, 2:00pm

Interface

magento/magento2/blob/ffea3cd/lib/internal/Magento/Framework/Data/OptionSourceInterface.php#L8-L19


/**
* Source of option values in a form of value-label pairs
*/
interface OptionSourceInterface
{
   /**
    * Return array of options as value-label pairs
    *
    * @return array Format: array(array('value' => '<value>', 'label' => '<label>'), ...)
    */
   public function toOptionArray();
}

An implementation example

github.com

magento/magento2/blob/ffea3cd/app/code/Magento/Directory/Model/Config/Source/Country.php#L39-L55


public function toOptionArray($isMultiselect = false, $foregroundCountries = '')
{
    if (!$this->_options) {
        $this->_options = $this->_countryCollection->loadData()->setForegroundCountries(
            $foregroundCountries
        )->toOptionArray(
            false
        );
    }


    $options = $this->_options;
    if (!$isMultiselect) {
        array_unshift($options, ['value' => '', 'label' => __('--Please Select--')]);
    }


    return $options;
}

How is the «isMultiselect» parameter passed?

\Magento\Config\Model\Config\Structure\Element\Field::_getOptionsFromSourceModel()

github.com

magento/magento2/blob/ffea3cd/app/code/Magento/Config/Model/Config/Structure/Element/Field.php#L443-L443


$optionArray = $sourceModel->toOptionArray($this->getType() == 'multiselect');

So, the true value is passed, then the element type is multiselect:

github.com

magento/magento2/blob/ffea3cd/app/code/Magento/Backend/etc/adminhtml/system.xml#L201-L201


<field id="allow" translate="label" type="multiselect" sortOrder="2" showInDefault="1" showInWebsite="1" showInStore="1">

dmitry_fedyuk · March 28, 2017, 11:48am