Builder Class Reference

Public Member Functions
	__construct (\Magento\Framework\Validator\ConstraintFactory $constraintFactory, \Magento\Framework\ValidatorFactory $validatorFactory, \Magento\Framework\Validator\UniversalFactory $oneValidatorFactory, array $constraints)
	createValidator ()
	addConfiguration ($alias, array $configuration)
	addConfigurations (array $configurations)

Protected Member Functions
	_checkConfigurationArguments (array $configuration, $argumentsIsArray)
	_checkMethodArguments (array $configuration)
	_checkConfigurationCallback (array $configuration, $callbackIsArray)
	_createValidatorInstance ()
	_addConstraintCallback (array $constraint, \Magento\Framework\Validator\Constraint\Option\Callback $callback)
	_addConstraintMethod (array $constraint, array $configuration)
	_createConstraint (array $data)
	_createConstraintValidator (array $data)
	_applyArgumentsCallback (array $arguments)

Protected Attributes
	$_constraints
	$_constraintFactory
	$_validatorFactory
	$_oneValidatorFactory

Detailed Description

Definition at line 13 of file Builder.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Validator\ConstraintFactory	$constraintFactory,
		\Magento\Framework\ValidatorFactory	$validatorFactory,
		\Magento\Framework\Validator\UniversalFactory	$oneValidatorFactory,
		array	$constraints
	)

Parameters

\Magento\Framework\Validator\ConstraintFactory	$constraintFactory
\Magento\Framework\ValidatorFactory	$validatorFactory
\Magento\Framework\Validator\UniversalFactory	$oneValidatorFactory
array	$constraints

Definition at line 41 of file Builder.php.

      {
        foreach ($constraints as $constraint) {
            if (isset($constraint['options']) && is_array($constraint['options'])) {
                $this->_checkConfigurationArguments($constraint['options'], true);
                $this->_checkConfigurationCallback($constraint['options'], true);
            }
        }
        $this->_constraints = $constraints;
        $this->_constraintFactory = $constraintFactory;
        $this->_validatorFactory = $validatorFactory;
        $this->_oneValidatorFactory = $oneValidatorFactory;
    }

Member Function Documentation

_addConstraintCallback()

_addConstraintCallback ( array  $constraint, \Magento\Framework\Validator\Constraint\Option\Callback  $callback  )

protected

Add callback to constraint configuration

Parameters

array	$constraint
\Magento\Framework\Validator\Constraint\Option\Callback	$callback

Returns

array

Definition at line 200 of file Builder.php.

      {
        if (!array_key_exists('callback', $constraint['options'])) {
            $constraint['options']['callback'] = [];
        }
        $constraint['options']['callback'][] = $callback;
        return $constraint;
    }

_addConstraintMethod()

_addConstraintMethod ( array  $constraint, array  $configuration  )

protected

Add method to constraint configuration

Parameters

array	$constraint
array	$configuration

Returns

array

Definition at line 218 of file Builder.php.

    {
        if (!array_key_exists('methods', $constraint['options'])) {
            $constraint['options']['methods'] = [];
        }
        $constraint['options']['methods'][] = $configuration;
        return $constraint;
    }

_applyArgumentsCallback()

_applyArgumentsCallback ( array  $arguments )

protected

Apply all argument callback

Parameters

OptionInterface[]

$arguments

Returns

OptionInterface[]

Definition at line 343 of file Builder.php.

    {
        foreach ($arguments as &$argument) {
            if (is_array($argument)) {
                $argument = $this->_applyArgumentsCallback($argument);
            } elseif ($argument instanceof OptionInterface) {
                $argument = $argument->getValue();
            }
        }
        return $arguments;
    }

_checkConfigurationArguments()

_checkConfigurationArguments ( array  $configuration,   $argumentsIsArray  )

protected

Check configuration arguments

Parameters

array	$configuration
bool	$argumentsIsArray

Returns

void

Exceptions

Definition at line 67 of file Builder.php.

    {
        // https://jira.corp.x.com/browse/MAGETWO-10439
        $allowedKeys = ['arguments', 'callback', 'method', 'methods', 'breakChainOnFailure'];
        if (!array_intersect($allowedKeys, array_keys($configuration))) {
            throw new \InvalidArgumentException('Configuration has incorrect format');
        }
        // Check method arguments
        if ($argumentsIsArray) {
            if (array_key_exists('methods', $configuration)) {
                foreach ($configuration['methods'] as $method) {
                    $this->_checkMethodArguments($method);
                }
            }
        } elseif (array_key_exists('method', $configuration)) {
            $this->_checkMethodArguments($configuration);
        }

        // Check constructor arguments
        if (array_key_exists('arguments', $configuration) && !is_array($configuration['arguments'])) {
            throw new \InvalidArgumentException('Arguments must be an array');
        }
    }

_checkConfigurationCallback()

_checkConfigurationCallback ( array  $configuration,   $callbackIsArray  )

protected

Check configuration callbacks

Parameters

array	$configuration
bool	$callbackIsArray

Returns

void

Exceptions

Definition at line 116 of file Builder.php.

    {
        if (array_key_exists('callback', $configuration)) {
            if ($callbackIsArray) {
                $callbacks = $configuration['callback'];
            } else {
                $callbacks = [$configuration['callback']];
            }
            foreach ($callbacks as $callback) {
                if (!$callback instanceof \Magento\Framework\Validator\Constraint\Option\Callback) {
                    throw new \InvalidArgumentException(
                        'Callback must be instance of \Magento\Framework\Validator\Constraint\Option\Callback'
                    );
                }
            }
        }
    }

_checkMethodArguments()

_checkMethodArguments ( array  $configuration )

protected

Check configuration method arguments

Parameters

array

$configuration

Returns

void

Exceptions

Definition at line 98 of file Builder.php.

    {
        if (!is_string($configuration['method'])) {
            throw new \InvalidArgumentException('Method has to be passed as string');
        }
        if (array_key_exists('arguments', $configuration) && !is_array($configuration['arguments'])) {
            throw new \InvalidArgumentException('Method arguments must be an array');
        }
    }

_createConstraint()

_createConstraint ( array  $data )

protected

Create constraint from data

Parameters

array

$data

Returns

\Magento\Framework\Validator\Constraint

Definition at line 249 of file Builder.php.

    {
        // Create validator instance
        $validator = $this->_createConstraintValidator($data);
        if (isset($data['options']) && is_array($data['options'])) {
            $this->_configureConstraintValidator($validator, $data['options']);
        }

        if (\Magento\Framework\Validator\Config::CONSTRAINT_TYPE_PROPERTY == $data['type']) {
            $result = new \Magento\Framework\Validator\Constraint\Property(
                $validator,
                $data['property'],
                $data['alias']
            );
        } else {
            $result = $this->_constraintFactory->create(['validator' => $validator, 'alias' => $data['alias']]);
        }

        return $result;
    }

_createConstraintValidator()

_createConstraintValidator ( array  $data )

protected

Create constraint validator instance

Parameters

array

$data

Returns

\Magento\Framework\Validator\ValidatorInterface

Exceptions

Definition at line 277 of file Builder.php.

    {
        $validator = $this->_oneValidatorFactory->create(
            $data['class'],
            isset(
                $data['options']['arguments']
            ) ? $this->_applyArgumentsCallback(
                $data['options']['arguments']
            ) : []
        );

        // Check validator type
        if (!$validator instanceof \Magento\Framework\Validator\ValidatorInterface) {
            throw new \InvalidArgumentException(
                sprintf(
                    'Constraint class "%s" must implement \Magento\Framework\Validator\ValidatorInterface',
                    $data['class']
                )
            );
        }

        return $validator;
    }

_createValidatorInstance()

_createValidatorInstance ( )

protected

Get validator instance

Returns

\Magento\Framework\Validator

Definition at line 149 of file Builder.php.

    {
        $validator = $this->_validatorFactory->create();
        foreach ($this->_constraints as $constraintData) {
            // https://jira.corp.x.com/browse/MAGETWO-10439
            $breakChainOnFailure = !empty($constraintData['options']['breakChainOnFailure']);
            $validator->addValidator($this->_createConstraint($constraintData), $breakChainOnFailure);
        }
        return $validator;
    }

addConfiguration()

addConfiguration	(		$alias,
		array	$configuration
	)

Add constraint configuration

Parameters

string	$alias
array	$configuration

Returns

$this

Exceptions

Definition at line 168 of file Builder.php.

    {
        $this->_checkConfigurationArguments($configuration, false);
        $this->_checkConfigurationCallback($configuration, false);
        foreach ($this->_constraints as &$constraint) {
            if ($constraint['alias'] != $alias) {
                continue;
            }
            if (!array_key_exists('options', $constraint) || !is_array($constraint['options'])) {
                $constraint['options'] = [];
            }
            if (!array_key_exists('method', $configuration)) {
                if (array_key_exists('arguments', $configuration)) {
                    $constraint['options']['arguments'] = $configuration['arguments'];
                } elseif (array_key_exists('callback', $configuration)) {
                    $constraint = $this->_addConstraintCallback($constraint, $configuration['callback']);
                }
            } else {
                $constraint = $this->_addConstraintMethod($constraint, $configuration);
            }
        }

        return $this;
    }

addConfigurations()

addConfigurations

(

array

$configurations

)

Add constraints configuration

Parameters

array

$configurations

Returns

$this

Definition at line 233 of file Builder.php.

    {
        foreach ($configurations as $alias => $concreteConfigs) {
            foreach ($concreteConfigs as $configuration) {
                $this->addConfiguration($alias, $configuration);
            }
        }
        return $this;
    }

createValidator()

createValidator

(

)

Create validator instance and configure it

Returns

\Magento\Framework\Validator

Definition at line 139 of file Builder.php.

    {
        return $this->_createValidatorInstance();
    }

Field Documentation

$_constraintFactory

$_constraintFactory

protected

Definition at line 23 of file Builder.php.

$_constraints

$_constraints

protected

Definition at line 18 of file Builder.php.

$_oneValidatorFactory

$_oneValidatorFactory

protected

Definition at line 33 of file Builder.php.

$_validatorFactory

$_validatorFactory

protected

Definition at line 28 of file Builder.php.

---

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

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