Skip to content

Update setup.rst for V6.0 #16076

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 9 commits into from
Nov 7, 2021
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
151 changes: 151 additions & 0 deletions reference/constraints/Cidr.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
Cidr
====

Validates that a value is a valid `CIDR`_ (Classless Inter-Domain Routing) notation.
By default, this will validate the CIDR's IP and netmask both for version 4 and 6,
with the option of allowing only one type of IP version to be valid. It also supports
a minimum and maximum range constraint in which the value of the netmask is valid.

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

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

.. configuration-block::

.. code-block:: php-annotations

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

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
/**
* @Assert\Cidr
*/
protected $cidrNotation;
}

.. code-block:: php-attributes

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

use Symfony\Component\Validator\Constraints as Assert;

class Author
{
#[Assert\Cidr]
protected $cidrNotation;
}

.. code-block:: yaml

# config/validator/validation.yaml
App\Entity\Author:
properties:
cidrNotation:
- Cidr: ~

.. 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="cidrNotation">
<constraint name="Cidr"/>
</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)
{
$metadata->addPropertyConstraint('cidrNotation', new Assert\Cidr());
}
}

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

Options
-------

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

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

**type**: ``string`` **default**: ``This value is not a valid CIDR notation.``

This message is shown if the string is not a valid CIDR notation.

``netmaskMin``
~~~~~~~~~~~

**type**: ``integer`` **default**: ``0``

It's a constraint for the lowest value a valid netmask may have.

``netmaskMax``
~~~~~~~~~~~

**type**: ``string`` **default**: ``32 for IPv4 or 128 for IPv6``

It's a constraint for the biggest value a valid netmask may have.

``netmaskRangeViolationMessage``
~~~~~~~~~~~

**type**: ``string`` **default**: ``The value of the netmask should be between {{ min }} and {{ max }}.``

This message is shown if the value of the CIDR's netmask is bigger then the value of the `max_` or lower than
the value of the `min_`.

You can use the following parameters in this message:

=============== ==============================================================
Parameter Description
=============== ==============================================================
``{{ min }}`` The minimum value a CIDR netmask may have
``{{ max }}`` The maximum value a CIDR netmask may have
=============== ==============================================================

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

``version``
~~~~~~~~~~~

**type**: ``string`` **default**: ``all``

This determines exactly *how* the CIDR notation is validated and can take one
of a variety of different values:

**All ranges**

``4``
Validates for CIDR notations that have an IPv4.
``6``
Validates for CIDR notations that have an IPv6.
``all``
Validates all CIDR formats

.. _`CIDR`: https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing
1 change: 1 addition & 0 deletions reference/constraints/map.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ String Constraints
* :doc:`Regex </reference/constraints/Regex>`
* :doc:`Hostname </reference/constraints/Hostname>`
* :doc:`Ip </reference/constraints/Ip>`
* :doc:`Cidr </reference/constraints/Cidr>`
* :doc:`Json </reference/constraints/Json>`
* :doc:`Uuid </reference/constraints/Uuid>`
* :doc:`Ulid </reference/constraints/Ulid>`
Expand Down
4 changes: 2 additions & 2 deletions setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,10 +54,10 @@ application:
.. code-block:: terminal

# run this if you are building a traditional web application
$ symfony new my_project_name --version=next --full
$ symfony new my_project_name --version="6.0.x@dev" --full

# run this if you are building a microservice, console application or API
$ symfony new my_project_name --version=next
$ symfony new my_project_name --version="6.0.x@dev"

The only difference between these two commands is the number of packages
installed by default. The ``--full`` option installs all the packages that you
Expand Down