olssonm / swedish-entity
Validator and formatter for Swedish personnummer and organisationsnummer. With Laravel validators.
Fund package maintenance!
olssonm
Installs: 143 283
Dependents: 0
Suggesters: 0
Security: 0
Stars: 12
Watchers: 3
Forks: 0
Open Issues: 1
Requires
- php: ^7.3|^8.0
- personnummer/personnummer: ^3.0.4
Requires (Dev)
- orchestra/testbench: >=4.0
- squizlabs/php_codesniffer: ^3.5
Suggests
- laravel/framework: For Laravel-integration
This package is auto-updated.
Last update: 2024-10-04 18:33:19 UTC
README
Validate, format and extract data for Swedish personnummer (social security numbers) and organisationsnummer (organizational numbers).
This package also handles the temporary personal identity number known as "Samordningsnummer" (a.k.a. coordination number).
Also includes validators for Laravel.
–
The benefits of this package – while not always strictly according to the standard – is the ability to format using both short/long (10 or 12 characters) without or with a separator (i.e. 11/13 characters).
Note that companies always consists of 10/11 characters (with or without an optional separator).
This package use the excellent personnummer/php-package as it's basis for the social security-handling, but with some additional attributes and methods.
Installation
composer require olssonm/swedish-entity
Usage
Validation
<?php use Olssonm\SwedishEntity\Person; (new Person('600411-8177'))->valid() // true
<?php use Olssonm\SwedishEntity\Organization; (new Organization('556016-0680'))->valid() // true
Automatically detect the entity type:
⚠️ If the
detect
-method fails, anOlssonm\SwedishEntity\Exceptions\DetectException
will be thrown.
<?php use Olssonm\SwedishEntity\Entity; $entity = Entity::detect('600411-8177'); var_dump(get_class($entity)) // Olssonm\SwedishEntity\Person
Formatting
⚠️ Formatting an invalid entity will result in an exception. You should make sure to validate it beforehand.
Person
<?php use Olssonm\SwedishEntity\Person; (new Person('071012-9735'))->format($characters = 12, $separator = true) // 20071012-9735 (new Person('071012+9735'))->format($characters = 12, $separator = true) // 19071012+9735 (new Person('200710129735'))->format() // 071012-9735
Organization
<?php use Olssonm\SwedishEntity\Organization; (new Organization('5560160680'))->format($separator = true) // 556016-0680 (new Organization('556016-0680'))->format($separator = false) // 5560160680
Laravel validators
The package registrers the "entity" rule, which accepts the parameters any
, organization
or person
.
<?php $this->validate($request, [ 'number' => 'required|entity:organization' ]);
You may also omit the parameter and the validator will fallback to any
<?php $this->validate($request, [ 'number' => 'required|entity' ]);
Custom messages
<?php use Illuminate\Support\Facades\Validator; $validator = Validator::make($request->all(), [ 'number' => 'required|entity:person' ], [ 'number.entity' => "Invalid personnummer!" ]);
Implicit validation
For the validator to run when the social security/organizational number is missing or an empty string (note, does not apply to null
) you will need to implicitly state so with a required rule, i.e:
'organization_number' => [ 'required_with:company_name', 'entity:organization', ],
or
'organization_number' => [ 'required', 'entity', ],
Attributes
Person
*Either "Samordningsnummer" or "Personnummer"
Example
<?php use Olssonm\SwedishEntity\Person; $person = new Person('600411-8177'); $person->gender; // Male
Organization
*One of the following: "Dödsbon", "Stat, landsting och kommuner", "Aktiebolag", "Enkelt bolag", "Ekonomiska föreningar", "Ideella föreningar och stiftelser" and "Handelsbolag, kommanditbolag och enkla bolag". Note: Organizations starting with 0, 3 and 4, while technically a valid number – it is uncertain if they exist, and will return and empty string.
Example
<?php use Olssonm\SwedishEntity\Organization; $organization = new Organization('212000-1355'); $organization->type; // Stat, landsting och kommuner
Clean-helper
The Entity-class contains a clean-helper that can be useful for removing illegal characters from a social security- or organisational number:
<?php use Olssonm\SwedishEntity\Entity; $number = Entity::clean(' 212000-1355a'); // '212000-1355'
Note that this is not automatically applied, so you will need to clean the string before validation.
Gotcha moments
Enskild firma
EF (Enskild firma) – while technically a company/organization, uses the proprietors personnummer. Therefore that number will not validate as company/organization. Instead of using a custom solution for this (as Creditsafe, Bisnode and others do – by adding additional numbers/characters to the organizational number/social security number), a way to handle this would be:
- Work with 10 digits when expecting both people and companies (preferably with a separator). Hint: both
Person
andOrganization
will format with 10 digits (and a separator) by default viaformat()
. - Use the
detect
-method to automatically validate both types
If you need to after the validation check type;
<?php use Olssonm\SwedishEntity\Entity; use Olssonm\SwedishEntity\Person; use Olssonm\SwedishEntity\Organization; use Olssonm\SwedishEntity\Exceptions\DetectException try { $entity = Entity::detect('600411-8177'); } catch (DetectException $e) { // Handle exception } // PHP < 8 if(get_class($entity) == Person::class) { // Do stuff for person } elseif(get_class($entity) == Organization::class) { // Do stuff for organization } // PHP 8 if($entity::class == Person::class) { // Do stuff for person } elseif($entity::class == Organization::class) { // Do stuff for organization }
License
The MIT License (MIT). Please see the License File for more information.
© 2022 Marcus Olsson.