Currency

Currency

2.3The 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:

  • YAML
    1
    2
    3
    4
    5
    # src/EcommerceBundle/Resources/config/validation.yml
    Acme\EcommerceBundle\Entity\Order:
        properties:
            currency:
                - Currency: ~
    
  • Annotations
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    // src/Acme/EcommerceBundle/Entity/Order.php
    namespace Acme\EcommerceBundle\Entity;
    
    use Symfony\Component\Validator\Constraints as Assert;
    
    class Order
    {
        /**
         * @Assert\Currency
         */
        protected $currency;
    }
    
  • XML
    1
    2
    3
    4
    5
    6
    <!-- src/Acme/EcommerceBundle/Resources/config/validation.xml -->
    <class name="Acme\EcommerceBundle\Entity\Order">
        <property name="currency">
            <constraint name="Currency" />
        </property>
    </class>
    
  • PHP
     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    11
    12
    13
    // 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.

This work is licensed under a Creative Commons Attribution-Share Alike 3.0 Unported License .