Constraint Class Reference

Inheritance diagram for Constraint:

Public Member Functions
	__construct (\Magento\Framework\Validator\ValidatorInterface $validator, $alias=null)
	isValid ($value)
	getAlias ()
	setTranslator ($translator=null)
	getTranslator ()
Public Member Functions inherited from AbstractValidator
	setTranslator ($translator=null)
	getTranslator ()
	hasTranslator ()
	getMessages ()
	hasMessages ()

Protected Member Functions
	_getValidatorValue ($value)
Protected Member Functions inherited from AbstractValidator
	_clearMessages ()
	_addMessages (array $messages)

Protected Attributes
	$_wrappedValidator
	$_alias
Protected Attributes inherited from AbstractValidator
	$_translator = null
	$_messages = []

Additional Inherited Members
Static Public Member Functions inherited from AbstractValidator
static	setDefaultTranslator (\Magento\Framework\Translate\AdapterInterface $translator=null)
static	getDefaultTranslator ()
Static Protected Attributes inherited from AbstractValidator
static	$_defaultTranslator = null

Detailed Description

@api

Since

100.0.2

Definition at line 14 of file Constraint.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Validator\ValidatorInterface	$validator,
			$alias = null
	)

Constructor

Parameters

\Magento\Framework\Validator\ValidatorInterface	$validator
string	$alias

Definition at line 36 of file Constraint.php.

    {
        $this->_wrappedValidator = $validator;
        $this->_alias = $alias;
    }

Member Function Documentation

_getValidatorValue()

_getValidatorValue (   $value )

protected

Get value that should be validated.

Parameters

mixed

$value

Returns

mixed

Definition at line 68 of file Constraint.php.

    {
        if (is_array($value)) {
            $value = new \Magento\Framework\DataObject($value);
        }
        return $value;
    }

getAlias()

getAlias

(

)

Get constraint alias

Returns

string @api

Definition at line 82 of file Constraint.php.

    {
        return $this->_alias;
    }

getTranslator()

getTranslator

(

)

Get translator instance of wrapped validator

Returns

\Magento\Framework\Translate\AdapterInterface|null

Implements ValidatorInterface.

Definition at line 104 of file Constraint.php.

    {
        return $this->_wrappedValidator->getTranslator();
    }

isValid()

isValid

(

$value

)

Delegate validation to wrapped validator

Parameters

mixed

$value

Returns

boolean @api

Implements Zend_Validate_Interface.

Definition at line 49 of file Constraint.php.

    {
        $result = true;
        $this->_clearMessages();

        if (!$this->_wrappedValidator->isValid($this->_getValidatorValue($value))) {
            $this->_addMessages($this->_wrappedValidator->getMessages());
            $result = false;
        }

        return $result;
    }

setTranslator()

setTranslator

(

$translator = null

)

Set translator to wrapped validator.

Parameters

\Magento\Framework\Translate\AdapterInterface | null

$translator

Returns

\Magento\Framework\Validator\AbstractValidator

Implements ValidatorInterface.

Definition at line 93 of file Constraint.php.

    {
        $this->_wrappedValidator->setTranslator($translator);
        return $this;
    }

Field Documentation

$_alias

$_alias

protected

Definition at line 28 of file Constraint.php.

$_wrappedValidator

$_wrappedValidator

protected

Definition at line 21 of file Constraint.php.

---

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

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