abdelazizomar/egyption-national-id-extractor

This package is used to extract citizen information by his national-id

1.0 2021-11-17 20:01 UTC

MIT

• aomarabdelaziz

README

Extract information from egyptian national id like date of birth , place of birth , gender and much more

Can be used in government organizations and special organizations who use egyptian national id only

Requirements

1. Composer
2. PHP version 8 or newer

Installation

composer require abdelazizomar/egyption-national-id-extractor

Usage

// Intitialize CitizenNationalIdExtractor class
$citizenData = new CitizenNationalIdExtractor(nationalId: "29803050202393");

// To get citizen century code
$citizenData->getCitizenCenturyCode();

//or you can use null-safe operator to make sure that national id is correct equal (14 number) and the output may be (null|int)
$citizenData->verifyCitizen()?->getCitizenCenturyCode();

int(2)

// To get citizen goverment code
$citizenData->getCitizenGovermentCode();

//or you can use null-safe operator to make sure that national id is correct equal (14 number) and the output may be (null|string)
$citizenData->verifyCitizen()?->getCitizenGovermentCode();

string(2) "02"

// To get citizen Goverment
$citizenData->GetCitizenGoverment(code: citizenData->getCitizenGovermentCode());

//or you can use null-safe operator to make sure that national id is correct equal (14 number) and the output may be (null|string)
$citizenData->verifyCitizen()?->GetCitizenGoverment(code: citizenData->getCitizenGovermentCode());

string(10) "Alexandria"

// To get citizen birthday year
$citizenData->getCitizenBirthdayYear();

//or you can use null-safe operator to make sure that national id is correct equal (14 number) and the output may be (null|int)
$citizenData->verifyCitizen()?->getCitizenBirthdayYear();

int(1998)

// To get citizen birthday month
$citizenData->getCitizenBirthdayMonth();

//or you can use null-safe operator to make sure that national id is correct equal (14 number) and the output may be (null|string)
$citizenData->verifyCitizen()?->getCitizenBirthdayMonth();

string(2) "03"

// To get citizen birthday day
$citizenData->getCitizenBirthdayMonth();

//or you can use null-safe operator to make sure that national id is correct equal (14 number) and the output may be (null|string)
$citizenData->verifyCitizen()?->getCitizenBirthday();

string(2) "05"

// To get citizen gender
$citizenData->getCitizenGender();

//or you can use null-safe operator to make sure that national id is correct equal (14 number) and the output may be (null|string)
$citizenData->verifyCitizen()?->getCitizenGender();

string(4) "Male"

// To get citizen all information
$citizenData->getCitizenInfo();

//or you can use null-safe operator to make sure that national id is correct equal (14 number) and the output may be (null|array)
$citizenData->verifyCitizen()?->getCitizenInfo();

array(3) {
  ["DateOfBirth"]=>
  string(10) "1998/03/05"
  ["Gender"]=>
  string(4) "Male"
  ["Town"]=>
  string(10) "Alexandria"
}