add state abbreviation for Australian addresses

FakerPHP · Dec 14, 2024 · 6d80a47 · 6d80a47
1 parent a1f1c0e
commit 6d80a47
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/src/Faker/Provider/en_AU/Address.php b/src/Faker/Provider/en_AU/Address.php
@@ -109,4 +109,16 @@ public static function state()
     {
         return static::randomElement(static::$state);
     }
+
+    /**
+     * Returns a sane state abbreviation
+     *
+     * @example NSW
+     *
+     * @return string
+     */
+    public static function stateAbbr()
+    {
+        return static::randomElement(static::$stateAbbr);
+    }
 }
diff --git a/test/Faker/Provider/en_AU/AddressTest.php b/test/Faker/Provider/en_AU/AddressTest.php
@@ -33,6 +33,14 @@ public function testState(): void
         self::assertMatchesRegularExpression('/[A-Z][a-z]+/', $state);
     }
 
+    public function testStateAbbr(): void
+     {
+        $stateAbbr = $this->faker->stateAbbr();
+        self::assertNotEmpty($stateAbbr);
+        self::assertIsString($stateAbbr);
+        self::assertMatchesRegularExpression('/^[A-Z]{2,3}$/', $stateAbbr);
+     }
+
     protected function getProviders(): iterable
     {
         yield new Address($this->faker);