wisonlau/identity-card

A simple proof of identity card of the people's Republic of China.

dev-master 2018-07-05 03:20 UTC

Requires

• php: >=7.1

Requires (Dev)

• mockery/mockery: ^1.0
• phpunit/phpunit: ^7.1

MIT

• wisonlau

• region
• area
• ID Card
• php71

README

China (Mainland) ID card package, the data from the national standard GB/T 2260-2007 (People's Republic of China administrative divisions code standard).

Installing

    composer require wisonlau/identity-card

Instructions

A component based on People's Republic of China citizen ID card to obtain the user information.This works for any php framework, but only if the php version is greater than 7.1.

Useing

Verify your Chinese ID card

    // Result false OR Ofcold\IdentityCard\IdentityCard instance.
    $result = Ofcold\IdentityCard\IdentityCard::make('32010619831029081');

    if ( $result === false ) {

        return 'Your ID number is incorrect';
    }

    print_r($result->toArray());

OR test file.

    php test

$idCard = Ofcold\IdentityCard\IdentityCard::make('320106198310290811', 'en');
//  Use locale, Current supported zh-cn,en
// $idCard = Ofcold\IdentityCard\IdentityCard::make('320106198310290811', 'zh-cn');
if ( $idCard === false ) {

    return 'Your ID number is incorrect';
}
$area = $idCard->getArea();
$gender = $idCard->getGender();
$birthday = $idCard->getBirthday();
$age = $idCard->getAge();
$constellation = $idCard->getConstellation();

Results:

{
    "area": "shan xi sheng yun cheng di qu yun cheng shi",
    "province": "shan xi sheng",
    "city": "yun cheng di qu",
    "county": "yun cheng shi",
    "gender": "Male",
    "birthday": "1980-03-12",
    "zodiac": "Pig",
    "age": 38,
    "constellation": "Pisces"
}

Api

• getArea() : string Get Area
• getConstellation() : string Get constellation
• getZodiac() : string Get zodiac
• getAge() : int Get age
• getBirthday(string $foramt = 'Y-m-d') : string Get birthday
• getGender() : string Get gender
• getCounty() : string|null Get county
• getCity() : string|null Get city
• getProvince() : string|null Get province
• toArray() : array Get all information.
• toJson(int $option) : string Json format all information
• __get() : mixed
• __toString() : toJson