https://github.com/kkszymanowski/pesel
Walidacja numeru PESEL(Polish national identification number validation)
https://github.com/kkszymanowski/pesel
pesel php validation
Last synced: about 1 year ago
JSON representation
Walidacja numeru PESEL(Polish national identification number validation)
- Host: GitHub
- URL: https://github.com/kkszymanowski/pesel
- Owner: KKSzymanowski
- License: mit
- Created: 2016-06-16T15:27:48.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2021-12-10T10:09:20.000Z (over 4 years ago)
- Last Synced: 2025-04-25T04:04:35.401Z (about 1 year ago)
- Topics: pesel, php, validation
- Language: PHP
- Size: 35.2 KB
- Stars: 7
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
## PESEL
[](https://app.travis-ci.com/KKSzymanowski/PESEL)
[](https://coveralls.io/github/KKSzymanowski/PESEL?branch=master)
[](https://styleci.io/repos/61304979)
[](https://packagist.org/packages/kkszymanowski/pesel)
[](https://packagist.org/packages/kkszymanowski/pesel)
Paczka do łatwej walidacji numeru **PESEL**.
### Instalacja
[Composer](https://getcomposer.org/):
```
composer require kkszymanowski/pesel
```
### Upgrade guide
#### 2.* -> 3.*
Wersja 3 jest wstecznie kompatybilna z wersją 2, ale wymaga PHP >=7.3.
Poza podniesieniem wersji PHP żadne zmiany nie są konieczne.
Zalecana jest natomiast zmiana łapanego wyjątku `InvalidArgumentException` na wyjątki odpowiadające konkretnym błędom walidacji:
- `Pesel\Exceptions\InvalidLengthException` - Błędna długość
- `Pesel\Exceptions\InvalidCharactersException` - Znaki inne niż cyfry
- `Pesel\Exceptions\InvalidChecksumException` - Błędna suma kontrolna
lub po prostu na `Pesel\Exceptions\PeselValidationException` aby złapać wszystkie błędy walidacji.
#### 3.* -> 4.*
W wersji 4 zmieniona została walidacja numeru PESEL, aby dobrze identyfikować numery takie jak `00000000000` i `44444444444` jako niepoprawne.
Wersja 4 jest zatem niekompatybilna z wersją 3 w tych przypadkach brzegowych, ale nie powinno być problemów z kompatybilnością w większości przypadków.
Od wersji 4 w przypadku nieprawidłowej daty urodzenia w numerze PESEL rzucany jest nowy wyjątek - `Pesel\Exceptions\InvalidBirthDateException`.
### Użycie
##### Tworzenie obiektu
```php
$pesel = new Pesel($number);
```
lub
```php
$pesel = Pesel::create($number);
```
**Powyższe metody są równoważne.**
Podczas tworzenia obiektu sprawdzana jest poprawność numeru PESEL.
- Powinien mieć 11 znaków.
- Powinien zawierać wyłącznie cyfry.
- Suma kontrolna powinna być poprawna.
- Powinien zawierać prawidłową datę urodzenia:
- rok >= 1800 i < 2300.
- miesiąc >= 1 i <= 12.
- dzień >= 1 i nie większy niż liczba dni w danym miesiącu i danym roku.
Jeżeli przynajmniej jeden z tych warunków nie zostanie spełniony, zostanie rzucony odpowiedni wyjątek:
- `Pesel\Exceptions\InvalidLengthException` - Błędna długość
- `Pesel\Exceptions\InvalidCharactersException` - Znaki inne niż cyfry
- `Pesel\Exceptions\InvalidChecksumException` - Błędna suma kontrolna
- `Pesel\Exceptions\InvalidChecksumException` - Błędna data urodzenia
```php
try {
Pesel::create($number);
echo('Numer PESEL jest poprawny');
} catch(Pesel\Exceptions\InvalidLengthException $e) {
echo('Numer PESEL ma nieprawidłową długość');
} catch(Pesel\Exceptions\InvalidCharactersException $e) {
echo('Numer PESEL zawiera nieprawidłowe znaki');
} catch(Pesel\Exceptions\InvalidChecksumException $e) {
echo('Numer PESEL zawiera błędną sumę kontrolną');
} catch(Pesel\Exceptions\InvalidBirthDateException $e) {
echo('Numer PESEL zawiera nieprawdiłową datę urodzenia');
}
```
Wszystkie powyższe wyjątki dziedziczą z `Pesel\Exceptions\PeselValidationException` więc jeżeli niepotrzebne jest
rozróżnienie na konkretne błędy walidacji można zastosować jedną klauzulę `catch`:
```php
try {
Pesel::create($number);
echo('Numer PESEL jest poprawny');
} catch(\Pesel\Exceptions\PeselValidationException $e) {
echo('Numer PESEL jest błędny');
}
```
##### Pobieranie zawartości numeru PESEL:
```php
$pesel = new Pesel($number);
$pesel->getNumber(); // Zwraca string
$pesel->getBirthDate(); // Zwraca DateTime
$pesel->getGender(); // Zwraca Pesel::GENDER_MALE lub Pesel::GENDER_FEMALE
```
##### Sprawdzenie poprawności:
```php
Pesel::isValid($pesel); // Zwraca bool, nie rzuca wyjątku
```
##### Sprawdzenie daty urodzenia:
Parametr `$birthDate` jest instancją wbudowanej w PHP klasy DateTime
```php
PeselValidator::hasBirthDate(Pesel::create($pesel), $birthDate);
```
##### Sprawdzenie płci
```php
PeselValidator::hasGender(Pesel::create($pesel), Pesel::GENDER_MALE);
PeselValidator::hasGender(Pesel::create($pesel), Pesel::GENDER_FEMALE);
```