From b858b89d5b5f2e35452b1406ce0ba75b876493a7 Mon Sep 17 00:00:00 2001 From: Matias Navarro Carter Date: Fri, 12 Oct 2018 16:41:11 -0300 Subject: [PATCH] Documentation update [ci skip] --- README.md | 30 ++++++++++++++++++++++-------- 1 file changed, 22 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 978960f..cc5adad 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,9 @@ Rut Chileno [![Maintainability](https://api.codeclimate.com/v1/badges/c93bd4d894722c404cfd/maintainability)](https://codeclimate.com/github/mnavarrocarter/chilean-rut/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/c93bd4d894722c404cfd/test_coverage)](https://codeclimate.com/github/mnavarrocarter/chilean-rut/test_coverage) [![Latest Stable Version](https://poser.pugx.org/mnavarrocarter/chilean-rut/v/stable.svg)](https://packagist.org/packages/mnavarrocarter/chilean-rut) +[![Latest Unstable Version](https://poser.pugx.org/mnavarrocarter/chilean-rut/v/unstable)](https://packagist.org/packages/mnavarrocarter/chilean-rut) +[![Total Downloads](https://poser.pugx.org/mnavarrocarter/chilean-rut/downloads)](https://packagist.org/packages/mnavarrocarter/chilean-rut) +[![License](https://poser.pugx.org/mnavarrocarter/chilean-rut/license)](https://packagist.org/packages/mnavarrocarter/chilean-rut) Esta librería implementa una clase Rut como un *value object* inmutable, incluyendo una api de validación flexible y extendible. @@ -37,19 +40,30 @@ $rut = new Rut('23.546.565-4'); $rut = Rut::fromString('23546565-4'); ``` -Por defecto, la clase Rut no se valida a sí misma, lo que puede significar que -el objeto sea instanciado en un estado inconsistente. Si esto no te gusta, puedes pasarle -el `SimpleRutValidator` al constructor, y el Rut será validado al momento de ser instanciado. +Por defecto, la clase Rut se valida usando el `Module11RutValidator` si no se pasa +un validador personalizado al momento de instanciación. Esto es para asegurar la +integridad del objeto. + +Si quieres, por alguna extraña razón, deshacerte de esa validación, puedes crear +un `AlwaysValidRutValidator` implementando la interfaz `RutValidator`. El método +validate estaría en blanco, lo que haría pasar la validación sin problema. ```php validate($rut); Una vez creado el objeto Rut, puedes formatearlo a string en el formato que tu quieras. Esto se hace a través del método format y cómo parámetro acepta el valor -de una de las constantes FORMAT_ de la clase Rut. +de una de las constantes `FORMAT_` de la clase Rut. ```php