Variables Class Reference

Inheritance diagram for Variables:

Public Member Functions
	__construct (\Magento\Config\Model\Config\Structure\SearchInterface $configStructure, array $configPaths=[])
	toOptionArray ($withGroup=false)
	getData ()
Public Member Functions inherited from OptionSourceInterface
	toOptionArray ()

Data Fields
const	DEFAULT_VARIABLE_TYPE = "default"
const	CUSTOM_VARIABLE_TYPE = "custom"

Detailed Description

Store Contact Information source model.

Definition at line 11 of file Variables.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Config\Model\Config\Structure\SearchInterface	$configStructure,
		array	$configPaths = []
	)

Constructor.

Parameters

\Magento\Config\Model\Config\Structure\SearchInterface	$configStructure
array	$configPaths

Definition at line 42 of file Variables.php.

      {
        $this->configStructure = $configStructure;
        $this->configPaths = $configPaths;
    }

Member Function Documentation

getData()

getData

(

)

Return available config variables.

Returns

array @codeCoverageIgnore

Definition at line 93 of file Variables.php.

    {
        return $this->getFlatConfigVars();
    }

toOptionArray()

toOptionArray

(

$withGroup = false

)

Retrieve option array of store contact variables.

Parameters

bool

$withGroup

Returns

array

Definition at line 56 of file Variables.php.

    {
        $optionArray = [];
        if ($withGroup) {
            foreach ($this->getConfigVariables() as $configVariableGroup) {
                $group = [
                    'label' => $configVariableGroup['label']
                ];
                $groupElements = [];
                foreach ($configVariableGroup['elements'] as $element) {
                    $groupElements[] = [
                        'value' => '{{config path="' . $element['value'] . '"}}',
                        'label' => $element['label'],
                    ];
                }
                $group['value'] = $groupElements;
                $optionArray[] = $group;
            }
        } else {
            foreach ($this->getConfigVariables() as $configVariableGroup) {
                foreach ($configVariableGroup['elements'] as $element) {
                    $optionArray[] = [
                        'value' => '{{config path="' . $element['value'] . '"}}',
                        'label' => $element['label'],
                    ];
                }
            }
        }
        return $optionArray;
    }

Field Documentation

CUSTOM_VARIABLE_TYPE

const CUSTOM_VARIABLE_TYPE = "custom"

Definition at line 17 of file Variables.php.

DEFAULT_VARIABLE_TYPE

const DEFAULT_VARIABLE_TYPE = "default"

Variable types

Definition at line 16 of file Variables.php.

---

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

• vendor/magento/module-variable/Model/Source/Variables.php