jxlwqq / id-validator

src/IdValidator.php

<?php

Missing file doc comment

namespace Jxlwqq\IdValidator;

/**
 * Class IdValidator.
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class IdValidator
{
    use Helper;
    use Generator;
    use Checker;
    private $_addressCodeList = []; // 现行地址码数据
    private $_addressCodeTimeline = []; // 地址码变更时间线

    /**
     * IdValidator constructor.
     */
    public function __construct()
    {
        $this->_addressCodeList = include __DIR__.'/../data/addressCode.php';
        $this->_addressCodeTimeline = include __DIR__.'/../data/addressCodeTimeline.php';
        $additionalAddressCodeTimeline = include __DIR__.'/../data/additionalAddressCodeTimeline.php';
        $this->_addressCodeTimeline = $additionalAddressCodeTimeline + $this->_addressCodeTimeline;
    }

    /**
     * 验证身份证号合法性.
     *
     * @param string $id         身份证号
     * @param bool   $strictMode 是否启动严格模式检查
     *
     * @return bool
     */
    public function isValid($id, $strictMode = false)
    {
        // 基础验证
        $code = $this->_checkIdArgument($id);
        if (empty($code)) {
            return false;
        }

        // 分别验证：*地址码*、*出生日期码*和*顺序码*
        if (!$this->_checkAddressCode($code['addressCode'], $code['birthdayCode'], $strictMode) || !$this->_checkBirthdayCode($code['birthdayCode']) || !$this->_checkOrderCode($code['order'])) {
            return false;
        }

        // 15位身份证不含校验码
        if ($code['type'] === 15) {
            return true;
        }

        // 验证：校验码
        $checkBit = $this->_generatorCheckBit($code['body']);

        // 检查校验码
        return $checkBit == $code['checkBit'];
    }

    /**
     * 获取身份证信息.
     *
     * @param string $id         身份证号
     * @param bool   $strictMode 是否启动严格模式检查
     *
     * @return array|bool
     */
    public function getInfo($id, $strictMode = false)
    {
        // 验证有效性
        if ($this->isValid($id, $strictMode) === false) {
            return false;
        }
        $code = $this->_checkIdArgument($id);
        $addressInfo = $this->_getAddressInfo($code['addressCode'], $code['birthdayCode'], $strictMode);

        return [
            'addressCode'   => $code['addressCode'],
            'abandoned'     => isset($this->_addressCodeList[$code['addressCode']]) ? 0 : 1,
            'address'       => is_array($addressInfo) ? implode($addressInfo) : '',
            'addressTree'   => array_values($addressInfo),

It seems like $addressInfo can also be of type false; however, parameter $array of array_values() does only seem to accept array, maybe add an additional type check?

            'birthdayCode'  => date('Y-m-d', strtotime($code['birthdayCode'])),
            'constellation' => $this->_getConstellation($code['birthdayCode']),
            'chineseZodiac' => $this->_getChineseZodiac($code['birthdayCode']),
            'sex'           => ($code['order'] % 2 === 0 ? 0 : 1),
            'length'        => $code['type'],
            'checkBit'      => $code['checkBit'],
        ];
    }

    /**
     * * 生成假数据.
     *
     * @param bool            $isEighteen 是否为 18 位
     * @param null|string     $address    地址
     * @param null|string|int $birthday   出生日期
     * @param null|int        $sex        性别（1为男性，0位女性）
     *
     * @return string
     */
    public function fakeId($isEighteen = true, $address = null, $birthday = null, $sex = null)
    {
        // 生成地址码
        if (empty($address)) {
            $addressCode = array_rand($this->_addressCodeList);
            $address = $this->_addressCodeList[$addressCode];
        } else {
            $addressCode = $this->_generatorAddressCode($address);
        }

        // 出生日期码
        $birthdayCode = $this->_generatorBirthdayCode($addressCode, $address, $birthday);

        // 顺序码
        $orderCode = $this->_generatorOrderCode($sex);

        if (!$isEighteen) {
            return $addressCode.substr($birthdayCode, 2).$orderCode;

Are you sure $addressCode of type array|integer|string can be used in concatenation?

        }

        $body = $addressCode.$birthdayCode.$orderCode;

        $checkBit = $this->_generatorCheckBit($body);

        return $body.$checkBit;
    }

    /**
     * 15位升级18位号码.
     *
     * @param string $id 身份证号
     *
     * @return bool|string
     */
    public function upgradeId($id)
    {
        if (!$this->isValid($id)) {
            return false;
        }
        $code = $this->_generateShortType($id);
        $body = $code['addressCode'].$code['birthdayCode'].$code['order'];

        return $body.$this->_generatorCheckBit($body);
    }
}