Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Number Validation based on Country #388

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 70 additions & 22 deletions example/pubspec.lock
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,18 @@ packages:
dependency: transitive
description:
name: collection
sha256: f092b211a4319e98e5ff58223576de6c2803db36221657b46c82574721240687
sha256: ee67cb0715911d28db6bf4af1026078bd6f0128b07a5f66fb2ed94ec6783c09a
url: "https://pub.dev"
source: hosted
version: "1.17.2"
version: "1.18.0"
dlibphonenumber:
dependency: transitive
description:
name: dlibphonenumber
sha256: "43d472d66ae3cb8143a9cb4b45934a755131c7629944058a86ae60f0530c6053"
url: "https://pub.dev"
source: hosted
version: "1.1.14"
fake_async:
dependency: transitive
description:
Expand All @@ -49,6 +57,14 @@ packages:
url: "https://pub.dev"
source: hosted
version: "1.3.1"
fixnum:
dependency: transitive
description:
name: fixnum
sha256: "25517a4deb0c03aa0f32fd12db525856438902d9c16536311e76cdc57b31d7d1"
url: "https://pub.dev"
source: hosted
version: "1.1.0"
flutter:
dependency: "direct main"
description: flutter
Expand All @@ -65,39 +81,71 @@ packages:
path: ".."
relative: true
source: path
version: "3.2.0"
version: "3.3.0"
leak_tracker:
dependency: transitive
description:
name: leak_tracker
sha256: "78eb209deea09858f5269f5a5b02be4049535f568c07b275096836f01ea323fa"
url: "https://pub.dev"
source: hosted
version: "10.0.0"
leak_tracker_flutter_testing:
dependency: transitive
description:
name: leak_tracker_flutter_testing
sha256: b46c5e37c19120a8a01918cfaf293547f47269f7cb4b0058f21531c2465d6ef0
url: "https://pub.dev"
source: hosted
version: "2.0.1"
leak_tracker_testing:
dependency: transitive
description:
name: leak_tracker_testing
sha256: a597f72a664dbd293f3bfc51f9ba69816f84dcd403cdac7066cb3f6003f3ab47
url: "https://pub.dev"
source: hosted
version: "2.0.1"
matcher:
dependency: transitive
description:
name: matcher
sha256: "1803e76e6653768d64ed8ff2e1e67bea3ad4b923eb5c56a295c3e634bad5960e"
sha256: d2323aa2060500f906aa31a895b4030b6da3ebdcc5619d14ce1aada65cd161cb
url: "https://pub.dev"
source: hosted
version: "0.12.16"
version: "0.12.16+1"
material_color_utilities:
dependency: transitive
description:
name: material_color_utilities
sha256: "9528f2f296073ff54cb9fee677df673ace1218163c3bc7628093e7eed5203d41"
sha256: "0e0a020085b65b6083975e499759762399b4475f766c21668c4ecca34ea74e5a"
url: "https://pub.dev"
source: hosted
version: "0.5.0"
version: "0.8.0"
meta:
dependency: transitive
description:
name: meta
sha256: "3c74dbf8763d36539f114c799d8a2d87343b5067e9d796ca22b5eb8437090ee3"
sha256: d584fa6707a52763a52446f02cc621b077888fb63b93bbcb1143a7be5a0c0c04
url: "https://pub.dev"
source: hosted
version: "1.9.1"
version: "1.11.0"
path:
dependency: transitive
description:
name: path
sha256: "8829d8a55c13fc0e37127c29fedf290c102f4e40ae94ada574091fe0ff96c917"
sha256: "087ce49c3f0dc39180befefc60fdb4acd8f8620e5682fe2476afd0b3688bb4af"
url: "https://pub.dev"
source: hosted
version: "1.8.3"
version: "1.9.0"
protobuf:
dependency: transitive
description:
name: protobuf
sha256: "68645b24e0716782e58948f8467fd42a880f255096a821f9e7d0ec625b00c84d"
url: "https://pub.dev"
source: hosted
version: "3.1.0"
sky_engine:
dependency: transitive
description: flutter
Expand All @@ -115,18 +163,18 @@ packages:
dependency: transitive
description:
name: stack_trace
sha256: c3c7d8edb15bee7f0f74debd4b9c5f3c2ea86766fe4178eb2a18eb30a0bdaed5
sha256: "73713990125a6d93122541237550ee3352a2d84baad52d375a4cad2eb9b7ce0b"
url: "https://pub.dev"
source: hosted
version: "1.11.0"
version: "1.11.1"
stream_channel:
dependency: transitive
description:
name: stream_channel
sha256: "83615bee9045c1d322bbbd1ba209b7a749c2cbcdcb3fdd1df8eb488b3279c1c8"
sha256: ba2aa5d8cc609d96bbb2899c28934f9e1af5cddbd60a827822ea467161eb54e7
url: "https://pub.dev"
source: hosted
version: "2.1.1"
version: "2.1.2"
string_scanner:
dependency: transitive
description:
Expand All @@ -147,10 +195,10 @@ packages:
dependency: transitive
description:
name: test_api
sha256: "75760ffd7786fffdfb9597c35c5b27eaeec82be8edfb6d71d32651128ed7aab8"
sha256: "5c2f730018264d276c20e4f1503fd1308dfbbae39ec8ee63c5236311ac06954b"
url: "https://pub.dev"
source: hosted
version: "0.6.0"
version: "0.6.1"
vector_math:
dependency: transitive
description:
Expand All @@ -159,13 +207,13 @@ packages:
url: "https://pub.dev"
source: hosted
version: "2.1.4"
web:
vm_service:
dependency: transitive
description:
name: web
sha256: dc8ccd225a2005c1be616fe02951e2e342092edf968cf0844220383757ef8f10
name: vm_service
sha256: b3d56ff4341b8f182b96aceb2fa20e3dcb336b9f867bc0eafc0de10f1048e957
url: "https://pub.dev"
source: hosted
version: "0.1.4-beta"
version: "13.0.0"
sdks:
dart: ">=3.1.0-185.0.dev <4.0.0"
dart: ">=3.2.0-0 <4.0.0"
59 changes: 41 additions & 18 deletions lib/intl_phone_field.dart
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
library intl_phone_field;

import 'dart:async';
import 'package:dlibphonenumber/generated/classes/phone_number/phonenumber.pb.dart';
import 'package:dlibphonenumber/phone_number_util.dart';
import 'package:fixnum/fixnum.dart';
import 'package:flutter/foundation.dart' show kIsWeb;
import 'package:flutter/material.dart';
import 'package:flutter/services.dart';
import 'package:intl_phone_field/country_picker_dialog.dart';
import 'package:intl_phone_field/helpers.dart';
import 'package:intl_phone_field/phone_number.dart';

import './countries.dart';
import './phone_number.dart';

class IntlPhoneField extends StatefulWidget {
/// The TextFormField key.
Expand All @@ -26,7 +28,7 @@ class IntlPhoneField extends StatefulWidget {

/// {@macro flutter.widgets.editableText.readOnly}
final bool readOnly;
final FormFieldSetter<PhoneNumber>? onSaved;
final FormFieldSetter<LocalPhoneNumber>? onSaved;

/// {@macro flutter.widgets.editableText.onChanged}
///
Expand All @@ -36,7 +38,7 @@ class IntlPhoneField extends StatefulWidget {
/// runs and can validate and change ("format") the input value.
/// * [onEditingComplete], [onSubmitted], [onSelectionChanged]:
/// which are more specialized input change notifications.
final ValueChanged<PhoneNumber>? onChanged;
final ValueChanged<LocalPhoneNumber>? onChanged;

final ValueChanged<Country>? onCountryChanged;

Expand All @@ -49,7 +51,7 @@ class IntlPhoneField extends StatefulWidget {
/// By default, the validator checks whether the input number length is between selected country's phone numbers min and max length.
/// If `disableLengthCheck` is not set to `true`, your validator returned value will be overwritten by the default validator.
/// But, if `disableLengthCheck` is set to `true`, your validator will have to check phone number length itself.
final FutureOr<String?> Function(PhoneNumber?)? validator;
final FutureOr<String?> Function(LocalPhoneNumber?)? validator;

/// {@macro flutter.widgets.editableText.keyboardType}
final TextInputType keyboardType;
Expand Down Expand Up @@ -337,7 +339,7 @@ class _IntlPhoneFieldState extends State<IntlPhoneField> {
}

if (widget.autovalidateMode == AutovalidateMode.always) {
final initialPhoneNumber = PhoneNumber(
final initialPhoneNumber = LocalPhoneNumber(
countryISOCode: _selectedCountry.code,
countryCode: '+${_selectedCountry.dialCode}',
number: widget.initialValue ?? '',
Expand All @@ -355,6 +357,22 @@ class _IntlPhoneFieldState extends State<IntlPhoneField> {
}
}

bool _validatePhoneNumber(String phoneNumber) {
try {
PhoneNumberUtil phoneUtil = PhoneNumberUtil.instance;

PhoneNumber parsedphoneNumber = phoneUtil.parse(phoneNumber, _selectedCountry.code);

// Check if the phone number is valid for the specified country code
final isValid = phoneUtil.isValidNumber(parsedphoneNumber);
return isValid;
} catch (e) {
// Handle errors such as invalid country code
print('Error validating phone number: $e');
return false;
}
}

Future<void> _changeCountry() async {
filteredCountries = _countryList;
await showDialog(
Expand Down Expand Up @@ -406,35 +424,40 @@ class _IntlPhoneFieldState extends State<IntlPhoneField> {
style: widget.style,
onSaved: (value) {
widget.onSaved?.call(
PhoneNumber(
LocalPhoneNumber(
countryISOCode: _selectedCountry.code,
countryCode: '+${_selectedCountry.dialCode}${_selectedCountry.regionCode}',
number: value!,
),
);
},
onChanged: (value) async {
final phoneNumber = PhoneNumber(
final phoneNumber = LocalPhoneNumber(
countryISOCode: _selectedCountry.code,
countryCode: '+${_selectedCountry.fullCountryCode}',
number: value,
);

if (widget.autovalidateMode != AutovalidateMode.disabled) {
validatorMessage = await widget.validator?.call(phoneNumber);
}

widget.onChanged?.call(phoneNumber);
},
validator: (value) {
if (value == null || !isNumeric(value)) return validatorMessage;
validator: (String? value) {
if (value == null || value.isEmpty) {
return widget.invalidNumberMessage;
}

// Check if the value is a valid phone number for the selected country
final isValidPhoneNumber = _validatePhoneNumber(value);
if (!isValidPhoneNumber) {
return widget.invalidNumberMessage;
}

if (!widget.disableLengthCheck) {
return value.length >= _selectedCountry.minLength && value.length <= _selectedCountry.maxLength
? null
: widget.invalidNumberMessage;
final isValidLength =
value.length >= _selectedCountry.minLength && value.length <= _selectedCountry.maxLength;
if (!isValidLength) return widget.invalidNumberMessage;
}

return validatorMessage;
return null;
},
maxLength: widget.disableLengthCheck ? null : _selectedCountry.maxLength,
keyboardType: widget.keyboardType,
Expand Down
28 changes: 14 additions & 14 deletions lib/phone_number.dart
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@ class NumberTooShortException implements Exception {}

class InvalidCharactersException implements Exception {}

class PhoneNumber {
class LocalPhoneNumber {
String countryISOCode;
String countryCode;
String number;

PhoneNumber({
LocalPhoneNumber({
required this.countryISOCode,
required this.countryCode,
required this.number,
});

factory PhoneNumber.fromCompleteNumber({required String completeNumber}) {
factory LocalPhoneNumber.fromCompleteNumber({required String completeNumber}) {
if (completeNumber == "") {
return PhoneNumber(countryISOCode: "", countryCode: "", number: "");
return LocalPhoneNumber(countryISOCode: "", countryCode: "", number: "");
}

try {
Expand All @@ -30,13 +30,13 @@ class PhoneNumber {
} else {
number = completeNumber.substring(country.dialCode.length + country.regionCode.length);
}
return PhoneNumber(
return LocalPhoneNumber(
countryISOCode: country.code, countryCode: country.dialCode + country.regionCode, number: number);
} on InvalidCharactersException {
rethrow;
// ignore: unused_catch_clause
} on Exception catch (e) {
return PhoneNumber(countryISOCode: "", countryCode: "", number: "");
return LocalPhoneNumber(countryISOCode: "", countryCode: "", number: "");
}
}

Expand All @@ -56,24 +56,24 @@ class PhoneNumber {
return countryCode + number;
}

static Country getCountry(String phoneNumber) {
if (phoneNumber == "") {
static Country getCountry(String localPhoneNumber) {
if (localPhoneNumber == "") {
throw NumberTooShortException();
}

final validPhoneNumber = RegExp(r'^[+0-9]*[0-9]*$');
final validLocalPhoneNumber = RegExp(r'^[+0-9]*[0-9]*$');

if (!validPhoneNumber.hasMatch(phoneNumber)) {
if (!validLocalPhoneNumber.hasMatch(localPhoneNumber)) {
throw InvalidCharactersException();
}

if (phoneNumber.startsWith('+')) {
if (localPhoneNumber.startsWith('+')) {
return countries
.firstWhere((country) => phoneNumber.substring(1).startsWith(country.dialCode + country.regionCode));
.firstWhere((country) => localPhoneNumber.substring(1).startsWith(country.dialCode + country.regionCode));
}
return countries.firstWhere((country) => phoneNumber.startsWith(country.dialCode + country.regionCode));
return countries.firstWhere((country) => localPhoneNumber.startsWith(country.dialCode + country.regionCode));
}

@override
String toString() => 'PhoneNumber(countryISOCode: $countryISOCode, countryCode: $countryCode, number: $number)';
String toString() => 'LocalPhoneNumber(countryISOCode: $countryISOCode, countryCode: $countryCode, number: $number)';
}
Loading