SGEProduto · Domínio · Desenvolvimento
Repositório

technical-reference · implemented

Helper — Funções globais

Funções globais carregadas pelo Composer que delegam a helpers de domínio.

Como são carregadas

O arquivo é registrado em composer.json no autoload files, portanto as funções ficam disponíveis sem use após o autoload do Composer. Cada função verifica function_exists() antes de declarar e delega para uma classe final em App\Helpers.

FunçãoDelegação
formatDate()DateHelper::format()
formatShort()DateHelper::formatShort()
formatDateTime()DateHelper::formatDateTime()
formatRelative()DateHelper::formatRelative()
formatMonthYear()DateHelper::formatMonthYear()
formatMonthYearFull()DateHelper::formatMonthYearFull()
formatCurrency()CurrencyHelper::format()
numberToWords()NumberToWordsHelper::cardinal()
brlToWords()NumberToWordsHelper::brl()
unmask()DigitsHelper::only()
formatCpf()BrazilianDocumentHelper::formatCpf()
formatCnpj()BrazilianDocumentHelper::formatCnpj()
formatCpfCnpj()BrazilianDocumentHelper::formatCpfCnpj()
formatPhone()BrazilianContactHelper::formatPhone()
formatCep()BrazilianAddressHelper::formatCep()

Regra de uso

  • Use funções globais em Blade/Livewire quando a chamada ficar mais legível.
  • Use classes diretamente em PHP de domínio, testes ou quando a origem da regra precisar ser explícita.
  • Não adicionar regra nova somente na função global; implemente na classe e delegue.
  • Não usar helpers para autorização, consulta ao banco, mutação ou efeitos colaterais.

Checklist

  • Registrar o arquivo no autoload do Composer.
  • Criar guardas function_exists().
  • Manter delegação um-para-um para as classes de helper.
  • Expor numberToWords() e brlToWords() como fachada do NumberToWordsHelper.
  • Criar teste de contrato para cada função global; numberToWords() e brlToWords() já são cobertos em NumberToWordsHelperTest.
  • Documentar colisões de nomes com pacotes/framework antes de adicionar função.
  • Executar composer dump-autoload após criar/renomear função.
  • Atualizar Helpers ao alterar o catálogo.

Relacionamentos