README

从 MyKad/MyKid 号码中提取信息，验证用户输入并生成 Faker 数据。

关于 MyKad

政府多功能智能卡项目（MPSC）或 MyKad 是多媒体超级走廊（MSC Malaysia）倡议的一部分。

介绍

本包提供

数据提取
输入验证
Faker 提供程序生成假 MyKad 号码（用于 Laravel）

安装

您可以通过 composer 安装此包

composer require akukoder/mykad

数据提取

使用此包，您可以从 MyKad/MyKid 中提取一些信息

出生日期
州名
性别

出生日期

从输入中获取出生日期。

use AkuKoder\MyKad\Extractor as MyKadExtractor;

echo (new MyKadExtractor('871003417888'))->dateOfBirth();
// Result: 1987-10-03

echo (new MyKadExtractor('871003417888'))->dateOfBirth('d/m/Y');

// Result: 03/10/1987

性别

从输入中获取性别。基本上，1 为男性，0 为女性。

use AkuKoder\MyKad\Extractor as MyKadExtractor;

echo (new MyKadExtractor('871003417888'))->gender();

// Result: 1

州

从输入中获取州名。

use AkuKoder\MyKad\Extractor as MyKadExtractor;

echo (new MyKadExtractor('871003417888'))->stateName();

// Result: Selangor

验证

处理用户记录时最令人烦恼的事情之一是他们输入了错误的 MyKad/MyKid 号码。此包有助于减少处理无效用户输入的负担。

此包将验证 MyKad/MyKid 号码以确保

只包含数字
有效长度
有效出生日期
有效的州/国家代码

注意

输入中的任何其他不必要的字符将被删除，包括破折号。

用法

use AkuKoder\MyKadValidator\Validator;

// Check for invalid date
if ((new Validator)->validate('982404-06-5883')) {
    // Result: false
}

// Check for invalid length
if ((new Validator)->validate('982404-06-83')) {
    // Result: false    
}

// Check for invalid state code
if ((new Validator)->validate('980404-00-5335')) {
    // Result: false
}

// Check for invalid characters
if ((new Validator)->validate('9804AA-00-5335')) {
    // Result: false
}

// All passes
if ((new Validator)->validate('980404-06-5335')) {
    // Result: true
}

在错误时获取异常

use AkuKoder\MyKadValidator\Validator;

$validator = new Validator;

if ($validator->validate('982404-06-5883', true)) {
    // This will throw \AkuKoder\MyKadValidator\Exceptions\InvalidDateException    
}

if ($validator->validate('982404-06-83', true)) {
    // This will throw \AkuKoder\MyKadValidator\Exceptions\InvalidLengthException    
}

if ($validator->validate('980404-00-5335', true)) {
    // This will throw \AkuKoder\MyKadValidator\Exceptions\InvalidCodeException    
}

if ($validator->validate('9804AA-00-5335', true)) {
    // This will throw \AkuKoder\MyKadValidator\Exceptions\InvalidCharacterException    
}

Faker 提供程序

为了生成用于测试或模型工厂的模拟数据，请将其添加到您的服务提供程序中或创建一个新的服务提供程序。让我们创建一个新的服务提供程序

php artisan make:provider FakerServiceProvider

在 register 方法中注册 MyKadProvider。

<?php

namespace App\Providers;

use AkuKoder\MyKad\Faker\MyKadProvider;
use Faker\{Factory, Generator};
use Illuminate\Support\ServiceProvider;

class FakerServiceProvider extends ServiceProvider
{
    /**
     * Register services.
     *
     * @return void
     */
    public function register(): void
    {
        $this->app->singleton(Generator::class, function () {
            $faker = Factory::create();
            $faker->addProvider(new MyKadProvider($faker));

            return $faker;
        });
    }
}

请确保在 /config/app.php 文件中包含附加的 Laravel 服务提供程序。

'providers' => [
    App\Providers\FakerServiceProvider::class,
],

现在您可以使用新的格式化程序，就像其他 Faker 格式化程序一样。在 Laravel 工厂中，自定义格式化程序的语法如下

public function definition(): array
{
    return [
        'ic_number' => $this->faker->mykad,
    ];
}

测试

composer test

致谢

许可

MIT 许可证（MIT）。

akukoder / mykad

维护者

详细信息