1. Home
  2. Documentation
  3. Reference
  4. Constraints
  5. Currency
WARNING: You are browsing the documentation for Symfony 2.3 which is not maintained anymore. Consider upgrading your projects to Symfony 5.0.

Currency

2.3 version
Maintained
3.4 4.3 4.4 5.0 current 5.1 master
Unmaintained
2.4 2.5 2.6 2.7 2.8 3.0 3.1 3.2 3.3 4.0 4.1 4.2

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
Class Currency
Validator 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
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    // src/AppBundle/Entity/Order.php
namespace AppBundle\Entity;

use Symfony\Component\Validator\Constraints as Assert;

class Order
{
    /**
     * @Assert\Currency
     */
    protected $currency;
}
  • YAML
    1
2
3
4
5
    # src/AppBundle/Resources/config/validation.yml
AppBundle\Entity\Order:
    properties:
        currency:
            - Currency: ~
  • XML
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
    <!-- 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
     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
    // 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.

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