You are here

Home » API reference » Mobile Number 2.0.x

README.txt in Mobile Number 2.0.x

Same filename and directory in other branches
  1. 8 README.txt
  2. 7 README.txt
MOBILE NUMBER
-------------

CONTENTS OF THIS FILE
---------------------

 * Introduction
 * Requirements
 * Recommended Modules
 * Features
 * Integration (with other modules)
 * Installation

INTRODUCTION
------------

Mobile Number is a field type that provides mobile number validation and
verification, and can be used for two factor authentication. It works with
SMS Framework and TFA modules, respectively, and both features are optional.

The module differs from the Phone module in that it puts security and
authenticity first, and focuses on mobile numbers which therefore assumes sms
and smartphone capabilities by the user. The number is sanitized before saving,
country is validated, the number is validated to be a mobile number type,
allows uniqueness validation, and, if enabled, allows verifying number
ownership by the user. For verification, codes are hashed and tokenized in the
database. See the case for a dedicated mobile number field.
(https://www.drupal.org/node/2783505)

The module uses libphonenumber (developed by Google for use in Android) for
validation, and supports the mobile number formats of the countries listed
here (https://github.com/giggsey/libphonenumber-for-php/blob/master/src/
libphonenumber/ShortNumbersRegionCodeSet.php), which is basically all of them.


REQUIREMENTS
------------

This module requires the following php library:
 * giggsey/libphonenumber-for-php (https://github.com/giggsey/libphonenumber-for-php)


RECOMMENDED MODULES
-------------------

 * SMS Framework (https://www.drupal.org/project/smsframework):
 * TFA (https://www.drupal.org/project/tfa):


FEATURES
--------

 * Mobile number validation
 * Mobile number verification
 * Uniqueness validation
 * Two factor authentication


INTEGRATION (WITH OTHER MODULES)
--------------------------------

 * Feeds
 * Telephone
 * Devel
 * TFA
 * SMS Framework


INSTALLATION
------------

 * Install as you would normally install a contributed Drupal module. See:
   https://drupal.org/documentation/install/modules-themes/modules-7
   for further information.
 * Install the  libphonenumber project using Drupal's root composer.
 * For mobile number verification, download, enable, and configure SMS
   Framework. You will need to setup an SMS gateway, which will require
   setting up an account and paying fees on a 3rd party service, or use SMS
   Framework's default logger gateway for testing.
 * For two factor authentication, complete step 3 and download, enable, and
   configure TFA.

File

README.txt
View source 
  1. MOBILE NUMBER

  2. -------------

  3. 

  4. CONTENTS OF THIS FILE

  5. ---------------------

  6. 

  7.  * Introduction

  8.  * Requirements

  9.  * Recommended Modules

  10.  * Features

  11.  * Integration (with other modules)

  12.  * Installation

  13. 

  14. INTRODUCTION

  15. ------------

  16. 

  17. Mobile Number is a field type that provides mobile number validation and

  18. verification, and can be used for two factor authentication. It works with

  19. SMS Framework and TFA modules, respectively, and both features are optional.

  20. 

  21. The module differs from the Phone module in that it puts security and

  22. authenticity first, and focuses on mobile numbers which therefore assumes sms

  23. and smartphone capabilities by the user. The number is sanitized before saving,

  24. country is validated, the number is validated to be a mobile number type,

  25. allows uniqueness validation, and, if enabled, allows verifying number

  26. ownership by the user. For verification, codes are hashed and tokenized in the

  27. database. See the case for a dedicated mobile number field.

  28. (https://www.drupal.org/node/2783505)

  29. 

  30. The module uses libphonenumber (developed by Google for use in Android) for

  31. validation, and supports the mobile number formats of the countries listed

  32. here (https://github.com/giggsey/libphonenumber-for-php/blob/master/src/

  33. libphonenumber/ShortNumbersRegionCodeSet.php), which is basically all of them.

  34. 

  35. 

  36. REQUIREMENTS

  37. ------------

  38. 

  39. This module requires the following php library:

  40.  * giggsey/libphonenumber-for-php (https://github.com/giggsey/libphonenumber-for-php)

  41. 

  42. 

  43. RECOMMENDED MODULES

  44. -------------------

  45. 

  46.  * SMS Framework (https://www.drupal.org/project/smsframework):

  47.  * TFA (https://www.drupal.org/project/tfa):

  48. 

  49. 

  50. FEATURES

  51. --------

  52. 

  53.  * Mobile number validation

  54.  * Mobile number verification

  55.  * Uniqueness validation

  56.  * Two factor authentication

  57. 

  58. 

  59. INTEGRATION (WITH OTHER MODULES)

  60. --------------------------------

  61. 

  62.  * Feeds

  63.  * Telephone

  64.  * Devel

  65.  * TFA

  66.  * SMS Framework

  67. 

  68. 

  69. INSTALLATION

  70. ------------

  71. 

  72.  * Install as you would normally install a contributed Drupal module. See:

  73.    https://drupal.org/documentation/install/modules-themes/modules-7

  74.    for further information.

  75.  * Install the  libphonenumber project using Drupal's root composer.

  76.  * For mobile number verification, download, enable, and configure SMS

  77.    Framework. You will need to setup an SMS gateway, which will require

  78.    setting up an account and paying fees on a 3rd party service, or use SMS

  79.    Framework's default logger gateway for testing.

  80.  * For two factor authentication, complete step 3 and download, enable, and

  81.    configure TFA.