Validator Class Reference

Public Member Functions
	__construct ()
	addDataValidators ($dataKey, $validators)
	getErrorMessages ($dataKey=null)
	validate (\Magento\Framework\DataObject $data)

Protected Member Functions
	_setTitleValidators ()
	_setTypeValidators ()
	_instantiateValidators (array &$validators)
	_validateDataItem ($validator, $dataKey, $dataValue)

Protected Attributes
	$_dataValidators = []
	$_errorMessages

Detailed Description

Class Validator

Definition at line 11 of file Validator.php.

Constructor & Destructor Documentation

__construct()

__construct

(

)

Initialize validators

Definition at line 32 of file Validator.php.

    {
        $this->_setTypeValidators();
        $this->_setTitleValidators();
    }

Member Function Documentation

_instantiateValidators()

_instantiateValidators ( array &  $validators )

protected

Instantiate class validator

Parameters

array

&$validators

Returns

$this

Definition at line 132 of file Validator.php.

    {
        foreach ($validators as &$validator) {
            if (is_string($validator['class'])) {
                $validator['class'] = new $validator['class']($validator['options']);
                $validator['class']->setDisableTranslator(true);
            }
        }
        return $this;
    }

_setTitleValidators()

_setTitleValidators ( )

protected

Set title validators

Returns

$this

Definition at line 43 of file Validator.php.

    {
        $titleValidators = [
            [
                'name' => 'not_empty',
                'class' => 'Zend_Validate_NotEmpty',
                'break' => true,
                'options' => [],
                'message' => (string)new \Magento\Framework\Phrase('Field title can\'t be empty'),
            ],
        ];

        $this->addDataValidators('theme_title', $titleValidators);
        return $this;
    }

_setTypeValidators()

_setTypeValidators ( )

protected

Set theme type validators

Returns

$this

Definition at line 64 of file Validator.php.

    {
        $typeValidators = [
            [
                'name' => 'not_empty',
                'class' => 'Zend_Validate_NotEmpty',
                'break' => true,
                'options' => [],
                'message' => (string)new \Magento\Framework\Phrase('Theme type can\'t be empty'),
            ],
            [
                'name' => 'available',
                'class' => 'Zend_Validate_InArray',
                'break' => true,
                'options' => [
                    'haystack' => [
                        \Magento\Framework\View\Design\ThemeInterface::TYPE_PHYSICAL,
                        \Magento\Framework\View\Design\ThemeInterface::TYPE_VIRTUAL,
                        \Magento\Framework\View\Design\ThemeInterface::TYPE_STAGING,
                    ],
                ],
                'message' => (string)new \Magento\Framework\Phrase('Theme type is invalid')
            ],
        ];

        $this->addDataValidators('type', $typeValidators);

        return $this;
    }

_validateDataItem()

_validateDataItem (   $validator,   $dataKey,   $dataValue  )

protected

Validate one data item

Parameters

array	$validator
string	$dataKey
mixed	$dataValue

Returns

bool

Definition at line 151 of file Validator.php.

    {
        if ($validator['class'] instanceof \Zend_Validate_NotEmpty && !$validator['class']->isValid(
            $dataValue
        ) || !empty($dataValue) && !$validator['class']->isValid(
            $dataValue
        )
        ) {
            $this->_errorMessages[$dataKey][] = $validator['message'];
            if ($validator['break']) {
                return false;
            }
        }
        return true;
    }

addDataValidators()

addDataValidators	(		$dataKey,
			$validators
	)

Add validators

Parameters

string	$dataKey
array	$validators

Returns

$this

Definition at line 101 of file Validator.php.

    {
        if (!isset($this->_dataValidators[$dataKey])) {
            $this->_dataValidators[$dataKey] = [];
        }
        foreach ($validators as $validator) {
            $this->_dataValidators[$dataKey][$validator['name']] = $validator;
        }
        return $this;
    }

getErrorMessages()

getErrorMessages

(

$dataKey = null

)

Return error messages for items

Parameters

string | null

$dataKey

Returns

array

Definition at line 118 of file Validator.php.

    {
        if ($dataKey) {
            return $this->_errorMessages[$dataKey] ?? [];
        }
        return $this->_errorMessages;
    }

validate()

validate

(

\Magento\Framework\DataObject

$data

)

Validate all data items

Parameters

\Magento\Framework\DataObject

$data

Returns

bool

Definition at line 173 of file Validator.php.

    {
        $this->_errorMessages = [];
        foreach ($this->_dataValidators as $dataKey => $validators) {
            if (!isset($data[$dataKey])) {
                continue;
            }

            $this->_instantiateValidators($validators);
            foreach ($validators as $validator) {
                if (!$this->_validateDataItem($validator, $dataKey, $data[$dataKey])) {
                    break;
                }
            }
        }
        return empty($this->_errorMessages);
    }

Field Documentation

$_dataValidators

$_dataValidators = []

protected

Definition at line 19 of file Validator.php.

$_errorMessages

$_errorMessages

protected

Definition at line 27 of file Validator.php.

---

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

• vendor/magento/framework/View/Design/Theme/Validator.php