Config Class Reference

Inheritance diagram for Config:

Public Member Functions
	__construct ( $configFiles, \Magento\Framework\Config\DomFactory $domFactory, \Magento\Framework\Validator\UniversalFactory $builderFactory)
	createValidatorBuilder ($entityName, $groupName, array $builderConfig=null)
	createValidator ($entityName, $groupName, array $builderConfig=null)
	getSchemaFile ()
Public Member Functions inherited from AbstractXml
	__construct ( $configFiles, \Magento\Framework\Config\DomFactory $domFactory)
	getSchemaFile ()
	getPerFileSchemaFile ()

Data Fields
const	CONSTRAINT_TYPE_ENTITY = 'entity'
const	CONSTRAINT_TYPE_PROPERTY = 'property'

Protected Member Functions
	_extractConstraintOptions (\DOMElement $constraint)
	_getInitialXml ()
	_getIdAttributes ()
Protected Member Functions inherited from AbstractXml
	_extractData (\DOMDocument $dom)
	_merge ($configFiles)
	_performValidate ($file=null)
	_getDomConfigModel ()
	_getInitialXml ()
	_getIdAttributes ()

Protected Attributes
	$_defaultBuilderClass = \Magento\Framework\Validator\Builder::class
	$_builderFactory
Protected Attributes inherited from AbstractXml
	$_data
	$_domConfig = null
	$domFactory

Detailed Description

Definition at line 14 of file Config.php.

Constructor & Destructor Documentation

__construct()

__construct	(		$configFiles,
		\Magento\Framework\Config\DomFactory	$domFactory,
		\Magento\Framework\Validator\UniversalFactory	$builderFactory
	)

Parameters

array	$configFiles
\Magento\Framework\Config\DomFactory	$domFactory
\Magento\Framework\Validator\UniversalFactory	$builderFactory

Definition at line 37 of file Config.php.

      {
        $this->_builderFactory = $builderFactory;
        parent::__construct($configFiles, $domFactory);
    }

Member Function Documentation

_extractConstraintOptions()

_extractConstraintOptions ( \DOMElement  $constraint )

protected

Extract constraint options.

Parameters

\DOMElement

$constraint

Returns

array|null

Read constructor arguments

<constraint class="Constraint"> <argument> <option name="minValue">123</option> <option name="maxValue">234</option> </argument> <argument>0</argument> <argument> <callback class="Class" method="method"> </argument> </constraint>

Read constraint configurator callback

<constraint class="Constraint"> <callback class="Magento\Foo\Helper\Data" method="configureValidator"> </constraint>

Read constraint method configuration

Definition at line 208 of file Config.php.

    {
        if (!$constraint->hasChildNodes()) {
            return null;
        }
        $options = [];
        $children = $this->_collectChildren($constraint);

        $arguments = $this->_readArguments($children);
        if ($arguments) {
            $options['arguments'] = $arguments;
        }

        $callback = $this->_readCallback($children);
        if ($callback) {
            $options['callback'] = $callback;
        }

        $methods = $this->_readMethods($children);
        if ($methods) {
            $options['methods'] = $methods;
        }
        return $options;
    }

_getIdAttributes()

_getIdAttributes ( )

protected

Define id attributes for entities

Returns

array

Definition at line 422 of file Config.php.

    {
        return [
            '/validation/entity' => 'name',
            '/validation/entity/rules/rule' => 'name',
            '/validation/entity/rules/rule/entity_constraints/constraint' => 'class',
            '/validation/entity/rules/rule/property_constraints/property/constraint' => 'class',
            '/validation/entity/rules/rule/property_constraints/property' => 'name',
            '/validation/entity/groups/group' => 'name',
            '/validation/entity/groups/group/uses/use' => 'rule'
        ];
    }

_getInitialXml()

_getInitialXml ( )

protected

Get initial XML of a valid document.

Returns

string

Definition at line 411 of file Config.php.

    {
        return '<?xml version="1.0" encoding="UTF-8"?>' .
               '<validation xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"></validation>';
    }

createValidator()

createValidator	(		$entityName,
			$groupName,
		array	$builderConfig = null
	)

Create validator based on entity and group.

Parameters

string	$entityName
string	$groupName
array | null	$builderConfig

Returns

\Magento\Framework\Validator

Definition at line 98 of file Config.php.

    {
        return $this->createValidatorBuilder($entityName, $groupName, $builderConfig)->createValidator();
    }

createValidatorBuilder()

createValidatorBuilder	(		$entityName,
			$groupName,
		array	$builderConfig = null
	)

Create validator builder instance based on entity and group.

Parameters

string	$entityName
string	$groupName
array | null	$builderConfig

Exceptions

Definition at line 55 of file Config.php.

    {
        if (!isset($this->_data[$entityName])) {
            throw new \InvalidArgumentException(sprintf('Unknown validation entity "%s"', $entityName));
        }

        if (!isset($this->_data[$entityName][$groupName])) {
            throw new \InvalidArgumentException(
                sprintf('Unknown validation group "%s" in entity "%s"', $groupName, $entityName)
            );
        }

        $builderClass = isset(
            $this->_data[$entityName][$groupName]['builder']
        ) ? $this->_data[$entityName][$groupName]['builder'] : $this->_defaultBuilderClass;

        if (!class_exists($builderClass)) {
            throw new \InvalidArgumentException(sprintf('Builder class "%s" was not found', $builderClass));
        }

        $builder = $this->_builderFactory->create(
            $builderClass,
            ['constraints' => $this->_data[$entityName][$groupName]['constraints']]
        );
        if (!$builder instanceof \Magento\Framework\Validator\Builder) {
            throw new \InvalidArgumentException(
                sprintf('Builder "%s" must extend \Magento\Framework\Validator\Builder', $builderClass)
            );
        }
        if ($builderConfig) {
            $builder->addConfigurations($builderConfig);
        }
        return $builder;
    }

getSchemaFile()

getSchemaFile

(

)

Get absolute path to validation.xsd

Returns

string

Definition at line 401 of file Config.php.

    {
        return __DIR__ . '/etc/validation.xsd';
    }

Field Documentation

$_builderFactory

$_builderFactory

protected

Definition at line 30 of file Config.php.

$_defaultBuilderClass

$_defaultBuilderClass = \Magento\Framework\Validator\Builder::class

protected

#- #-

Definition at line 25 of file Config.php.

CONSTRAINT_TYPE_ENTITY

const CONSTRAINT_TYPE_ENTITY = 'entity'

#+ Constraints types

Definition at line 19 of file Config.php.

CONSTRAINT_TYPE_PROPERTY

const CONSTRAINT_TYPE_PROPERTY = 'property'

Definition at line 21 of file Config.php.

---

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

• vendor/magento/framework/Validator/Config.php