README_zh_CN.md

一个简单的身份证号码获取用户信息工具

English Documentation

中国（大陆地区）公民身份证，数据来源于国家标准GB/T 2260-2007 （中华人民共和国行政区划代码)

## 安装

    composer require ofcold/identity-card

说明

一个基于中华人民共和国公民身份证的组件可以获取用户信息。这个适用于任何php框架，但是只有当php版本>=7.1时才可以。

使用

使用在 Laravel 表单验证

多语言增加 Please enter a valid Id Card 到你的json语言包中

use Ofcold\IdentityCard\Rules\IdCard;

/**
 * Get the validation rules that apply to the request.
 *
 * @return array
 */
public function rules()
{
    return [
        'id_card'  => [
            'required',
            new IdCard
        ]
    ];
}

验证你的身份证号码

    //  返回false 或 Ofcold\IdentityCard\IdentityCard
    $result = Ofcold\IdentityCard\IdentityCard::make('32010619831029081');

    if ( $result === false ) {

        return '您的身份证号码不正确';
    }

    print_r($result->toArray());

或运行测试文件

    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 '您的身份证号码不正确';
}

$area = $idCard->getArea();
$gender = $idCard->getGender();
$birthday = $idCard->getBirthday();
$age = $idCard->getAge();
$constellation = $idCard->getConstellation();

返回结果:

{
    "area": "山西省 运城地区 运城市",
    "province": "山西省",
    "city": "运城地区",
    "county": "运城市",
    "gender": "男",
    "birthday": "1980-03-12",
    "zodiac": "猪",
    "age": 38,
    "constellation": "双鱼座"
}

Api

• getArea():string 获取地区
• getConstellation():string 获取星座
• getZodiac() : string 获取生肖
• getAge():int 获取年龄
• getBirthday(string $foramt = 'Y-m-d'):string 获取生日
• getGender():string 获取性别
• getCounty():string|null 获取县城
• getCity():string|null 获取城市
• getProvince():string|null 获取省
• toArray():array 全部信息
• toJson(int $option):string 全部信息

修改历史

V2.0.0

• 新增 #2 __get()
• 新增 #2 __toString()
• 修改 #2 static make() 方法返回当前对象或者boolean类型
• 移除 #2 构造方法异常验证