Inheritance diagram for MultiSelectConfigOption:

Public Member Functions
	__construct ( $name, $frontendType, array $selectOptions, $configPath, $description='', array $defaultValue=[], $shortCut=null)

	getSelectOptions ()

	validate ($data)

Public Member Functions inherited from AbstractConfigOption
	__construct ( $name, $frontendType, $mode, $configPath, $description='', $defaultValue=null, $shortcut=null)

	getFrontendType ()

	getConfigPath ()

	validate ($data)

Data Fields
const	FRONTEND_WIZARD_CHECKBOX = 'checkbox'

const	FRONTEND_WIZARD_MULTISELECT = 'multiselect'

Detailed Description

Multi-select option in deployment config tool

Definition at line 11 of file MultiSelectConfigOption.php.

Constructor & Destructor Documentation

◆ __construct()

__construct	(		$name,
			$frontendType,
		array	$selectOptions,
			$configPath,
			$description = `''`,
		array	$defaultValue = `[]`,
			$shortCut = `null`
	)

Constructor

Parameters

string	$name
string	$frontendType
array	$selectOptions
string	$configPath
string	$description
array	$defaultValue
string \| array \| null	$shortCut

Exceptions

Definition at line 35 of file MultiSelectConfigOption.php.

       {
         if ($frontendType != self::FRONTEND_WIZARD_MULTISELECT && $frontendType != self::FRONTEND_WIZARD_CHECKBOX) {
             throw new \InvalidArgumentException(
                 "Frontend input type has to be 'multiselect', 'textarea' or 'checkbox'."
             );
         }
         if (!$selectOptions) {
             throw new \InvalidArgumentException('Select options can\'t be empty.');
         }
         $this->selectOptions = $selectOptions;
         parent::__construct(
             $name,
             $frontendType,
             self::VALUE_REQUIRED | self::VALUE_IS_ARRAY,
             $configPath,
             $description,
             $defaultValue,
             $shortCut
         );
     }

Member Function Documentation

◆ getSelectOptions()

getSelectOptions ( )

Get available options

Returns: array

Definition at line 69 of file MultiSelectConfigOption.php.

     {
         return $this->selectOptions;
     }

◆ validate()

validate ( $data )

Validates input data

Parameters

mixed $data

Returns: void

Exceptions

Definition at line 81 of file MultiSelectConfigOption.php.

     {
         if (is_array($data)) {
             foreach ($data as $value) {
                 if (!in_array($value, $this->getSelectOptions())) {
                     throw new \InvalidArgumentException(
                         "Value specified for '{$this->getName()}' is not supported: '{$value}'"
                     );
                 }
             }
         }
         parent::validate($data);
     }

Field Documentation

◆ FRONTEND_WIZARD_CHECKBOX

const FRONTEND_WIZARD_CHECKBOX = 'checkbox'

#+ Frontend input types

Definition at line 16 of file MultiSelectConfigOption.php.

◆ FRONTEND_WIZARD_MULTISELECT

const FRONTEND_WIZARD_MULTISELECT = 'multiselect'

Definition at line 17 of file MultiSelectConfigOption.php.

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

vendor/magento/framework/Setup/Option/MultiSelectConfigOption.php

Public Member Functions

Data Fields