Code style improvements and docblocks

This commit is contained in:
2025-01-25 18:35:26 +01:00
parent 703562b674
commit b16a69a2c1
5 changed files with 11 additions and 7 deletions
+2 -2
View File
@@ -19,14 +19,14 @@ class ProjectTerritory
/**
* ISO 3166-2 first level subdivision code.\
* e.g: ES-AN (Andalucía, Spain)
* e.g: ES-AN (Andalucía, Spain).
*/
#[CountrySubdivision()]
public string $subLvl1;
/**
* ISO 3166-2 second level subdivision code.\
* e.g: ES-GR (Granada, Andalucía, Spain)
* e.g: ES-GR (Granada, Andalucía, Spain).
*/
#[CountrySubdivision()]
public string $subLvl2;
+2 -3
View File
@@ -29,9 +29,8 @@ class ProjectTerritory
public function __construct(
string $country,
?string $subLvl1 = null,
?string $subLvl2 = null
)
{
?string $subLvl2 = null,
) {
$this->country = $country;
$this->subLvl1 = $subLvl1 ?? null;
$this->subLvl2 = $subLvl2 ?? null;
+1 -1
View File
@@ -14,7 +14,7 @@ final class CountrySubdivision extends Constraint
public function __construct(
public string $mode = 'strict',
?array $groups = null,
mixed $payload = null
mixed $payload = null,
) {
parent::__construct([], $groups, $payload);
}
@@ -28,6 +28,11 @@ final class CountrySubdivisionValidator extends ConstraintValidator
;
}
/**
* Check if a a string is an actual ISO 3166-2 value.
*
* @return `true` if the string is a recognized territory
*/
public static function validateISO3166_2(string $iso3166_2): bool
{
$pieces = \explode('-', $iso3166_2);
@@ -10,7 +10,7 @@ class CountrySubdivionValidatorTest extends TestCase
/**
* @dataProvider isoValid
*/
public function testValidatesISO3166_2(string $iso3166_2): void
public function testValidatesISO31662(string $iso3166_2): void
{
$this->assertTrue(CountrySubdivisionValidator::validateISO3166_2($iso3166_2));
}