API Documentation
Table of Contents
Functions
- validaCPF() : bool
- Valida um número de CPF através do algoritmo de dígitos verificadores
- env() : mixed
- Retorna variavel de ambiente ou valor padrao
- csrf_token() : string
- Gera ou retorna o token CSRF atual da sessão
- csrf_field() : string
- Gera um campo HTML oculto com o token CSRF
- csrf_validate() : bool
- Valida se o token CSRF enviado via POST é válido
- flash() : void
- Define uma mensagem flash na sessão
- get_flash() : string|null
- Recupera e remove uma mensagem flash da sessão
- app_base_path() : string
- Determina o caminho base da aplicação
- app_url() : string
- Gera uma URL relativa da aplicação
- app_absolute_url() : string
- Gera uma URL absoluta da aplicação
- auth_check() : void
- Verifica se o usuário está autenticado, redirecionando para login se não estiver
- admin_check() : void
- Verifica se o usuário é administrador, redirecionando para login se não for
- redirect() : void
- Redireciona o usuário para a URL especificada e encerra a execução
- resumo_home() : string
- Cria um resumo do texto para exibição na página inicial
- resumo_curso() : string
- Cria um resumo truncado de um texto para exibição em cards de curso
- split_lines() : array<string|int, mixed>
- Divide um texto em linhas não vazias
- resumo_vaga() : string
- Gera um resumo truncado do texto da vaga
Functions
validaCPF()
Valida um número de CPF através do algoritmo de dígitos verificadores
validaCPF(string $cpf) : bool
Parameters
- $cpf : string
-
Número do CPF com 11 dígitos
Return values
bool —Retorna true se o CPF for válido, false caso contrário
env()
Retorna variavel de ambiente ou valor padrao
env(string $key[, mixed $default = null ]) : mixed
Parameters
- $key : string
-
A chave da variável de ambiente a ser recuperada
- $default : mixed = null
-
O valor padrão a ser retornado caso a variável não exista
Return values
mixed —O valor da variável de ambiente ou o valor padrão
csrf_token()
Gera ou retorna o token CSRF atual da sessão
csrf_token() : string
Return values
string —O token CSRF em formato hexadecimal
csrf_field()
Gera um campo HTML oculto com o token CSRF
csrf_field() : string
Return values
string —Campo input hidden com o token CSRF
csrf_validate()
Valida se o token CSRF enviado via POST é válido
csrf_validate() : bool
Return values
bool —True se o token for válido, false caso contrário
flash()
Define uma mensagem flash na sessão
flash(string $type, string $msg) : void
Parameters
- $type : string
-
Tipo da mensagem (success, error, info, etc)
- $msg : string
-
Conteúdo da mensagem
get_flash()
Recupera e remove uma mensagem flash da sessão
get_flash(string $type) : string|null
Parameters
- $type : string
-
Tipo da mensagem a ser recuperada
Return values
string|null —A mensagem flash ou null se não existir
app_base_path()
Determina o caminho base da aplicação
app_base_path() : string
Return values
string —O caminho base da aplicação sem barra final
app_url()
Gera uma URL relativa da aplicação
app_url([string $path = '' ]) : string
Parameters
- $path : string = ''
-
Caminho a ser adicionado à URL base
Return values
string —A URL completa relativa
app_absolute_url()
Gera uma URL absoluta da aplicação
app_absolute_url([string $path = '' ]) : string
Parameters
- $path : string = ''
-
Caminho a ser adicionado à URL base
Return values
string —A URL completa absoluta com protocolo e domínio
auth_check()
Verifica se o usuário está autenticado, redirecionando para login se não estiver
auth_check() : void
admin_check()
Verifica se o usuário é administrador, redirecionando para login se não for
admin_check() : void
redirect()
Redireciona o usuário para a URL especificada e encerra a execução
redirect(string $url) : void
Parameters
- $url : string
-
A URL de destino do redirecionamento
resumo_home()
Cria um resumo do texto para exibição na página inicial
resumo_home(string $texto[, int $limite = 110 ]) : string
Remove tags HTML, limita o tamanho do texto e adiciona reticências quando necessário. Utiliza funções multibyte quando disponíveis.
Parameters
- $texto : string
-
O texto original a ser resumido
- $limite : int = 110
-
O número máximo de caracteres do resumo (padrão: 110)
Return values
string —O texto resumido com ou sem reticências
resumo_curso()
Cria um resumo truncado de um texto para exibição em cards de curso
resumo_curso(string $texto[, int $limite = 135 ]) : string
Remove tags HTML, limita o comprimento do texto e adiciona reticências quando necessário. Utiliza funções multibyte quando disponíveis.
Parameters
- $texto : string
-
O texto original a ser resumido
- $limite : int = 135
-
Número máximo de caracteres para o resumo (padrão: 135)
Return values
string —O texto resumido com reticências se truncado, ou mensagem padrão se vazio
split_lines()
Divide um texto em linhas não vazias
split_lines(string $text) : array<string|int, mixed>
Parameters
- $text : string
-
O texto a ser dividido
Return values
array<string|int, mixed> —Array com as linhas não vazias após remoção de espaços
resumo_vaga()
Gera um resumo truncado do texto da vaga
resumo_vaga(string $texto[, int $limite = 125 ]) : string
Remove tags HTML e limita o texto ao número de caracteres especificado, adicionando reticências quando necessário. Suporta multibyte strings.
Parameters
- $texto : string
-
O texto completo a ser resumido
- $limite : int = 125
-
O número máximo de caracteres no resumo
Return values
string —O texto resumido com ou sem reticências