respect-validation/docs/validators/CurrencyCode.md
Alexandre Gomes Gaigalas 16148e9593 Standardize and improve validation message templates
- Remove redundant "valid" prefix:
   Date, DateTime, DateTimeDiff, Domain, Email, Iban, Imei, Ip, Isbn, Json, LanguageCode, LeapDate, LeapYear, Luhn, MacAddress, NfeAccessKey, Nif, Nip, Pesel, Phone, Pis, PolishIdCard, PostalCode, Roman, Slug, Tld, Url, Uuid, Version.

 - Remove redundant "value" suffix
   ArrayVal, BoolVal, Countable, FloatVal, IntVal, IterableVal, NumericVal, ScalarVal, StringVal.

 - Standardize "consist only of" phrasing
   Alnum, Alpha, Cntrl, Consonant, Digit, Graph, Lowercase, Printable, Punct, Space, Spaced, Uppercase, Vowel, Xdigit.

 - Improve file accessibility messages
   Directory, Executable, File, Image, Readable, SymbolicLink, Writable.

 - Improve grammar and article usage
   CreditCard, Extension, Mimetype, Regex, Size.
2026-02-03 19:58:55 +00:00

64 lines
2 KiB
Markdown

<!--
SPDX-License-Identifier: MIT
SPDX-FileCopyrightText: (c) Respect Project Contributors
SPDX-FileContributor: Alexandre Gomes Gaigalas <alganet@gmail.com>
SPDX-FileContributor: Henrique Moody <henriquemoody@gmail.com>
SPDX-FileContributor: Justin Hook <justinhook88@yahoo.co.uk>
-->
# CurrencyCode
- `CurrencyCode()`
- `CurrencyCode("alpha-3"|"numeric" $set)`
Validates an [ISO 4217][] currency code.
**This validator requires [sokil/php-isocodes][] and [sokil/php-isocodes-db-only][] to be installed.**
```php
v::currencyCode()->assert('GBP');
// Validation passes successfully
```
This validator supports the two [ISO 4217][] sets:
- `alpha-3`
- `numeric`
## Templates
### `CurrencyCode::TEMPLATE_STANDARD`
| Mode | Template |
| ---------: | :-------------------------------------- |
| `default` | {{subject}} must be a currency code |
| `inverted` | {{subject}} must not be a currency code |
## Template placeholders
| Placeholder | Description |
| ----------- | ---------------------------------------------------------------- |
| `subject` | The validated input or the custom validator name (if specified). |
## Categorization
- ISO codes
- Localization
## Changelog
| Version | Description |
| ------: | :---------------------------------------------------------------- |
| 3.0.0 | Templates changed |
| 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