udokmeci/yii2-phone-validator

Modern Yii2 Phone validator wrapper on top of PhoneNumberUtil library also used by Android devices

2.0.0 2025-12-10 11:21 UTC

Requires

• php: >=8.1.0
• giggsey/libphonenumber-for-php: ^8.13
• yiisoft/yii2: ^2.0.40

Requires (Dev)

• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.0
• squizlabs/php_codesniffer: ^3.7

MIT

• Uğur DÖKMECİ

• yii2
• phone number
• phone number validator

README

Yii2 phone number validator extension using Google's libphonenumber library.

Installation

composer require udokmeci/yii2-phone-validator

Usage

Basic Validation

use udokmeci\yii2PhoneValidator\PhoneValidator;

class Contact extends ActiveRecord
{
    public function rules()
    {
        return [
            [['phone'], PhoneValidator::class, 'country' => 'NL'],
        ];
    }
}

Using Format Enum

use udokmeci\yii2PhoneValidator\PhoneValidator;
use udokmeci\yii2PhoneValidator\PhoneNumberFormat;

// Modern PHP 8.1+ enum usage
public function rules()
{
    return [
        [['phone'], PhoneValidator::class, 
            'country' => 'NL',
            'format' => PhoneNumberFormat::E164        // Enum case
        ],
        [['mobile'], PhoneValidator::class,
            'country' => 'NL', 
            'format' => PhoneNumberFormat::INTERNATIONAL // Enum case
        ],
    ];
}

Dynamic Country Detection

public function rules()
{
    return [
        [['phone'], PhoneValidator::class, 'countryAttribute' => 'country_code'],
    ];
}

Custom Formatting

use udokmeci\yii2PhoneValidator\PhoneNumberFormat;

public function rules()
{
    return [
        [['phone'], PhoneValidator::class, 
            'country' => 'NL',
            'format' => PhoneNumberFormat::E164  // Using enum
        ],
    ];
}

Configuration

Property	Description	Default
country	Fixed country code (ISO 3166-1 alpha-2)	null
countryAttribute	Model attribute containing country code	null
strict	Require country for validation	true
format	Output format	INTERNATIONAL

Format Options

Format	Example Output
PhoneNumberFormat::E164	[phone]
PhoneNumberFormat::INTERNATIONAL	[phone]
PhoneNumberFormat::NATIONAL	06 12345678
PhoneNumberFormat::RFC3966	tel:[phone]
false	No formatting

Note: PhoneNumberFormat is a modern PHP 8.1+ enum. Import: use udokmeci\yii2PhoneValidator\PhoneNumberFormat;

Examples

Netherlands Phone

// Input: '0612345678'
// Output: '[phone]'

US Phone

[['phone'], PhoneValidator::class, 'country' => 'US']
// Input: '2125551234' 
// Output: '[phone]'

Non-Strict Mode

[['phone'], PhoneValidator::class, 'strict' => false]
// Validates only if country is available

Requirements

• PHP 8.1+
• Yii2 2.0.40+
• giggsey/libphonenumber-for-php ^8.13

Testing

Follow Yii2 Extension Testing Guidelines:

vendor/bin/phpunit
vendor/bin/phpstan analyse  
vendor/bin/phpcs --standard=PSR12 src/

License

MIT License. See LICENSE file.