Download the PHP package spoorsny/south-african-id without Composer

On this page you can find all versions of the php package spoorsny/south-african-id. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of spoorsny/south-african-id

Informations about the package south-african-id

Repository Bannner

Latest Version on Packagist Total Downloads GitHub Tests Action Status PHPUnit Code Coverage

South African ID for PHP

A self-validating value object encapsulating a South African government-issued personal identification number, for PHP.

A South African government-issued identity number consists of 13 digits and the following segments:

Install

Use Composer to install the package.

Usage

The value object can be instantiated by passing a string to its constructor.

If the string argument is not in the valid format, an InvalidArgumentException with a message indicative of the type of error, will be thrown.

The value object can used in places where strings are used, because it implements the Stringable interface. For example, a value object can be instantiated by passing another instance to its constructor.

[!NOTE] The value object always formats the identity number with a single space between the date segment and the gender segment, and a single space between the gender segment and the citizenship segment.

It can be used with the strval() function and echo statement.

Different instances of the class can be checked for equality with the equals() method.

Even though the identity number starts with the person's birth date, it cannot be used to compare whether one person is older than another. This is due to the century portion being missing from the date.

Useful information encoded in the identity number can be extracted, for example:

The different segments of the identity number can be extracted from the value object as follows:

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/south-african-id.

Package spoorsny/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/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/south-african-id. If not, see https://www.gnu.org/licenses/.

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

All versions of south-african-id with dependencies

PHP Build Version
Package Version
Requires php Version ^8.3
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package spoorsny/south-african-id contains the following files

Loading the files please wait ....