respect-validation/docs/rules/CurrencyCode.md
2024-12-09 01:34:50 +01:00

55 lines
1.6 KiB
Markdown

# CurrencyCode
- `CurrencyCode()`
- `CurrencyCode("alpha-3"|"numeric" $set)`
Validates an [ISO 4217][] currency code.
**This rule requires [sokil/php-isocodes][] and [sokil/php-isocodes-db-only][] to be installed.**
```php
v::currencyCode()->isValid('GBP'); // true
```
This rule supports the two [ISO 4217][] sets:
- `alpha-3`
- `numeric`
## Templates
### `CurrencyCode::TEMPLATE_STANDARD`
| Mode | Template |
|------------|--------------------------------------------|
| `default` | {{name}} must be a valid currency code |
| `inverted` | {{name}} must not be a valid currency code |
## Template placeholders
| Placeholder | Description |
|-------------|------------------------------------------------------------------|
| `name` | The validated input or the custom validator name (if specified). |
## Categorization
- ISO codes
- Localization
## Changelog
| Version | Description |
|--------:|-------------------------------------------------------------------|
| 3.0.0 | Require [sokil/php-isocodes][] and [sokil/php-isocodes-db-only][] |
| 2.0.0 | Became case-sensitive |
| 1.0.0 | Created |
***
See also:
- [CountryCode](CountryCode.md)
- [SubdivisionCode](SubdivisionCode.md)
[ISO 4217]: http://en.wikipedia.org/wiki/ISO_4217
[sokil/php-isocodes]: https://github.com/sokil/php-isocodes
[sokil/php-isocodes-db-only]: https://github.com/sokil/php-isocodes-db-only