README

字段掩码从未如此简单！

安装（Instalação）

通过composer安装（Instalação pelo composer）

composer require gabrielanhaia/masknizzer

或将其依赖项添加到您的 composer.json 中，并： （ou adicione a denpendência em seu composer.json e:）

composer install

使用（Uso）

####1 - 创建新的掩码（Criando uma nova máscara）

您可以使用 '\Masknizzer\EnumMasks' 中已有的格式，或者（É possível usar os formatos de máscara padrão em '\Masknizzer\EnumMasks' ou）

use Eloquent\Enumeration\AbstractEnumeration;

class CustomEnumMasks extends AbstractEnumeration
{
    /** @var string POSTAL_CODE Mask Brazilian postcode. / Máscara para código postal(CEP) Brasileiro. */
    const POSTAL_CODE = '#####-###';

    /** @var string PHONE_NUMBER Mask for 10-digit phone with area code. /
     *                           Máscara para telefone de 10 dígitos junto com código de região.
     */
    const PHONE_NUMBER_10 = '(##) ####-####';

    /** @var string PHONE_NUMBER Mask for 11-digit phone with area code. /
     *                           Máscara para telefone de 10 dígitos junto com código de região.
     */
    const PHONE_NUMBER_11 = '(##) ####-#####';
}

注意：掩码应扩展 'Eloquent\Enumeration\AbstractEnumeration' 并遵循 '\Masknizzer\EnumMasks' 中定义的掩码模式。

注意：自定义掩码应扩展 'Eloquent\Enumeration\AbstractEnumeration'，并且常量应遵循 '\Masknizzer\EnumMasks' 中的模式。

####2 - 构建对象类型掩码（Construindo um objeto do tipo das máscaras）

use Masknizzer\EnumMasks;
use Masknizzer\MaskFactory;

$maskFieldPostalCode = MaskFactory::factory(EnumMasks::POSTAL_CODE(), 12345678);

或者将枚举数组作为第一个参数传递，函数本身将根据第二个参数中传递的字段字符数来决定使用哪个掩码。

或者将枚举列表作为工厂的第一个参数传递，类本身将根据第二个参数中传递的字段字符数来决定使用哪个掩码。

$maskGroupPhoneNumber = [
    EnumMasks::PHONE_NUMBER_10(),
    EnumMasks::PHONE_NUMBER_11()
];

$maskFieldPhoneNumbers = MaskFactory::factory($maskGroupPhoneNumber, 51123456789);

###3 - 处理字段中的掩码（Processando a máscara no campo）

$maskedField = $maskFieldPostalCode->mask();

在示例中，结果为（No exemplo o resultado será）：12345-678