Warning: You are browsing the documentation for Symfony 2.7, which is no longer maintained.

Read the updated version of this page for Symfony 5.3 (the current stable version).

Currency

2.7 version

Maintained

4.4 5.3 current 5.4 dev 6.0

Unmaintained

2.3 2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 3.4 4.0 4.1 4.2 4.3 5.0 5.1 5.2

Currency
- Basic Usage
- Options
  - message
  - payload

Currency¶

New in version 2.3: The Currency constraint was introduced in Symfony 2.3.

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

Applies to	property or method
Options	message payload
Class	`Symfony\Component\Validator\Constraints\Currency`
Validator	`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:

Annotations

// src/AppBundle/Entity/Order.php
namespace AppBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

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

YAML

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

XML

<!-- src/AppBundle/Resources/config/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 http://symfony.com/schema/dic/constraint-mapping/constraint-mapping-1.0.xsd">

    <class name="AppBundle\Entity\Order">
        <property name="currency">
            <constraint name="Currency" />
        </property>
    </class>
</constraint-mapping>

PHP

// src/AppBundle/Entity/Order.php
namespace AppBundle\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.

payload¶

type: mixed default: null

New in version 2.6: The payload option was introduced in Symfony 2.6.

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.

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