https://github.com/francerz/php-mx-imss
https://github.com/francerz/php-mx-imss
Last synced: 5 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/francerz/php-mx-imss
- Owner: francerz
- License: mit
- Created: 2024-08-20T14:28:01.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-24T22:02:55.000Z (almost 2 years ago)
- Last Synced: 2025-10-26T23:19:51.028Z (8 months ago)
- Language: PHP
- Size: 5.86 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Francerz/MxImss
`francerz/mx-imss` es una librería para PHP que proporciona herramientas para trabajar con Números de Seguridad Social (NSS) en México. Actualmente, incluye la clase `NumeroSeguro` para la validación de números de seguro social del IMSS.
## Instalación
Puedes instalar esta librería utilizando Composer:
```bash
composer require francerz/mx-imss
```
## Uso
### Validación de un Número de Seguridad Social
La clase `NumeroSeguro` permite validar si un NSS es correcto en función de su longitud y el cálculo del dígito verificador. A continuación, se muestra un ejemplo de uso:
```php
require 'vendor/autoload.php';
use Francerz\MxImss\NumeroSeguro;
// Ejemplo de NSS válido
$nssValido = "84966311213";
$numeroSeguro = new NumeroSeguro($nssValido);
if ($numeroSeguro->esValido()) {
echo "El NSS $nssValido es válido.";
} else {
echo "El NSS $nssValido no es válido.";
}
// Ejemplo de NSS inválido
$nssInvalido = "84966311215";
$numeroSeguro = new NumeroSeguro($nssInvalido);
if ($numeroSeguro->esValido()) {
echo "El NSS $nssInvalido es válido.";
} else {
echo "El NSS $nssInvalido no es válido.";
}
```
### Métodos Disponibles
#### `NumeroSeguro::__construct(string $nss)`
Constructor de la clase. Recibe como parámetro el NSS que se desea validar.
#### `NumeroSeguro::esValido() : bool`
Verifica si el NSS es válido en función de su longitud y el cálculo del dígito verificador.
#### `NumeroSeguro::verificarUltimoDigito(string $nss) : bool`
Valida el dígito verificador de un NSS específico.
### Requisitos
- PHP 7.4 o superior.
## Contribución
Las contribuciones son bienvenidas. Por favor, crea un *fork* del repositorio, realiza tus cambios y abre un *pull request*.
## Licencia
Este proyecto está licenciado bajo la [ISC License](LICENSE).