Skip to content

Add Iso3166 rule #104

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
olivervogel merged 2 commits into from
Jul 7, 2026
Merged

Add Iso3166 rule #104

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a80029
Add Iso3166 rule
olivervogel Jul 7, 2026
516ab98
Add exception annotation
olivervogel Jul 7, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,6 +339,18 @@ The field under validation must be a valid Vehicle identification number accordi

Optional verification according to the North American check system. Default `false`.

### ISO 3166-1 Country Code

The field under validation must be a valid country code according to ISO 3166-1

public Intervention\Validation\Rules\Iso3166::__construct(string $format = Iso3166::ALPHA2)

#### Parameters

**format**

The country code has three different format `ALPHA2`, `ALPHA3` or `NUMERIC`. Select the format you want to check. Default `Iso3166::ALPHA2`.

## Development & Testing

With this package comes a Docker image to build a test suite container. To
Expand Down
92 changes: 92 additions & 0 deletions src/Rules/Iso3166.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
<?php

declare(strict_types=1);

namespace Intervention\Validation\Rules;

use Intervention\Validation\AbstractRule;
use InvalidArgumentException;

class Iso3166 extends AbstractRule
{
public const ALPHA2 = 'alpha2';
public const ALPHA3 = 'alpha3';
public const NUMERIC = 'numeric';

private const VALUES = [
self::ALPHA2 => [
'AD', 'AE', 'AF', 'AG', 'AI', 'AL', 'AM', 'AO', 'AQ', 'AR', 'AS', 'AT', 'AU', 'AW', 'AX', 'AZ', 'BA', 'BB',
'BD', 'BE', 'BF', 'BG', 'BH', 'BI', 'BJ', 'BL', 'BM', 'BN', 'BO', 'BQ', 'BR', 'BS', 'BT', 'BV', 'BW', 'BY',
'BZ', 'CA', 'CC', 'CD', 'CF', 'CG', 'CH', 'CI', 'CK', 'CL', 'CM', 'CN', 'CO', 'CR', 'CU', 'CV', 'CW', 'CX',
'CY', 'CZ', 'DE', 'DJ', 'DK', 'DM', 'DO', 'DZ', 'EC', 'EE', 'EG', 'EH', 'ER', 'ES', 'ET', 'FI', 'FJ', 'FK',
'FM', 'FO', 'FR', 'GA', 'GB', 'GD', 'GE', 'GF', 'GG', 'GH', 'GI', 'GL', 'GM', 'GN', 'GP', 'GQ', 'GR', 'GS',
'GT', 'GU', 'GW', 'GY', 'HK', 'HM', 'HN', 'HR', 'HT', 'HU', 'ID', 'IE', 'IL', 'IM', 'IN', 'IO', 'IQ', 'IR',
'IS', 'IT', 'JE', 'JM', 'JO', 'JP', 'KE', 'KG', 'KH', 'KI', 'KM', 'KN', 'KP', 'KR', 'KW', 'KY', 'KZ', 'LA',
'LB', 'LC', 'LI', 'LK', 'LR', 'LS', 'LT', 'LU', 'LV', 'LY', 'MA', 'MC', 'MD', 'ME', 'MF', 'MG', 'MH', 'MK',
'ML', 'MM', 'MN', 'MO', 'MP', 'MQ', 'MR', 'MS', 'MT', 'MU', 'MV', 'MW', 'MX', 'MY', 'MZ', 'NA', 'NC', 'NE',
'NF', 'NG', 'NI', 'NL', 'NO', 'NP', 'NR', 'NU', 'NZ', 'OM', 'PA', 'PE', 'PF', 'PG', 'PH', 'PK', 'PL', 'PM',
'PN', 'PR', 'PS', 'PT', 'PW', 'PY', 'QA', 'RE', 'RO', 'RS', 'RU', 'RW', 'SA', 'SB', 'SC', 'SD', 'SE', 'SG',
'SH', 'SI', 'SJ', 'SK', 'SL', 'SM', 'SN', 'SO', 'SR', 'SS', 'ST', 'SV', 'SX', 'SY', 'SZ', 'TC', 'TD', 'TF',
'TG', 'TH', 'TJ', 'TK', 'TL', 'TM', 'TN', 'TO', 'TR', 'TT', 'TV', 'TW', 'TZ', 'UA', 'UG', 'UM', 'US', 'UY',
'UZ', 'VA', 'VC', 'VE', 'VG', 'VI', 'VN', 'VU', 'WF', 'WS', 'YE', 'YT', 'ZA', 'ZM', 'ZW',
],
self::ALPHA3 => [
'AFG', 'ALB', 'DZA', 'ASM', 'AND', 'AGO', 'AIA', 'ATA', 'ATG', 'ARG', 'ARM', 'ABW', 'AUS', 'AUT', 'AZE',
'BHS', 'BHR', 'BGD', 'BRB', 'BLR', 'BEL', 'BLZ', 'BEN', 'BMU', 'BTN', 'BOL', 'BES', 'BIH', 'BWA', 'BVT',
'BRA', 'IOT', 'BRN', 'BGR', 'BFA', 'BDI', 'CPV', 'KHM', 'CMR', 'CAN', 'CYM', 'CAF', 'TCD', 'CHL', 'CHN',
'CXR', 'CCK', 'COL', 'COM', 'COD', 'COG', 'COK', 'CRI', 'HRV', 'CUB', 'CUW', 'CYP', 'CZE', 'CIV', 'DNK',
'DJI', 'DMA', 'DOM', 'ECU', 'EGY', 'SLV', 'GNQ', 'ERI', 'EST', 'SWZ', 'ETH', 'FLK', 'FRO', 'FJI', 'FIN',
'FRA', 'GUF', 'PYF', 'ATF', 'GAB', 'GMB', 'GEO', 'DEU', 'GHA', 'GIB', 'GRC', 'GRL', 'GRD', 'GLP', 'GUM',
'GTM', 'GGY', 'GIN', 'GNB', 'GUY', 'HTI', 'HMD', 'VAT', 'HND', 'HKG', 'HUN', 'ISL', 'IND', 'IDN', 'IRN',
'IRQ', 'IRL', 'IMN', 'ISR', 'ITA', 'JAM', 'JPN', 'JEY', 'JOR', 'KAZ', 'KEN', 'KIR', 'PRK', 'KOR', 'KWT',
'KGZ', 'LAO', 'LVA', 'LBN', 'LSO', 'LBR', 'LBY', 'LIE', 'LTU', 'LUX', 'MAC', 'MDG', 'MWI', 'MYS', 'MDV',
'MLI', 'MLT', 'MHL', 'MTQ', 'MRT', 'MUS', 'MYT', 'MEX', 'FSM', 'MDA', 'MCO', 'MNG', 'MNE', 'MSR', 'MAR',
'MOZ', 'MMR', 'NAM', 'NRU', 'NPL', 'NLD', 'NCL', 'NZL', 'NIC', 'NER', 'NGA', 'NIU', 'NFK', 'MKD', 'MNP',
'NOR', 'OMN', 'PAK', 'PLW', 'PSE', 'PAN', 'PNG', 'PRY', 'PER', 'PHL', 'PCN', 'POL', 'PRT', 'PRI', 'QAT',
'ROU', 'RUS', 'RWA', 'REU', 'BLM', 'SHN', 'KNA', 'LCA', 'MAF', 'SPM', 'VCT', 'WSM', 'SMR', 'STP', 'SAU',
'SEN', 'SRB', 'SYC', 'SLE', 'SGP', 'SXM', 'SVK', 'SVN', 'SLB', 'SOM', 'ZAF', 'SGS', 'SSD', 'ESP', 'LKA',
'SDN', 'SUR', 'SJM', 'SWE', 'CHE', 'SYR', 'TWN', 'TJK', 'TZA', 'THA', 'TLS', 'TGO', 'TKL', 'TON', 'TTO',
'TUN', 'TKM', 'TCA', 'TUV', 'TUR', 'UGA', 'UKR', 'ARE', 'GBR', 'UMI', 'USA', 'URY', 'UZB', 'VUT', 'VEN',
'VNM', 'VGB', 'VIR', 'WLF', 'ESH', 'YEM', 'ZMB', 'ZWE', 'ALA',
],
self::NUMERIC => [
'004', '008', '010', '012', '016', '020', '024', '028', '031', '032', '036', '040', '044', '048', '050',
'051', '052', '056', '060', '072', '074', '076', '084', '086', '090', '092', '096', '100', '104', '108',
'112', '116', '120', '124', '132', '136', '140', '144', '148', '152', '156', '158', '162', '166', '170',
'174', '175', '178', '180', '184', '188', '191', '192', '196', '203', '204', '208', '212', '214', '218',
'222', '226', '231', '232', '233', '234', '238', '239', '242', '246', '248', '250', '254', '258', '260',
'262', '266', '268', '270', '275', '276', '288', '292', '296', '300', '304', '308', '312', '316', '320',
'324', '328', '332', '334', '336', '340', '344', '348', '352', '356', '360', '364', '368', '372', '376',
'380', '384', '388', '392', '398', '400', '404', '408', '410', '414', '417', '418', '422', '426', '428',
'430', '434', '438', '440', '442', '446', '450', '454', '458', '462', '466', '470', '474', '478', '480',
'484', '492', '496', '498', '499', '500', '504', '508', '512', '516', '520', '524', '528', '531', '533',
'534', '535', '540', '548', '554', '558', '562', '566', '570', '574', '578', '580', '581', '583', '584',
'585', '586', '591', '598', '600', '604', '608', '612', '616', '620', '624', '626', '630', '634', '638',
'642', '643', '646', '652', '654', '659', '660', '662', '663', '666', '670', '674', '678', '682', '686',
'688', '690', '694', '702', '703', '704', '705', '706', '710', '716', '724', '728', '729', '732', '740',
'744', '748', '752', '756', '760', '762', '764', '768', '772', '776', '780', '784', '788', '792', '795',
'796', '798', '800', '804', '807', '818', '826', '831', '832', '833', '834', '840', '850', '854', '858',
'860', '862', '876', '882', '887', '894', '064', '068', '070',
],
];

/**
* @throws InvalidArgumentException
*/
public function __construct(protected string $format = self::ALPHA2)
{
if (!in_array($this->format, [self::ALPHA2, self::ALPHA3, self::NUMERIC])) {
throw new InvalidArgumentException('Invalid format.');
}
}

/**
* {@inheritdoc}
*
* @see Rule::isValid()
*/
public function isValid(mixed $value): bool
{
return in_array(strval($value), self::VALUES[$this->format], strict: true);
}
}
88 changes: 88 additions & 0 deletions tests/Rules/Iso3166Test.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
<?php

declare(strict_types=1);

namespace Intervention\Validation\Tests\Rules;

use Generator;
use Intervention\Validation\Rules\Iso3166;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\TestCase;

final class Iso3166Test extends TestCase
{
#[DataProvider('dataProvider')]
public function testValidationAlpha2(bool $result, string $value, string $format): void
{
$valid = (new Iso3166($format))->isValid($value);
$this->assertEquals($result, $valid);
}

public static function dataProvider(): Generator
{
yield [true, 'BS', Iso3166::ALPHA2];
yield [true, 'BW', Iso3166::ALPHA2];
yield [true, 'DE', Iso3166::ALPHA2];
yield [true, 'GR', Iso3166::ALPHA2];
yield [true, 'IT', Iso3166::ALPHA2];
yield [true, 'JP', Iso3166::ALPHA2];
yield [true, 'LU', Iso3166::ALPHA2];
yield [true, 'PL', Iso3166::ALPHA2];
yield [true, 'PL', Iso3166::ALPHA2];

yield [true, 'DEU', Iso3166::ALPHA3];
yield [true, 'CAN', Iso3166::ALPHA3];
yield [true, 'AUS', Iso3166::ALPHA3];
yield [true, 'PAK', Iso3166::ALPHA3];
yield [true, 'ERI', Iso3166::ALPHA3];
yield [true, 'ATA', Iso3166::ALPHA3];
yield [true, 'AUT', Iso3166::ALPHA3];
yield [true, 'KOR', Iso3166::ALPHA3];
yield [true, 'CHL', Iso3166::ALPHA3];

yield [true, '180', Iso3166::NUMERIC];
yield [true, '004', Iso3166::NUMERIC];
yield [true, '440', Iso3166::NUMERIC];
yield [true, '706', Iso3166::NUMERIC];
yield [true, '120', Iso3166::NUMERIC];
yield [true, '312', Iso3166::NUMERIC];
yield [true, '850', Iso3166::NUMERIC];
yield [true, '732', Iso3166::NUMERIC];
yield [true, '203', Iso3166::NUMERIC];

yield [false, 'XE', Iso3166::ALPHA2];
yield [false, 'BAC', Iso3166::ALPHA2];
yield [false, 'DZA', Iso3166::ALPHA2];
yield [false, 'RG', Iso3166::ALPHA2];
yield [false, 'QX', Iso3166::ALPHA2];
yield [false, 'XX', Iso3166::ALPHA2];
yield [false, 'LP', Iso3166::ALPHA2];
yield [false, 'PU', Iso3166::ALPHA2];
yield [false, 'PZ', Iso3166::ALPHA2];
yield [false, 'de', Iso3166::ALPHA2];
yield [false, '', Iso3166::ALPHA2];

yield [false, 'DEX', Iso3166::ALPHA3];
yield [false, 'CAX', Iso3166::ALPHA3];
yield [false, 'USI', Iso3166::ALPHA3];
yield [false, 'PAC', Iso3166::ALPHA3];
yield [false, 'E3I', Iso3166::ALPHA3];
yield [false, 'ATW', Iso3166::ALPHA3];
yield [false, 'PAA', Iso3166::ALPHA3];
yield [false, 'WWW', Iso3166::ALPHA3];
yield [false, 'DE', Iso3166::ALPHA3];
yield [false, '', Iso3166::ALPHA3];

yield [false, '001', Iso3166::NUMERIC];
yield [false, '002', Iso3166::NUMERIC];
yield [false, '20', Iso3166::NUMERIC];
yield [false, '2', Iso3166::NUMERIC];
yield [false, '0', Iso3166::NUMERIC];
yield [false, '12001', Iso3166::NUMERIC];
yield [false, '994', Iso3166::NUMERIC];
yield [false, '730', Iso3166::NUMERIC];
yield [false, '870', Iso3166::NUMERIC];
yield [false, '18O', Iso3166::NUMERIC];
yield [false, '', Iso3166::NUMERIC];
}
}