Documentação BPHP

Introdução

BPHP 4 é uma biblioteca PHP que fornece um conjunto de funções úteis para operações comuns de banco de dados e outras utilidades. Esta documentação explica como utilizar cada função da biblioteca.

Conexão com o Banco de Dados

Antes de utilizar as funções, é necessário estabelecer uma conexão com o banco de dados.

Insira os dados de conexão no arquivo src/config.php

Funções de Debug

Bdebug

Imprime o conteúdo de uma variável em um formato legível.

Parâmetros:

$data (mixed): A variável a ser impressa.

Exemplo de Uso:

$data = ['nome' => 'João', 'idade' => 24];
Bdebug($data);

Funções CRUD

Binsert

Insere dados em uma tabela.

Parâmetros:

$table (string): O nome da tabela.
$data (array): Um array associativo com os dados a serem inseridos (coluna => valor).

Exemplo de Uso:

$data = ['nome' => 'João', 'idade' => 25];
Binsert('clientes', $data);

Bselect

Seleciona dados de uma tabela com suporte para condições e ordenação opcional.

Parâmetros:

$table (string): O nome da tabela.
$conditions (array, opcional): Um array associativo com as condições (coluna => valor).
$columns (array, opcional): Um array com os nomes das colunas a serem selecionadas (padrão: ['*']).
$orderBy (string, opcional): A coluna e a direção para ordenar os resultados (ex: 'nome ASC').

Exemplo de Uso:

// Seleciona todos os dados
$data = Bselect('clientes');

// Seleciona dados com condições
$data = Bselect('clientes', ['id' => 1], ['nome', 'idade']);

// Seleciona dados com ordenação
$data = Bselect('clientes', [], ['*'], 'nome ASC');

// Seleciona dados com condições e ordenação
$data = Bselect('clientes', ['status' => 'ativo'], ['id', 'nome'], 'nome DESC');

Bupdate

Atualiza dados em uma tabela.

Parâmetros:

$table (string): O nome da tabela.
$data (array): Um array associativo com os dados a serem atualizados (coluna => valor).
$conditions (array): Um array associativo com as condições (coluna => valor).

Exemplo de Uso:

$data = ['idade' => 26];
$conditions = ['id' => 1];
Bupdate('clientes', $data, $conditions);

Bdelete

Deleta dados de uma tabela.

Parâmetros:

$table (string): O nome da tabela.
$conditions (array): Um array associativo com as condições (coluna => valor).

Exemplo de Uso:

$conditions = ['id' => 1];
Bdelete('clientes', $conditions);

Bquery

Executa uma query SQL completa e retorna os resultados.

Parâmetros:

$sql (string): A query SQL completa a ser executada.

Retorno:

(array): Um array associativo com os resultados da query.

Exemplo de Uso:

// Executa uma query selecionando todos os dados
    $data = Bquery("SELECT * FROM clientes");
    Bdebug($data);
    
    // Executa uma query com condições
    $data = Bquery("SELECT id, nome FROM clientes WHERE status = 'ativo' ORDER BY nome ASC");
    Bdebug($data);

BjsonToHtml

Converte um JSON válido em uma estrutura HTML formatada, exibindo os dados de forma organizada em listas.

Descrição

Esta função decodifica uma string JSON em um array ou objeto PHP e gera uma representação HTML bem formatada, ideal para exibição de dados em páginas web. O HTML gerado inclui listas não ordenadas (<ul>) para estruturas hierárquicas e faz a sanitização dos dados para prevenir problemas de segurança (como ataques XSS).

Parâmetros

$json (string): A string JSON a ser convertida em HTML.

Retorno

(string): Uma string contendo a representação HTML dos dados. Se o JSON for inválido, retorna uma mensagem de erro em HTML.

Exemplo de Uso

// JSON de exemplo
    $json = '{
        "nome": "João",
        "idade": 30,
        "endereço": {
            "cidade": "São Paulo",
            "estado": "SP"
        },
        "ativo": true,
        "tags": ["PHP", "JSON", "HTML"]
    }';
    
    // Converte o JSON para HTML
    $html = BjsonToHtml($json);
    
    // Exibe o HTML
    echo $html;

Exemplo de Saída

Para o JSON acima, a função gerará o seguinte HTML:

<div style="font-family: Arial, sans-serif; line-height: 1.6;">
        <ul>
            <li><strong>nome:</strong> João</li>
            <li><strong>idade:</strong> 30</li>
            <li><strong>endereço:</strong> 
                <ul>
                    <li><strong>cidade:</strong> São Paulo</li>
                    <li><strong>estado:</strong> SP</li>
                </ul>
            </li>
            <li><strong>ativo:</strong> true</li>
            <li><strong>tags:</strong> 
                <ul>
                    <li>PHP</li>
                    <li>JSON</li>
                    <li>HTML</li>
                </ul>
            </li>
        </ul>
    </div>

Erros Possíveis

Se o JSON fornecido for inválido, a função retornará uma mensagem de erro no seguinte formato:

<p>[BPHP] JSON inválido: </p>

Por exemplo:

<p>[BPHP] JSON inválido: Syntax error</p>

Notas de Implementação

A função utiliza json_decode para transformar o JSON em array associativo e verifica erros usando json_last_error.
Os dados são convertidos em HTML usando listas (<ul> e <li>) recursivamente, preservando a hierarquia do JSON.
Sanitização é feita com htmlspecialchars para evitar a injeção de código malicioso.

Outras Funções

Balerta

Exibe uma mensagem de alerta em JavaScript.

Parâmetros:

$msg (string): A mensagem a ser exibida.

Exemplo de Uso:

Balerta('Operação realizada com sucesso!');

Bconfirm

Exibe uma mensagem de confirmação em JavaScript.

Parâmetros:

$msg (string): A mensagem a ser exibida.

Exemplo de Uso:

Bconfirm('Tem certeza que deseja continuar?');

Bcontdiasuteis

Calcula a quantidade de dias úteis entre duas datas.

Parâmetros:

$timestampInicial (int): Timestamp da data inicial.
$timestampFinal (int, opcional): Timestamp da data final (padrão: time()).
$feriados (array, opcional): Array de timestamps dos feriados.

Exemplo de Uso:

$uteis = Bcontdiasuteis(strtotime('2023-01-01'), strtotime('2023-01-31'));

Bdatabr2datamysql

Converte uma data no formato brasileiro (dd/mm/aaaa) para o formato MySQL (aaaa-mm-dd).

Parâmetros:

$databr (string): A data no formato brasileiro.

Exemplo de Uso:

$data_mysql = Bdatabr2datamysql('31/12/2023');

Beditor

Inicializa o editor TinyMCE para um textarea com o ID beditor.

Exemplo de Uso:

Beditor();

Bgeracodbarras

Gera um código de barras a partir de uma string.

Parâmetros:

$string (string): A string a ser convertida em código de barras.

Exemplo de Uso:

Bgeracodbarras('1234567890');

Bhash

Gera um hash SHA-1 duplo seguido de MD5 de uma string.

Parâmetros:

$string (string): A string a ser hasheada.

Exemplo de Uso:

$hash = Bhash('minhasenha');

Blinkvoltar

Salva o histórico de navegação em sessões para possibilitar navegação de volta.

Exemplo de Uso:

Blinkvoltar();

Bmostraerros

Ativa a exibição de erros no PHP.

Exemplo de Uso:

Bmostraerros();

Bprocpalavras

Procura palavras específicas dentro de uma frase e retorna um resultado com base na presença dessas palavras.

Parâmetros:

$frase (string): A frase onde as palavras serão procuradas.
$palavras (array): Um array de palavras a serem procuradas na frase.
$resultado (int, opcional): O valor padrão a ser retornado se nenhuma palavra for encontrada (padrão: 0).

Retorno:

(int): Retorna 1 se pelo menos uma das palavras for encontrada na frase, caso contrário, retorna o valor do parâmetro $resultado (padrão: 0).

Exemplo de Uso:

$frase = "Esta é uma frase de exemplo.";
        $palavras = ["exemplo", "teste"];
        $resultado = Bprocpalavras($frase, $palavras);
        echo $resultado;  // Saída: 1

Bpeganumeros

Extrai apenas os números de uma string.

Parâmetros:

$str (string): A string a ser processada.

Exemplo de Uso:

$numeros = Bpeganumeros('Rua 123, Nº 456');

Brand

Retorna um item aleatório de uma lista de cinco itens.

Parâmetros:

$item1 (mixed): Primeiro item.
$item2 (mixed): Segundo item.
$item3 (mixed): Terceiro item.
$item4 (mixed): Quarto item.
$item5 (mixed): Quinto item.

Exemplo de Uso:

$aleatorio = Brand('a', 'b', 'c', 'd', 'e');

Bredirecionamentojs

Redireciona para uma URL usando JavaScript.

Parâmetros:

$link (string|int): A URL para redirecionar ou -1 para voltar.

Exemplo de Uso:

Bredirecionamentojs('http://www.exemplo.com');

Bseg

Sanitiza uma string para evitar caracteres especiais.

Parâmetros:

$string (string): A string a ser sanitizada.

Exemplo de Uso:

$seguro = Bseg("string; com 'caracteres' especiais");

Bsetpreco

Converte vírgulas em pontos em uma string de preço.

Parâmetros:

$valor (string): O valor a ser convertido.

Exemplo de Uso:

$preco = Bsetpreco('1,99');

Btoken

Gera um token aleatório.

Exemplo de Uso:

$token = Btoken();

Bvalidacnpj

Valida um CNPJ.

Parâmetros:

$cnpj (string): O CNPJ a ser validado.

Exemplo de Uso:

$valido = Bvalidacnpj('12345678000195');

Bvalidacpf

Valida um CPF.

Parâmetros:

$cpf (string): O CPF a ser validado.

Exemplo de Uso:

$valido = Bvalidacpf('12345678909');

Bverificaurl

Verifica se uma URL é válida e está acessível.

Parâmetros:

$link (string): A URL a ser verificada.

Exemplo de Uso:

$valido = Bverificaurl('http://www.exemplo.com');

Esta documentação cobre as funções essenciais da biblioteca BPHP. Use os exemplos fornecidos para integrar as funções em seus projetos e consulte esta documentação conforme necessário. Se houver dúvidas ou problemas, consulte a fonte oficial ou entre em contato com o desenvolvedor responsável.

Controle de Versões

O BPHP utiliza o seguinte padrão para o controle de suas versões:

X.Y.Z

X - Representa a versão do framework, que pode ser alterada se implantadas grandes alterações que impactam inclusive o funcionamento de versões anteriores, bem como incremento de alto volume de novas funcionalidades.
Y – Representa a versão de atualização da versão X do BPHP, que pode ser alterada quando é implementada alguma mudança ou incremento no framework que não impacta diretamente o funcionamento de versões anteriores.
Z – Representa a versão de correção da Versão Y de atualização, que pode ser alterada quando é implementada alguma correção de bug sem novos incrementos de funcionalidades.

Licença de uso

Mozilla Public License 2.0 (MPL-2.0)

http://opensource.org/licenses/MPL-2.0