drop older laravel/php versions, better types

Author: DougSisk

.github/workflows/phpunit.yml

@@ -12,37 +12,16 @@ jobs:
 
     strategy:
       matrix:
-        php: [
-          {
-            version: 7.4,
-            phpunitConfig: phpunit.xml
-          },
-          {
-            version: 8.0,
-            phpunitConfig: phpunit.xml
-          },
-          {
-            version: 8.1,
-            phpunitConfig: phpunit.xml
-          },
-          {
-            version: 8.2,
-            phpunitConfig: phpunit-new.xml
-          },
-          {
-            version: 8.3,
-            phpunitConfig: phpunit-new.xml
-          }
-        ]
+        php: [8.2, 8.3, 8.4]
 
-    name: PHP ${{ matrix.php.version }} tests
+    name: PHP ${{ matrix.php }} tests
     steps:
       -  uses: actions/checkout@v4
 
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: ${{ matrix.php.version }}
+          php-version: ${{ matrix.php }}
           coverage: none
 
       - name: Validate composer.json and composer.lock
@@ -52,4 +31,4 @@ jobs:
         run: composer install --prefer-dist --no-progress --no-suggest
 
       - name: Run test suite
-        run: vendor/bin/phpunit --configuration ${{ matrix.php.phpunitConfig }}
+        run: vendor/bin/phpunit

composer.json

@@ -13,20 +13,20 @@
     "authors": [
         {
             "name": "Doug Sisk",
-            "homepage": "http://dougsisk.com"
+            "homepage": "https://dougsisk.com"
         }
     ],
     "support": {
         "issues": "https://github.com/DougSisk/laravel-country-state/issues"
     },
     "require": {
-        "php": "^7.4|^8.0",
-        "illuminate/support": "^6.0|^7.0|^8.0|^9.0|^10.0|^11.0",
-        "rinvex/countries": "^7.3|^8.0"
+        "php": "^8.2",
+        "illuminate/support": "^11.0|^12.0",
+        "rinvex/countries": "^8.0"
     },
     "require-dev": {
-        "orchestra/testbench": "^4.0|^5.0|^6.0|^7.0|^8.0|^9.0",
-        "phpunit/phpunit": "^8.0|^9.0|^10.0|^11.0"
+        "orchestra/testbench": "^9.0|^10.0",
+        "phpunit/phpunit": "^10.0|^11.0|^12.0"
     },
     "autoload": {
         "psr-4": {

phpunit-new.xml

@@ -1,19 +1,11 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit backupGlobals="false"
-         backupStaticAttributes="false"
-         bootstrap="vendor/autoload.php"
-         colors="true"
-         convertErrorsToExceptions="true"
-         convertNoticesToExceptions="true"
-         convertWarningsToExceptions="true"
-         processIsolation="false"
-         stopOnFailure="false">
-    <testsuites>
-        <testsuite name="CountryState Test Suite">
-            <file>tests/CountryStateTest.php</file>
-        </testsuite>
-        <testsuite name="CountryState Laravel Test Suite">
-            <file>tests/laravel/CountryStateLaravelTest.php</file>
-        </testsuite>
-    </testsuites>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.1/phpunit.xsd" bootstrap="vendor/autoload.php" colors="true">
+  <testsuites>
+    <testsuite name="CountryState Test Suite">
+      <file>tests/CountryStateTest.php</file>
+    </testsuite>
+    <testsuite name="CountryState Laravel Test Suite">
+      <file>tests/laravel/CountryStateLaravelTest.php</file>
+    </testsuite>
+  </testsuites>
 </phpunit>

phpunit.xml

@@ -4,12 +4,14 @@ Laravel Country & State Helper
 [![Total Downloads](https://poser.pugx.org/dougsisk/laravel-country-state/downloads)](https://packagist.org/packages/dougsisk/laravel-country-state)
 [![License](https://poser.pugx.org/dougsisk/laravel-country-state/license)](https://packagist.org/packages/dougsisk/laravel-country-state)
 
-A helper to list countries & states in English in **Laravel 6.0+**.
+A helper to list countries & states in English in **Laravel 11.0+**.
 
-What's Changed in 4.0
+What's Changed in 5.0
 -----------------
 
-* **PHP 7.4+ or 8.0+ required**
+* **PHP 8.2+ required**
+
+_I'm aware the underlying country/state data package I utilize has not been actively maintained. I've looked into other packages, but have yet to find one that can easily be swapped in. Please feel free to submit a PR if you find one you think is a suitable replacement._
 
 Installation
 ------------

readme.md

@@ -8,20 +8,18 @@
 
 class CountryState
 {
-    protected $countries = [];
-    protected $countriesTranslated = [];
-    protected $language;
-    protected $states = [];
+    protected array $countries = [];
+
+    protected array $countriesTranslated = [];
+
+    protected string $language;
+
+    protected array $states = [];
 
     /**
      * Create a new country state helper instance.
-     *
-     * @param  array $limitCountries
-     * @param  array $preloadCountryStates
-     * @param  string $language
-     * @return void
      */
-    public function __construct($limitCountries = null, $preloadCountryStates = null, $language = 'eng')
+    public function __construct(?array $limitCountries = null, ?array $preloadCountryStates = null, string $language = 'eng')
     {
         if ($limitCountries) {
             foreach ($limitCountries as $code) {
@@ -50,11 +48,8 @@ public function __construct($limitCountries = null, $preloadCountryStates = null
      * Get a list of countries. If class has been constructed to limit countries, only those countries will be returned.
      * The array returned will be countries' names in the class' set language.
      * If a different language is desired, pass the three character ISO 639-3 code of the desired language
-     *
-     * @param string $language
-     * @return array
      */
-    public function getCountries($language = null)
+    public function getCountries(?string $language = null): array
     {
         if ($language) {
             $this->setLanguage($language);
@@ -65,47 +60,34 @@ public function getCountries($language = null)
 
     /**
      * Get the information of a country by passing its two character code
-     *
-     * @param string $lookFor
-     * @return Rinvex\Country\Country
      */
-    public function getCountry($lookFor)
+    public function getCountry(string $lookFor): Country
     {
         return $this->loadCountry($lookFor);
     }
 
     /**
      * Get the name of a country by passing its two character code
-     *
-     * @param string $lookFor
-     * @return string
      */
-    public function getCountryName($lookFor)
+    public function getCountryName(string $lookFor): string
     {
         return $this->getCountry($lookFor)->getName();
     }
 
     /**
      * Get a list of states for a given country.
      * The country's two character ISO code
-     *
-     * @param string $country
-     * @return array
      */
-    public function getStates($country)
+    public function getStates(string $country): array
     {
         return $this->findCountryStates($country);
     }
 
     /**
      * Get the name of a state by passing its two character code
      * Specifying a two character ISO country code will limit the search to a specific country
-     *
-     * @param string $lookFor
-     * @param string $country
-     * @return string
      */
-    public function getStateName($lookFor, $country = null)
+    public function getStateName(string $lookFor, ?string $country = null): string
     {
         if ($country) {
             if (! isset($this->states[$country])) {
@@ -130,16 +112,17 @@ public function getStateName($lookFor, $country = null)
 
     /**
      * Pass a country code to search a single country or an array of codes to search several countries in the order given
-     * If $country is null all countries will be searched, which can be slow.
-     *
-     * @param string $lookFor
-     * @param mixed $country
-     * @return string|void
+     * If $countries is null all countries will be searched, which can be slow.
      */
-    public function getStateCode($lookFor, $country = null)
+    public function getStateCode(string $lookFor, null|string|array $countries = null): ?string
     {
         $lookFor = mb_strtoupper($lookFor);
-        $countries = is_null($country) ? array_keys($this->countries) : (array) $country;
+
+        if (is_null($countries)) {
+            $countries = array_keys($this->countries);
+        } elseif (is_string($countries)) {
+            $countries = [$countries];
+        }
 
         foreach ($countries as $countryCode) {
             $states = array_map('mb_strtoupper', $this->findCountryStates($countryCode));
@@ -148,16 +131,15 @@ public function getStateCode($lookFor, $country = null)
                 return $code;
             }
         }
+
+        return null;
     }
 
     /**
      * Change the default translation language using the three character ISO 639-3 code of the desired language.
      * Country name translations will be reloaded.
-     *
-     * @param string $language
-     * @return $this
      */
-    public function setLanguage($language)
+    public function setLanguage(string $language): self
     {
         $this->language = $language;
 
@@ -168,7 +150,7 @@ public function setLanguage($language)
         return $this;
     }
 
-    protected function loadCountry($code)
+    protected function loadCountry($code): Country
     {
         try {
             return CountryLoader::country(mb_strtolower($code));
@@ -177,7 +159,7 @@ protected function loadCountry($code)
         }
     }
 
-    protected function findCountryStates($country)
+    protected function findCountryStates($country): array
     {
         if (! array_key_exists($country, $this->states)) {
             $this->addCountryStates($country);
@@ -186,7 +168,7 @@ protected function findCountryStates($country)
         return $this->states[$country];
     }
 
-    protected function addCountryStates($country)
+    protected function addCountryStates($country): void
     {
         if (! $country instanceof Country) {
             $country = $this->loadCountry($country);
@@ -197,9 +179,9 @@ protected function addCountryStates($country)
         $this->states[$countryCode] = [];
         $states = $country->getDivisions();
 
-        if( !is_null($states) ) {
+        if (! is_null($states)) {
             foreach ($states as $code => $division) {
-                $code = preg_replace("/([A-Z]{2}-)/", '', $code);
+                $code = preg_replace('/([A-Z]{2}-)/', '', $code);
                 $this->states[$countryCode][$code] = $division['name'];
             }
         }