respect-validation/docs/validators/CurrencyCode.md
Alexandre Gomes Gaigalas bd48bdcda4 Lint Changelog format in validator docs
Introduces a Markdown linter for checking the Changelog format.

"See Also" was transformed into a section to make it easier to
handle it with the `Content` class. The "Related" linter was
simplified to reflect that change too.

An additional "alignment" parameter was added to markdown table
generators, allowing the padding and headers to be explicitly
marked with a specific left (-1), middle (0) or right(1)
alignment.

Existing files were fixed using the `fix` option after the
changes.
2026-01-26 19:11:00 +00:00

60 lines
1.8 KiB
Markdown

<!--
SPDX-FileCopyrightText: (c) Respect Project Contributors
SPDX-License-Identifier: MIT
-->
# 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 valid currency code |
| `inverted` | {{subject}} must not be a valid 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 | 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