README

South African ID for Laravel

Validation rules and an Eloquent Model attribute cast to value object encapsulating a South African government-issued personal identification number, for Laravel.

The validator will pass values generated by the Faker idNumber formatter that is part of the English (South Africa) or en_ZA locale.

Install

Use Composer to install the package.

composer require spoorsny/laravel-south-african-id

Usage

Validation Rules

A value submitted in a request can be validated to be a South African ID.

use Spoorsny\Laravel\Rules\SouthAfricanId;

$request->validate([
    'id_number' => ['required', 'string', new SouthAfricanId()],
]);

If the request also contains a birth date field, that field can be validated to match the South African ID using the BirthDateMatchSouthAfricanId rule. In this case, the field containing the South African ID, must be named south_african_id.

use Spoorsny\Laravel\Rules\BirthDateMatchSouthAfricanId;
use Spoorsny\Laravel\Rules\SouthAfricanId;

$request->validate([
    'south_african_id' => ['required', 'string', new SouthAfricanId()],
    'birth_date' => [
        'date_format:Y-m-d',
        'before_or_equal:today',
        new BirthDateMatchSouthAfricanId()
    ],
]);

Cast

An attribute of an Eloquent model can be cast to an instance of the South African ID value object (\Spoorsny\ValueObjects\SouthAfricanId provided by Composer package spoorsny/south-african-id).

use Spoorsny\Laravel\Casts\AsSouthAfricanId;

/**
 * Get the attributes that should be cast.
 *
 * @return array<string, string>
 */
protected function casts(): array
{
    return [
        'south_african_id' => AsSouthAfricanId::class,
    ];
}

Contributing

To contribute to the package, see the Contributing Guide.

License

Copyright © 2024 Geoffrey Bernardo van Wyk https://geoffreyvanwyk.dev

This file is part of package spoorsny/laravel-south-african-id.

Package spoorsny/laravel-south-african-id is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

Package spoorsny/laravel-south-african-id is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with package spoorsny/laravel-south-african-id. If not, see https://www.gnu.org/licenses/.

For a copy of the license, see the LICENSE file in this repository.