README

Utilidades para validar, formatear y parsear RUT chileno en proyectos Laravel y PHP.

El paquete incluye una clase principal independiente de Laravel y una regla de validacion lista para usar con el validador de Laravel.

Repositorio: JSalazarLl/laravel-chilean-rut

Requisitos

• PHP 8.2 o superior.
• Composer.
• Laravel 11, 12 o 13 si quieres usar la regla de validacion incluida.

Instalacion

Instala el paquete con Composer:

composer require jsalazarll/chilean-rut:^1.0

Si ya agregaste el paquete previamente, puedes actualizarlo con:

composer update jsalazarll/chilean-rut

Uso rapido

use JSalazarLl\Rut\Rut;

Rut::isValid('12.345.678-5');           // true
Rut::format('123456785');               // "12.345.678-5"
Rut::formatForDatabase('12.345.678-5'); // "12345678-5"
Rut::clean('12.345.678-5');             // "123456785"
Rut::normalizeIfValid('12.345.678-5');  // "12345678-5"
Rut::normalizeIfValid('12.345.678-6');  // null
Rut::fake();                            // "12.345.678-5"
Rut::fake(10, 'database');              // array con 10 RUT validos

Validacion en Laravel

Usa ValidRut en un Form Request:

use JSalazarLl\Rut\Rules\ValidRut;

public function rules(): array
{
    return [
        'rut' => ['required', new ValidRut],
    ];
}

O directamente con Validator::make:

use Illuminate\Support\Facades\Validator;
use JSalazarLl\Rut\Rules\ValidRut;

$validator = Validator::make($request->all(), [
    'rut' => ['required', new ValidRut],
]);

La regla acepta RUT en formatos habituales:

12.345.678-5
12345678-5
123456785

Si el RUT no es valido, la regla retorna el mensaje:

El campo :attribute no es un RUT valido.

Formatos disponibles

Para el RUT 12.345.678-5, la libreria puede entregar:

Referencia de API

Todas las funciones principales se llaman desde:

use JSalazarLl\Rut\Rut;

Rut::isValid()

Valida si un RUT tiene estructura parseable y digito verificador correcto.

Rut::isValid('12.345.678-5'); // true
Rut::isValid('12.345.678-6'); // false
Rut::isValid(null);           // false

Firma:

Rut::isValid(string|int|null $rut): bool

Rut::format()

Entrega el RUT con puntos y guion.

Rut::format('123456785'); // "12.345.678-5"

Firma:

Rut::format(string|int $rut): string

Alias:

Rut::mask(string|int $rut): string

Rut::formatForDatabase()

Entrega el RUT sin puntos y con guion.

Rut::formatForDatabase('12.345.678-5'); // "12345678-5"

Firma:

Rut::formatForDatabase(string|int $rut): string

Alias:

Rut::normalize(string|int $rut): string

Rut::normalizeIfValid()

Valida un RUT y, si es valido, lo retorna en formato recomendado para base de datos. Si el valor no es valido, retorna null.

Rut::normalizeIfValid('12.345.678-5'); // "12345678-5"
Rut::normalizeIfValid('12.345.678-6'); // null
Rut::normalizeIfValid(null);           // null

Firma:

Rut::normalizeIfValid(string|int|null $rut): ?string

Rut::clean()

Entrega el RUT sin puntos ni guion.

Rut::clean('12.345.678-5'); // "123456785"

Firma:

Rut::clean(string|int $rut): string

Alias:

Rut::unmask(string|int $rut): string

Rut::split() y Rut::parse()

Retornan un objeto RutData con el cuerpo numerico y el digito verificador.

$rut = Rut::parse('12.345.678-5');

$rut->digits;      // "12345678"
$rut->dv;          // "5"
$rut->formatted(); // "12.345.678-5"
$rut->database();  // "12345678-5"
$rut->clean();     // "123456785"

Firmas:

Rut::split(string|int $rut): JSalazarLl\Rut\Data\RutData
Rut::parse(string|int $rut): JSalazarLl\Rut\Data\RutData

Rut::digits()

Entrega solo el cuerpo numerico del RUT.

Rut::digits('12.345.678-5'); // "12345678"

Firma:

Rut::digits(string|int $rut): string

Rut::dv()

Entrega solo el digito verificador.

Rut::dv('12.345.678-5'); // "5"

Firma:

Rut::dv(string|int $rut): string

Rut::calculateDv()

Calcula el digito verificador desde el cuerpo numerico del RUT.

Rut::calculateDv('12345678'); // "5"
Rut::calculateDv('6');        // "K"

Firma:

Rut::calculateDv(string|int $digits): string

Rut::fake()

Genera RUT validos en el formato que necesites. Es util para pruebas, factories, seeders y datos temporales.

Rut::fake();                // "12.345.678-5"
Rut::fake(format: 'clean'); // "123456785"
Rut::fake(10, 'database');  // array con 10 RUT validos

Firma:

Rut::fake(int $quantity = 1, string $format = 'formatted'): string|array

Alias:

Rut::faker(int $quantity = 1, string $format = 'formatted'): string|array

El parametro $quantity debe estar entre 1 y 50. Si pides un solo RUT, retorna un string. Si pides mas de uno, retorna un array<int, string>.

Formatos disponibles:

Rut::toArray()

Entrega una representacion completa del RUT.

Rut::toArray('12.345.678-5');

Resultado:

[
    'digits' => '12345678',
    'dv' => '5',
    'clean' => '123456785',
    'database' => '12345678-5',
    'formatted' => '12.345.678-5',
    'is_valid' => true,
]

Firma:

/**
 * @return array{
 *     digits: string,
 *     dv: string,
 *     clean: string,
 *     database: string,
 *     formatted: string,
 *     is_valid: bool
 * }
 */
Rut::toArray(string|int $rut): array

Rut::isFormatted()

Indica si el RUT viene con formato visual chileno: puntos y guion.

Rut::isFormatted('12.345.678-5'); // true
Rut::isFormatted('12345678-5');   // false

Firma:

Rut::isFormatted(string|int $rut): bool

Esta funcion solo revisa el formato. No valida el digito verificador.

Rut::isDatabaseFormat()

Indica si el RUT viene en el formato recomendado para base de datos: sin puntos y con guion.

Rut::isDatabaseFormat('12345678-5');   // true
Rut::isDatabaseFormat('12.345.678-5'); // false

Firma:

Rut::isDatabaseFormat(string|int $rut): bool

Esta funcion solo revisa el formato. No valida el digito verificador.

Rut::throwIfInvalid()

Lanza InvalidArgumentException si el RUT no es valido.

Rut::throwIfInvalid('12.345.678-5'); // no lanza excepcion
Rut::throwIfInvalid('12.345.678-6'); // lanza InvalidArgumentException

Firma:

Rut::throwIfInvalid(string|int|null $rut): void

Manejo de errores

Los metodos que parsean o transforman un RUT lanzan InvalidArgumentException cuando el valor recibido no tiene una estructura compatible con un RUT chileno.

use InvalidArgumentException;
use JSalazarLl\Rut\Rut;

try {
    $rut = Rut::format($input);
} catch (InvalidArgumentException) {
    // Manejar el valor invalido.
}

Si solo necesitas saber si el valor es valido, usa Rut::isValid(), que retorna false en lugar de lanzar una excepcion.

Objeto RutData

Rut::split() y Rut::parse() retornan una instancia de JSalazarLl\Rut\Data\RutData.

use JSalazarLl\Rut\Rut;

$rut = Rut::parse('12.345.678-5');

$rut->digits;      // "12345678"
$rut->dv;          // "5"
$rut->clean();     // "123456785"
$rut->database();  // "12345678-5"
$rut->formatted(); // "12.345.678-5"
$rut->toArray();   // array con digits, dv, clean, database y formatted

Licencia

MIT.