How is the \Magento\Framework\Data\OptionSourceInterface implemented and used?

dmitrii_fediuk · March 28, 2017, 11:43am

Implementation

magento/magento2/blob/2.1.5/lib/internal/Magento/Framework/Data/OptionSourceInterface.php#L8-L21


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

Usages

1. Magento\Ui\Component\Form\Element\AbstractOptionsField::prepare()

github.com

magento/magento2/blob/2.1.5/app/code/Magento/Ui/Component/Form/Element/AbstractOptionsField.php#L39-L63


/**
 * Prepare component configuration
 *
 * @return void
 */
public function prepare()
{
    $config = $this->getData('config');
    if (isset($this->options)) {
        if (!isset($config['options'])) {
            $config['options'] = [];
        }
        if ($this->options instanceof OptionSourceInterface) {
            $options = $this->options->toOptionArray();
        } else {
            $options = array_values($this->options);
        }
        if (empty($config['rawOptions'])) {
            $options = $this->convertOptionsValueToString($options);
        }
        $config['options'] = array_values(array_merge_recursive($config['options'], $options));
    }
    $this->setData('config', (array)$config);
    parent::prepare();
}

2. Magento\Framework\View\Layout\Argument\Interpreter\Options::evaluate()

github.com

magento/magento2/blob/2.1.5/lib/internal/Magento/Framework/View/Layout/Argument/Interpreter/Options.php#L29-L56


/**
 * {@inheritdoc}
 * @return array Format: array(array('value' => <value>, 'label' => '<label>'), ...)
 * @throws \InvalidArgumentException
 * @throws \UnexpectedValueException
 */
public function evaluate(array $data)
{
    if (!isset($data['model'])) {
        throw new \InvalidArgumentException('Options source model class is missing.');
    }
    $modelClass = $data['model'];
    $modelInstance = $this->objectManager->get($modelClass);
    if (!$modelInstance instanceof \Magento\Framework\Data\OptionSourceInterface) {
        throw new \UnexpectedValueException(
            sprintf("Instance of the options source model is expected, got %s instead.", get_class($modelInstance))
        );
    }
    $result = [];
    foreach ($modelInstance->toOptionArray() as $value => $label) {
        if (is_array($label)) {
            $result[] = $label;
        } else {
            $result[] = ['value' => $value, 'label' => $label];
        }
    }
    return $result;
}

dmitrii_fediuk · March 28, 2017, 11:48am