Currency.rst

Currency

.. versionadded:: 2.3
    This constraint is new in version 2.3.

Validates that a value is a valid 3-letter ISO 4217 currency name.

Applies to	:ref:`property or method<validation-property-target>`
Options	message
Class	:class:`Symfony\\Component\\Validator\\Constraints\\Currency`
Validator	:class:`Symfony\\Component\\Validator\\Constraints\\CurrencyValidator`

Basic Usage

If you want to ensure that the currency property of an Order is a valid currency, you could do the following:

.. configuration-block::

    .. code-block:: yaml

        # src/EcommerceBundle/Resources/config/validation.yml
        Acme\EcommerceBundle\Entity\Order:
            properties:
                currency:
                    - Currency: ~

    .. code-block:: php-annotations

        // src/Acme/EcommerceBundle/Entity/Order.php
        namespace Acme\EcommerceBundle\Entity;

        use Symfony\Component\Validator\Constraints as Assert;

        class Order
        {
            /**
             * @Assert\Currency
             */
            protected $currency;
        }

    .. code-block:: xml

        <!-- src/Acme/EcommerceBundle/Resources/config/validation.xml -->
        <class name="Acme\EcommerceBundle\Entity\Order">
            <property name="currency">
                <constraint name="Currency" />
            </property>
        </class>

    .. code-block:: php

        // src/Acme/EcommerceBundle/Entity/Order.php
        namespace Acme\SocialBundle\Entity;

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

        class Order
        {
            public static function loadValidatorMetadata(ClassMetadata $metadata)
            {
                $metadata->addPropertyConstraint('currency', new Assert\Currency());
            }
        }

Options

message

type: string default: This value is not a valid currency.

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