Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Bill Li authored Nov 20, 2017
1 parent bbb59fd commit 403c5f7
Showing 1 changed file with 16 additions and 12 deletions.
28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@


China (region) citizen ID card tool
------------------------

> 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
## Installing

```bash

composer require anomalylab/component-identity-card
```


### Instructions
## 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
```php
Expand Down Expand Up @@ -70,13 +74,13 @@ China (region) citizen ID card tool
```

### Api
- `getArea():string` 获取地区
- `getConstellation():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` 全部信息
- getArea():string `获取地区`
- getConstellation():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 `全部信息`

0 comments on commit 403c5f7

Please sign in to comment.