pietaj / pesel Goto Github PK

Paczka do łatwej walidacji numeru PESEL.

Composer:

composer require kkszymanowski/pesel

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.

$pesel = new Pesel($number);

lub

$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.

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

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ą');
}

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:

try {
    Pesel::create($number);

    echo('Numer PESEL jest poprawny');
} catch(\Pesel\Exceptions\PeselValidationException $e) {
    echo('Numer PESEL jest błędny');
}

$pesel = new Pesel($number);

$pesel->getNumber();    // Zwraca string

$pesel->getBirthDate(); // Zwraca DateTime

$pesel->getGender();    // Zwraca Pesel::GENDER_MALE lub Pesel::GENDER_FEMALE

Pesel::isValid($pesel); // Zwraca bool, nie rzuca wyjątku

Parametr $birthDate jest instancją wbudowanej w PHP klasy DateTime

PeselValidator::hasBirthDate(Pesel::create($pesel), $birthDate);

PeselValidator::hasGender(Pesel::create($pesel), Pesel::GENDER_MALE);

PeselValidator::hasGender(Pesel::create($pesel), Pesel::GENDER_FEMALE);