Skip to content

Commit

Permalink
Improve read.me
Browse files Browse the repository at this point in the history
  • Loading branch information
wallacemaxters committed Jun 13, 2024
1 parent 75f956f commit 6b9e09c
Show file tree
Hide file tree
Showing 2 changed files with 42 additions and 4 deletions.
40 changes: 37 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,46 @@
# WallaceMaxters/Masker

Mask your strings like javascript inputs!
This library helpers your to format the texts or numbers with simple masks.

Instalation:

For installation, your need to use php in 8.1, 8.2 or 8.3 version.

```bash
composer require wallacemaxters/masker
```

Basic Usage:

```php
use WallaceMaxters\Masker\Masker;

$mask = new Masker();
$masker = new Masker();

$masker->mask('31995451199', '(00) 00000-0000'); // '(31) 99545-1199'
// or
$masker('31995451199', '(00) 00000-0000'); // '(31) 99545-1199'
```

You can format texts with any character.

```php
$masker->mask('ABC12345', '[AAA]_(00000)'); // '[ABC]_(12345)'
```


$mask->mask('31995451199', '(00) 00000-0000'); // '(31) 99545-1199'
If need, you can return the unmasked value of `string`.

```php
$masker->unmask('[ABC]_(12345)', '[AAA]_(00000)'); // 'ABC12345'
```

The `dynamic` method allows to pass many masks as parameters. This allows that your string are formatted according with size.

```php
$cpf_or_cnpj = ['000.000.000-00', '00.000.000/0000-00'];

$masker->dynamic('45522248327', $cpf_or_cnpj); // '455.222.483-27'

$masker->dynamic('68544172000160', $cpf_or_cnpj); // '68.544.172/0001-60'
```
6 changes: 5 additions & 1 deletion tests/MaskerTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -100,10 +100,14 @@ public function testUmask()
$masker->unmask('A-BC-1234', 'A-AA-0000')
);


$this->assertNull(
$masker->unmask('ABC', 'A-AA-00000')
);

$this->assertEquals(
$masker->unmask('[ABC]_(12345)', '[AAA]_(00000)'),
'ABC12345'
);
}

public function testUmaskException()
Expand Down

0 comments on commit 6b9e09c

Please sign in to comment.