Data types for swedish social security and corporation id numbers

Install using composer. Exists as byrokrat/id in the packagist repository.

composer require byrokrat/id

use byrokrat\id\PersonalId;
$id = new PersonalId('820323-2775');
echo $id;                            // 820323-2775
echo $id->format('Ymd-sk');          // 19820323-2775
echo $id->format('Y\-m\-d');         // 1982-03-23
echo $id->getSex();                  // M
$id->isMale();                       // true
echo $id->getBirthCounty()           // Kronobergs län

use byrokrat\id\OrganizationId;
$id = new OrganizationId('835000-0892');
echo $id->format('00Ssk');                // 008350000892
$id->isSexUndefined()                     // true
$id->isNonProfit();                       // true

• Id The base interface. Look here for a complete API reference.
  • PersonalId The identification number of a swedish individual (personnummer).
    • CoordinationId Identifier for non-citizens (samordningsnummer).
    • FakeId Replacement usable when a person must have an id, but is not registered with the swedish authorities.
  • OrganizationId Identifies a swedish company or organization (organisationsnummer).
  • NullId Null object implementation.

Creating ID objects can be comlicated.

• A personal id can be a coordination id, if the personal identified as not a swedish citizen.
• A corporation id can be a personal id if the corporation is registered with a single individual (egenföretagare).
• A single individual company can use a coordination id if the individual is not a swedish citizen.
• At times you may wish to process persons without a valid swedish personal id, using the FakeId implementation.

To solve these difficulties a decoratable IdFactory is included. Create a factory with the abilities you need by chaining factory objects at creation time.

use byrokrat\id\PersonalIdFactory;
use byrokrat\id\CoordinationIdFactory;
$factory = new PersonalIdFactory(new CoordinationIdFactory());
$id = $factory->create('some id...');

In this example the factory will first try to create a PersonalId, if this fails it will try to create a CoordinationId, if this fails it will throw an Exception.

Ids can be printed in custom formats using the format() method, where $formatStr is a mix of format tokens and non-formatting characters (for a list of formatting tokens se below).

echo $id->format($formatStr);

If you need to format a large number of ids a formatter object can be created.

use byrokrat\id\Formatter\Formatter;
$formatter = new Formatter($formatStr);
echo $formatter->format($id);

Characters that are not formatting tokens are returned as they are by the formatter.

Id is covered under the WTFPL

@author Hannes Forsgård (hannes.forsgard@fripost.org)