Instalacja i szybki start

Wymagania

• PHP 8.3 lub nowszy
• Composer

Instalacja

1. Dodaj pakiet

   composer require slashlab/numerik

2. Brak konfiguracji

   Pakiet ładuje się automatycznie dzięki PSR-4 — nie wymaga żadnej konfiguracji ani inicjalizacji.

3. Użyj

   use SlashLab\Numerik\Numerik;
   
   Numerik::pesel()->isValid('92060512186'); // true

Szybki start

Walidacja boolowska

use SlashLab\Numerik\Numerik;

Numerik::pesel()->isValid('92060512186');                    // true
Numerik::nip()->isValid('5260250274');                       // true
Numerik::regon()->isValid('691761365');                      // true
Numerik::krs()->isValid('0000127206');                       // true
Numerik::nrb()->isValid('61102010260000000000000000');       // true
Numerik::vatEu()->isValid('PL5260250274');                   // true
Numerik::iban()->isValid('PL61102010260000000000000000');    // true

Szczegółowa walidacja

validate() nigdy nie rzuca wyjątku — zwraca ValidationResult z listą błędów, jeśli numer okazał się nieprawidłowy.

use SlashLab\Numerik\Numerik;

$result = Numerik::pesel()->validate('92060512186');
$result->isValid;               // true
$result->failures;              // []

$result = Numerik::pesel()->validate('92060512185');  // zła cyfra kontrolna
$result->isFailed();            // true
$result->getFirstFailure()->reason->value;  // 'invalid_checksum'
$result->getFirstFailure()->message;        // komunikat czytelny dla człowieka

Zobacz Wyniki walidacji aby poznać pełne API.

Pełny obiekt z danymi

parse() zwraca obiekt wartości lub — jeśli numer jest nieprawidłowy — rzuca ValidationException.

use SlashLab\Numerik\Numerik;

$pesel = Numerik::pesel()->parse('92060512186');
$pesel->getBirthDate()->format('Y-m-d');  // '1992-06-05'
$pesel->getGender();                      // Gender::Female
$pesel->getAge();                         // int — obliczony od dzisiaj
$pesel->isAdult();                        // true

Użyj tryParse() gdy wolisz null przy niepowodzeniu zamiast wyjątku:

$pesel = Numerik::pesel()->tryParse('zły-numer'); // null

Wybór właściwej metody

Metoda	Zwraca	Rzuca	Kiedy używać
isValid()	bool	nigdy	Proste sprawdzenie istnienia
validate()	ValidationResult	nigdy	Gdy potrzebujesz powodu błędu
parse()	obiekt wartości	ValidationException	Gdy potrzebujesz wyodrębnionych danych i wolisz wyjątki
tryParse()	obiekt wartości lub null	nigdy	Gdy potrzebujesz wyodrębnionych danych, ale wolisz null zamiast wyjątku

Następne kroki

• Przejrzyj dokumentację PESEL, NIP, REGON, KRS, NRB, VAT-EU lub IBAN z pełną listą metod.
• Obsługa błędów — hierarchia wyjątków i kiedy po nie sięgać.
• Wyniki walidacji — pełne API ValidationResult.
• Używasz Laravela? Zobacz Integrację z Laravel — gotowe reguły walidacji.