From 69f86010e571ff8dceedb1cce05aeb033c8386ec Mon Sep 17 00:00:00 2001 From: "google-labs-jules[bot]" <161369871+google-labs-jules[bot]@users.noreply.github.com> Date: Mon, 2 Mar 2026 16:59:27 +0000 Subject: [PATCH] doc: update README with usage examples for masking helpers - Add usage examples for maskCpf, unMaskCpf, maskPhone, maskMoney, maskCep, and maskCnpj. - Update table of contents with links to new sections. - Fix incorrect use of forward slashes in PHP namespace 'use' statements. Co-authored-by: lucasn4s <17988272+lucasn4s@users.noreply.github.com> --- README.md | 94 ++++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 80 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 58c29d1..08d8131 100644 --- a/README.md +++ b/README.md @@ -17,12 +17,12 @@ composer require sysvale/helpers ## Helpers class methods * [maskBank](#maskBank) - * maskCpf - * unMaskCpf - * maskPhone - * maskMoney - * maskCep - * maskCnpj + * [maskCpf](#maskCpf) + * [unMaskCpf](#unMaskCpf) + * [maskPhone](#maskPhone) + * [maskMoney](#maskMoney) + * [maskCep](#maskCep) + * [maskCnpj](#maskCnpj) * [trimpp](#trimpp) * titleCase * firstUpper @@ -54,7 +54,7 @@ composer require sysvale/helpers #### maskBank ```php -use Sysvale/Helpers; +use Sysvale\Helpers; $bankNumber = 12345; @@ -63,9 +63,75 @@ $maskedBank = Helpers::maskBank($bankNumber); // $maskedBank will be 1234-5 ``` +#### maskCpf +```php +use Sysvale\Helpers; + +$cpf = '12345678901'; + +$maskedCpf = Helpers::maskCpf($cpf); + +// $maskedCpf will be 123.456.789-01 +``` + +#### unMaskCpf +```php +use Sysvale\Helpers; + +$cpf = '123.456.789-01'; + +$unMaskedCpf = Helpers::unMaskCpf($cpf); + +// $unMaskedCpf will be 12345678901 +``` + +#### maskPhone +```php +use Sysvale\Helpers; + +$phone = '79988001010'; + +$maskedPhone = Helpers::maskPhone($phone); + +// $maskedPhone will be (79) 98800-1010 +``` + +#### maskMoney +```php +use Sysvale\Helpers; + +$value = 1234.56; + +$maskedMoney = Helpers::maskMoney($value); + +// $maskedMoney will be 1.234,56 +``` + +#### maskCep +```php +use Sysvale\Helpers; + +$cep = '49000000'; + +$maskedCep = Helpers::maskCep($cep); + +// $maskedCep will be 49000-000 +``` + +#### maskCnpj +```php +use Sysvale\Helpers; + +$cnpj = '12345678000199'; + +$maskedCnpj = Helpers::maskCnpj($cnpj); + +// $maskedCnpj will be 12.345.678/0001-99 +``` + #### trimpp ```php -use Sysvale/Helpers; +use Sysvale\Helpers; $text = " Text \t \n "; //String with spaces and special caracter; @@ -76,7 +142,7 @@ $text = Helpers::trimpp($text); #### urlNoCache ```php -use Sysvale/Helpers; +use Sysvale\Helpers; $url = 'http://url.com.br'; @@ -107,7 +173,7 @@ To use the class import as in the example: #### isValidCpf ```php -use Sysvale/Helpers/Validate; +use Sysvale\Helpers\Validate; $value = '334.734.750-17'; @@ -119,7 +185,7 @@ $isValid = Validate::isValidCpf($value); #### isValidCnpj ```php -use Sysvale/Helpers/Validate; +use Sysvale\Helpers\Validate; $value = '56.396.710/0001-37'; @@ -131,7 +197,7 @@ $isValid = Validate::isValidCnpj($value); #### isValidPhone ```php -use Sysvale/Helpers/Validate; +use Sysvale\Helpers\Validate; $value = '79988001010'; @@ -143,7 +209,7 @@ $isValid = Validate::isValidPhone($value); #### isValidResidentialPhone ```php -use Sysvale/Helpers/Validate; +use Sysvale\Helpers\Validate; $value = '7033662200'; @@ -155,7 +221,7 @@ $isValid = Validate::isValidResidentialPhone($value); #### isValidMobilePhone ```php -use Sysvale/Helpers/Validate; +use Sysvale\Helpers\Validate; $value = '70993662200';