Layout Class Reference

Inheritance diagram for Layout:

Public Member Functions
	__construct (\Magento\Theme\Model\Layout\Config $config)
	getOptions ()
	toOptionArray ($withEmpty=false)
	getDefaultValue ()
Public Member Functions inherited from OptionSourceInterface
	toOptionArray ()

Protected Attributes
	$_config
	$_options = null
	$_defaultValue = null

Detailed Description

Definition at line 8 of file Layout.php.

Constructor & Destructor Documentation

__construct()

__construct

(

\Magento\Theme\Model\Layout\Config

$config

)

Parameters

\Magento\Theme\Model\Layout\Config

$config

Definition at line 18 of file Layout.php.

    {
        $this->_config = $config;
    }

Member Function Documentation

getDefaultValue()

getDefaultValue

(

)

Default options value getter

Returns

string

Definition at line 81 of file Layout.php.

    {
        $this->getOptions();
        return $this->_defaultValue;
    }

getOptions()

getOptions

(

)

Retrieve page layout options

Returns

array

Definition at line 41 of file Layout.php.

    {
        if ($this->_options === null) {
            $this->_options = [];
            foreach ($this->_config->getPageLayouts() as $layout) {
                $this->_options[$layout->getCode()] = $layout->getLabel();
                if ($layout->getIsDefault()) {
                    $this->_defaultValue = $layout->getCode();
                }
            }
        }

        return $this->_options;
    }

toOptionArray()

toOptionArray

(

$withEmpty = false

)

Retrieve page layout options array

Parameters

bool

$withEmpty

Returns

array

Definition at line 62 of file Layout.php.

    {
        $options = [];

        foreach ($this->getOptions() as $value => $label) {
            $options[] = ['label' => $label, 'value' => $value];
        }

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

        return $options;
    }

Field Documentation

$_config

$_config

protected

Definition at line 13 of file Layout.php.

$_defaultValue

$_defaultValue = null

protected

Definition at line 34 of file Layout.php.

$_options

$_options = null

protected

Definition at line 28 of file Layout.php.

---

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

• vendor/magento/module-theme/Model/Layout/Source/Layout.php