Merge pull request #108 from vahidkaargar/1.x

[1.x] Validation for landline numbers

Author: milwad-dev

README.md

@@ -137,6 +137,7 @@ return [
 | 38 | [ValidUsername](https://github.com/milwad-dev/laravel-validate/blob/1.x/docs/1.x/valid-username.md)                              | Validate username for ex (milwad)                                                                                                                                                                 |
 | 39 | [ValidUuid](https://github.com/milwad-dev/laravel-validate/blob/1.x/docs/1.x/valid-uuid.md)                                      | Validate uuid for ex (123e4567-e89b-12d3-a456-426655440000)                                                                                                                                       |
 | 40 | [ValidVatId](https://github.com/milwad-dev/laravel-validate/blob/1.x/docs/1.x/valid-vatid.md)                                    | Validate european VAT ID ex (EL123456789123)                                                                                                                                                      |
+| 41 | [ValidLandlineNumber](https://github.com/milwad-dev/laravel-validate/blob/1.x/docs/1.x/valid-landline-number.md)                 | Validate landline number                                                                                                                                                                          |
 
 <a name="support-languages"></a>
 

config/laravel-validate.php

@@ -19,6 +19,25 @@
 use Milwad\LaravelValidate\Utils\CountryPhoneValidator\TRPhoneValidator;
 use Milwad\LaravelValidate\Utils\CountryPhoneValidator\ZHPhoneValidator;
 
+use \Milwad\LaravelValidate\Utils\CountryLandlineValidator\CMLandlineValidator;
+use \Milwad\LaravelValidate\Utils\CountryLandlineValidator\DELandlineValidator;
+use \Milwad\LaravelValidate\Utils\CountryLandlineValidator\ENLandlineValidator;
+use \Milwad\LaravelValidate\Utils\CountryLandlineValidator\ESLandlineValidator;
+use \Milwad\LaravelValidate\Utils\CountryLandlineValidator\FRLandlineValidator;
+use \Milwad\LaravelValidate\Utils\CountryLandlineValidator\GRLandlineValidator;
+use \Milwad\LaravelValidate\Utils\CountryLandlineValidator\IDLandlineValidator;
+use \Milwad\LaravelValidate\Utils\CountryLandlineValidator\INLandlineValidator;
+use \Milwad\LaravelValidate\Utils\CountryLandlineValidator\IRLandlineValidator;
+use \Milwad\LaravelValidate\Utils\CountryLandlineValidator\ITLandlineValidator;
+use \Milwad\LaravelValidate\Utils\CountryLandlineValidator\JALandlineValidator;
+use \Milwad\LaravelValidate\Utils\CountryLandlineValidator\KOLandlineValidator;
+use \Milwad\LaravelValidate\Utils\CountryLandlineValidator\NELandlineValidator;
+use \Milwad\LaravelValidate\Utils\CountryLandlineValidator\RULandlineValidator;
+use \Milwad\LaravelValidate\Utils\CountryLandlineValidator\SALandlineValidator;
+use \Milwad\LaravelValidate\Utils\CountryLandlineValidator\SELandlineValidator;
+use \Milwad\LaravelValidate\Utils\CountryLandlineValidator\TRLandlineValidator;
+use \Milwad\LaravelValidate\Utils\CountryLandlineValidator\ZHLandlineValidator;
+
 return [
     /*
      * Mapping of country codes to their respective phone number validator classes.
@@ -47,6 +66,33 @@
         'ZH' => ZHPhoneValidator::class, // China
     ],
 
+    /*
+     * Mapping of country codes to their respective landline number validator classes.
+     * Each validator enforces country-specific landline number formatting and validation rules.
+     *
+     * You can add custom country landline validator.
+     */
+    'landline-country' => [
+        'CM' => CMLandlineValidator::class, // Cameroon
+        'DE' => DELandlineValidator::class, // Germany
+        'EN' => ENLandlineValidator::class, // England
+        'ES' => ESLandlineValidator::class, // Spain
+        'FR' => FRLandlineValidator::class, // France
+        'GR' => GRLandlineValidator::class, // Greece
+        'ID' => IDLandlineValidator::class, // Indonesia
+        'IN' => INLandlineValidator::class, // India
+        'IR' => IRLandlineValidator::class, // Iran
+        'IT' => ITLandlineValidator::class, // Italy
+        'JA' => JALandlineValidator::class, // Japan
+        'KO' => KOLandlineValidator::class, // South Korea
+        'NE' => NELandlineValidator::class, // Netherlands
+        'RU' => RULandlineValidator::class, // Russia
+        'SA' => SALandlineValidator::class, // Saudi Arabia
+        'SE' => SELandlineValidator::class, // Sweden
+        'TR' => TRLandlineValidator::class, // Turkey
+        'ZH' => ZHLandlineValidator::class, // China
+    ],
+
     /*
      * If you want to use rules like 'required|ValidPhone' in your validations, you can change it to true.
      */

docs/1.x/valid-landline-number.md

@@ -0,0 +1,48 @@
+## ValidLandlineNumber
+
+If you want to validate the landline number, you can use the `ValidLandlineNumber` rule:
+
+```php
+use Milwad\LaravelValidate\Rules\ValidLandlineNumber;
+
+return [
+    'landline-number' => ['required', new ValidLandlineNumber()], // landline-number => +98212223343
+];
+```
+
+Also, `ValidLandlineNumber` can validate landline numbers with a specific country code:
+
+```php
+use Milwad\LaravelValidate\Rules\ValidLandlineNumber;
+use Milwad\LaravelValidate\Utils\Country;
+
+return [
+    'landline-number' => ['required', new ValidLandlineNumber(Country::GERMANY)], // landline-number => +49301234567
+];
+```
+
+> **Note**  
+> If you want to know which country's codes are supported by the `ValidLandlineNumber` Rule, you can search your country
+> on this [Countries Landline Number](#support-countries-landline-number) list.
+
+<a name="support-countries-landline-number"></a>
+## Support Countries Landline Number
+
+- ✅ IRAN
+- ✅ ENGLAND
+- ✅ NIGER
+- ✅ SAUDI_ARABIA
+- ✅ GERMANY
+- ✅ GREECE
+- ✅ SPAIN
+- ✅ FRANCE
+- ✅ INDIA
+- ✅ INDONESIA
+- ✅ ITALY
+- ✅ JAPAN
+- ✅ KOREAN
+- ✅ RUSSIA
+- ✅ SWEDEN
+- ✅ TURKEY
+- ✅ CHINA
+- ✅ CAMEROON

src/LaravelValidateServiceProvider.php

@@ -6,6 +6,7 @@
 use Illuminate\Support\Facades\Validator;
 use Illuminate\Support\ServiceProvider;
 use Illuminate\Support\Str;
+use Milwad\LaravelValidate\Utils\CountryLandlineCallback;
 use Milwad\LaravelValidate\Utils\CountryPhoneCallback;
 
 class LaravelValidateServiceProvider extends ServiceProvider
@@ -65,6 +66,12 @@ public function boot(): void
             CountryPhoneCallback::addValidator($code, $country);
         }
 
+        $landlineCountries = config('laravel-validate.landline-country', []);
+
+        foreach ($landlineCountries as $code => $country) {
+            CountryLandlineCallback::addValidator($code, $country);
+        }
+
         // Register rules in container
         if (config('laravel-validate.using_container', false)) {
             $rules = File::files(__DIR__.'/Rules');

src/Rules/ValidLandlineNumber.php

@@ -0,0 +1,33 @@
+<?php
+
+namespace Milwad\LaravelValidate\Rules;
+
+use Illuminate\Contracts\Validation\Rule;
+use Milwad\LaravelValidate\Utils\CountryLandlineCallback;
+
+class ValidLandlineNumber implements Rule
+{
+    public function __construct(protected ?string $code = null) {}
+
+    /**
+     * Check phone number is valid.
+     */
+    public function passes($attribute, $value): bool
+    {
+        if (is_string($this->code)) {
+            $passes = CountryLandlineCallback::callLandlineValidator($this->code, $value);
+
+            return collect($passes)->some(fn ($passe) => $passe);
+        }
+
+        return preg_match('/^(?:\+|00)(?:[1-9]\d{0,2})(?:[ .\-]?\(?\d+\)?)+$/', $value);
+    }
+
+    /**
+     * Get the validation error message.
+     */
+    public function message(): string
+    {
+        return __('validate.landline-number');
+    }
+}

src/Utils/CountryLandlineCallback.php

@@ -0,0 +1,40 @@
+<?php
+
+namespace Milwad\LaravelValidate\Utils;
+
+use Milwad\LaravelValidate\Utils\CountryLandlineValidator\CountryLandlineValidator;
+use RuntimeException;
+
+class CountryLandlineCallback
+{
+    /**
+     * Country Validate classes.
+     */
+    protected static array $validators = [];
+
+    /**
+     * Add new country validator.
+     *
+     * @throws \Throwable
+     */
+    public static function addValidator(string $code, string $validator): void
+    {
+        if (! new $validator instanceof CountryLandlineValidator) {
+            throw new RuntimeException('The validator is not instance of CountryLandlineValidator');
+        }
+
+        self::$validators[$code] = $validator;
+    }
+
+    /**
+     * Call country validate class.
+     */
+    public static function callLandlineValidator(string $code, $value)
+    {
+        if (isset(self::$validators[$code])) {
+            return (new self::$validators[$code])->validate($value);
+        } else {
+            throw new \BadMethodCallException("Validator method for '$code' does not exist.");
+        }
+    }
+}

src/Utils/CountryLandlineValidator/CMLandlineValidator.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Milwad\LaravelValidate\Utils\CountryLandlineValidator;
+
+class CMLandlineValidator implements CountryLandlineValidator
+{
+    /**
+     * Validate Cameroon landline numbers.
+     */
+    public function validate($value): bool
+    {
+        return preg_match('/^(?:(?:\+237|00237)[\s-]?2\d{8}|2\d{8})$/', $value);
+    }
+}

src/Utils/CountryLandlineValidator/CountryLandlineValidator.php

@@ -0,0 +1,8 @@
+<?php
+
+namespace Milwad\LaravelValidate\Utils\CountryLandlineValidator;
+
+interface CountryLandlineValidator
+{
+    public function validate($value): bool;
+}

src/Utils/CountryLandlineValidator/DELandlineValidator.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Milwad\LaravelValidate\Utils\CountryLandlineValidator;
+
+class DELandlineValidator implements CountryLandlineValidator
+{
+    /**
+     * Validate Germany landline numbers.
+     */
+    public function validate($value): bool
+    {
+        return preg_match('/^(?:(?:\+49|0049)[\s\-]?[2-9]\d{1,4}[\s\-]?\d{3,8}|0[2-9]\d{1,4}[\s\-]?\d{3,8})$/', $value);
+    }
+}

src/Utils/CountryLandlineValidator/ENLandlineValidator.php

@@ -0,0 +1,14 @@
+<?php
+
+namespace Milwad\LaravelValidate\Utils\CountryLandlineValidator;
+
+class ENLandlineValidator implements CountryLandlineValidator
+{
+    /**
+     * Validate England landline numbers.
+     */
+    public function validate($value): bool
+    {
+        return preg_match('/^(?:(?:\+44|0044)\s?(?:1\d{9}|2\d{9})|0(?:1\d{9}|2\d{9}))$/', $value);
+    }
+}