Skip to content

[Validator] Add MacAddress constraint #19383

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jan 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 104 additions & 0 deletions reference/constraints/MacAddress.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
MacAddress
==========

.. versionadded:: 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 :phpfunction:`filter_var` PHP
function).

========== =====================================================================
Applies to :ref:`property or method <validation-property-target>`
Class :class:`Symfony\\Component\\Validator\\Constraints\\MacAddress`
Validator :class:`Symfony\\Component\\Validator\\Constraints\\MacAddressValidator`
========== =====================================================================

Basic Usage
-----------

To use the MacAddress validator, apply it to a property on an object that
will contain a host name.

.. configuration-block::

.. code-block:: php-attributes

// src/Entity/Author.php
namespace App\Entity;

use Symfony\Component\Validator\Constraints as Assert;

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

.. code-block:: yaml

# config/validator/validation.yaml
App\Entity\Author:
properties:
mac:
- MacAddress: ~

.. code-block:: xml

<!-- 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\Author">
<property name="max">
<constraint name="MacAddress"/>
</property>
</class>
</constraint-mapping>

.. code-block:: php

// src/Entity/Author.php
namespace App\Entity;

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

class Author
{
// ...

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

.. include:: /reference/constraints/_empty-values-are-valid.rst.inc

Options
-------

.. include:: /reference/constraints/_groups-option.rst.inc

``message``
~~~~~~~~~~~

**type**: ``string`` **default**: ``This 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
=============== ==============================================================

.. include:: /reference/constraints/_normalizer-option.rst.inc

.. include:: /reference/constraints/_payload-option.rst.inc
1 change: 1 addition & 0 deletions reference/constraints/map.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ String Constraints
* :doc:`CssColor </reference/constraints/CssColor>`
* :doc:`NoSuspiciousCharacters </reference/constraints/NoSuspiciousCharacters>`
* :doc:`Charset </reference/constraints/Charset>`
* :doc:`MacAddress </reference/constraints/MacAddress>`

Comparison Constraints
~~~~~~~~~~~~~~~~~~~~~~
Expand Down