Class

Symfony\Component\Validator\Constraints\Ip

class Ip extends Constraint

Validates that a value is a valid IP address

Constants

DEFAULT_GROUP

The name of the group given to all constraints with no explicit group

CLASS_CONSTRAINT

Marks a constraint that can be put onto classes

PROPERTY_CONSTRAINT

Marks a constraint that can be put onto properties

V4

V6

ALL

V4_NO_PRIV

V6_NO_PRIV

ALL_NO_PRIV

V4_NO_RES

V6_NO_RES

ALL_NO_RES

V4_ONLY_PUBLIC

V6_ONLY_PUBLIC

ALL_ONLY_PUBLIC

Properties

array $groups
$version
$message

Methods

__construct(mixed $options = null)

Initializes the constraint with options.

__set($option, $value)

Unsupported operation.

from Constraint
addImplicitGroupName(string $group)

Adds the given group if this constraint is in the Default group

from Constraint
string getDefaultOption()

Returns the name of the default option

from Constraint
array getRequiredOptions()

Returns the name of the required options

from Constraint
string validatedBy()

Returns the name of the class that validates this constraint

from Constraint
string|array getTargets()

Returns whether the constraint can be put onto classes, properties or both

from Constraint

Details

at line 73
public __construct(mixed $options = null)

Initializes the constraint with options.

You should pass an associative array. The keys should be the names of existing properties in this class. The values should be the value for these properties.

Alternatively you can override the method getDefaultOption() to return the name of an existing property. If no associative array is passed, this property is set instead.

You can force that certain options are set by overriding getRequiredOptions() to return the names of these options. If any option is not set here, an exception is thrown.

Parameters

mixed $options The options (as associative array) or the value for the default option (any other type)

Exceptions

InvalidOptionsException When you pass the names of non-existing options
MissingOptionsException When you don't pass any of the options returned by getRequiredOptions()
ConstraintDefinitionException When you don't pass an associative array, but getDefaultOption() returns null

in Constraint at line 141
public __set($option, $value)

Unsupported operation.

Parameters

$option
$value

in Constraint at line 153
public addImplicitGroupName(string $group)

Adds the given group if this constraint is in the Default group

Parameters

string $group

in Constraint at line 170
public string getDefaultOption()

Returns the name of the default option

Override this method to define a default option.

Return Value

string

See also

__construct()

in Constraint at line 185
public array getRequiredOptions()

Returns the name of the required options

Override this method if you want to define required options.

Return Value

array

See also

__construct()

in Constraint at line 201
public string validatedBy()

Returns the name of the class that validates this constraint

By default, this is the fully qualified name of the constraint class suffixed with "Validator". You can override this method to change that behaviour.

Return Value

string

in Constraint at line 217
public string|array getTargets()

Returns whether the constraint can be put onto classes, properties or both

This method should return one or more of the constants Constraint::CLASSCONSTRAINT and Constraint::PROPERTYCONSTRAINT.

Return Value

string|array One or more constant values