MacAddress

7.1

The MacAddress constraint was introduced in Symfony 7.1.

This constraint ensures that the given value is a valid MAC address (internally it uses the FILTER_VALIDATE_MAC option of the filter_var PHP function).

Applies to	property or method
Class	MacAddress
Validator	MacAddressValidator

Basic Usage

To use the MacAddress validator, apply it to a property on an object that can contain a MAC address:

        1
2
3
4
5
6
7
8
9
10
        // src/Entity/Device.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Device
{
    #[Assert\MacAddress]
    protected string $mac;
}
    

        1
2
3
4
5
        # config/validator/validation.yaml
App\Entity\Device:
    properties:
        mac:
            - MacAddress: ~
    

        1
2
3
4
5
6
7
8
9
10
11
12
        <!-- config/validator/validation.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<constraint-mapping xmlns="http://symfony.com/schema/dic/constraint-mapping"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/constraint-mapping https://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

    <class name="App\Entity\Device">
        <property name="max">
            <constraint name="MacAddress"/>
        </property>
    </class>
</constraint-mapping>
    

        1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
        // src/Entity/Device.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Component\Validator\Mapping\ClassMetadata;

class Device
{
    // ...

    public static function loadValidatorMetadata(ClassMetadata $metadata): void
    {
        $metadata->addPropertyConstraint('mac', new Assert\MacAddress());
    }
}
    

Note

As with most of the other constraints, null and empty strings are considered valid values. This is to allow them to be optional values. If the value is mandatory, a common solution is to combine this constraint with NotBlank.

Options

`groups`

type: array | string default: null

It defines the validation group or groups of this constraint. Read more about validation groups.

`message`

type: string default: This value is not a valid MAC address.

This is the message that will be shown if the value is not a valid MAC address.

You can use the following parameters in this message:

Parameter	Description
`{{ value }}`	The current (invalid) value

`normalizer`

type: a PHP callable default: null

This option allows to define the PHP callable applied to the given value before checking if it is valid.

For example, you may want to pass the 'trim' string to apply the trim PHP function in order to ignore leading and trailing whitespace during validation.

`payload`

type: mixed default: null

This option can be used to attach arbitrary domain-specific data to a constraint. The configured payload is not used by the Validator component, but its processing is completely up to you.

For example, you may want to use several error levels to present failed constraints differently in the front-end depending on the severity of the error.

`type`

type: string default: all

7.1

The type option was introduced in Symfony 7.1.

This option defines the kind of MAC addresses that are allowed. There are a lot of different possible values based on your needs:

Parameter	Allowed MAC addresses
`all`	All
`all_no_broadcast`	All except broadcast
`broadcast`	Only broadcast
`local_all`	Only local
`local_multicast_no_broadcast`	Only local and multicast except broadcast
`local_multicast`	Only local and multicast
`local_no_broadcast`	Only local except broadcast
`local_unicast`	Only local and unicast
`multicast_all`	Only multicast
`multicast_no_broadcast`	Only multicast except broadcast
`unicast_all`	Only unicast
`universal_all`	Only universal
`universal_unicast`	Only universal and unicast
`universal_multicast`	Only universal and multicast

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.

TOC

Version