📚 DOCUMENTAÇÃO PROFISSIONAL HTML

👉 Clique aqui para ver a documentação completa e interativa

Ou acesse a página de índice para navegar por todas as documentações.

🚨 Aviso Importante: Não recomendo o uso desse MVC em projetos grandes, apenas para estudos ou em projetos de pequeno a médio porte.

📝 Licença

Este projeto está licenciado sob a Licença MIT. Sinta-se à vontade para usar, estudar e até contribuir.

💪 Contribuições

Se você tem sugestões de melhorias ou correções, fique à vontade para abrir uma issue ou enviar um pull request.

🔮 Funcionalidades Futuras

• [✅] Middleware
• [✅] Validação de formulários
• [✅] Autenticação e Gerenciamento de Sessões
• [❌] Suporte a migrações de banco de dados

🆙 Como Baixar e Usar

Última versão: v1.0-beta

Para obter a última versão estável, execute o seguinte comando no seu terminal:

git clone --branch v1.0-beta git@github.com:MaquitoGW/mvc_model.git

Se preferir baixar para estudos ou obter a versão mais recente, use:

git clone https://github.com/MaquitoGW/mvc_model.git

Documentação do MVC Model

Esta documentação fornece uma explicação detalhada de como configurar rotas, controladores, grupos de rotas, manipulação de arquivos e banco de dados, e como utilizar o padrão MVC em seu projeto.

Índice

• Instruções de Configuração do Projeto
• Como Criar uma Rota
• Grupos de Rotas
• Controladores e Classes Úteis
• Manipulação de Arquivos
• Personalização de Páginas de Erro
• Exibindo Páginas (Views)
• Manipulação de Banco de Dados (SQL)
• Classe Request

Instruções de Configuração do Projeto

1. Configuração do Ambiente

Abra o arquivo .env na raiz do seu projeto e configure as variáveis do banco de dados, URL e modo:

# URL do Site
URL="http://localhost/"

# Modo da Aplicação (Dev ou Production)
MODE=Dev

# Banco de Dados
DB=mysql
DB_HOST=localhost
DB_NAME=mvc
DB_USER=root
DB_PASS=

# Debug
DEBUG=true

Configuração do Modo:

# Modo Dev - Desenvolvimento
MODE=Dev
# - Exibe erros e exceções
# - Ativa debug (dd, dump, logView, cutErr)
# - Mostra stack trace detalhado

# Modo Production - Produção
MODE=Production
# - Oculta erros do usuário
# - Registra erros em storage/logs/php_errors.log
# - Desativa debug

Antes de rodar o projeto, instale as dependências:

composer install

2. Estrutura de Arquivos Estáticos

Coloque todos os seus arquivos estáticos (CSS, JavaScript, imagens, fontes, etc.) na pasta public/.
A pasta public/ é onde o servidor vai procurar os arquivos acessíveis ao público, como a página inicial e arquivos de estilo.

3. Instruções de Uso

Após configurar o .env e rodar o Composer, o projeto estará pronto para uso. Aqui estão as etapas principais:

• Configuração do banco de dados: Certifique-se de que o banco de dados especificado no arquivo .env está criado e configurado corretamente.

• Acessando o projeto: Para rodar o projeto, basta acessar a URL configurada no .env (por exemplo, http://localhost).

🚨 Nota: Agora, seu projeto deve estar pronto para uso, e você pode começar a desenvolver e personalizar conforme necessário!

Como Criar uma Rota?

1. Abra o arquivo routes/web.php para definir suas rotas.

2. Use a classe Routes para configurar as rotas:

   use lib\Routes;
   $route = new Routes();
   

3. Defina suas rotas com os métodos get e post:

   • GET: Para leitura de dados.
   • POST: Para enviar dados.

   Exemplos de rotas:

   $route->get("home", [Site::class, "index"], true);
   $route->post("form", [FormController::class, "submit"], true);
   

4. Para nomear as rotas, você pode fazer o seguinte:

   $route->post("submit", [FormController::class, "submit"], true)->name("form.submit");
   

5. Finalize sua configuração de rotas com o método exit():

   $route->exit();
   

Grupos de Rotas

Para agrupar rotas que compartilham o mesmo prefixo, utilize o seguinte formato:

1. Defina o prefixo e agrupe as rotas:

   $route->prefix("admin")->group(function ($e) {
       $e->get("dashboard", [AdminController::class, "dashboard"]);
       $e->post("login", [AuthController::class, "login"]);
   });
   

2. O prefixo define um caminho comum para todas as rotas dentro do grupo (por exemplo, "admin/dashboard").

Controladores e Classes Úteis

Estrutura de um Controlador

Os controladores devem ser criados na pasta Controllers e seguir esta estrutura:

namespace Controllers;

class NomeDoControlador extends App {
    public function index() {
        // Código do método
    }
}

Classe Response

A classe Response oferece métodos úteis para redirecionamento, navegação, e exibição de mensagens.

Métodos:

• redirect($url): Redireciona para uma URL.
• back(): Retorna à página anterior após um redirecionamento.
• message($name, $value): Define uma mensagem de sessão.
• getMessage($name): Obtém uma mensagem da sessão.
• abort($code, $message = null): Exibe uma página de erro com um código HTTP.
• attribute($name): Obtém o valor de um parâmetro na URL.

Exemplo de uso:

Response::message('success', 'Operação bem-sucedida!')->redirect('/home');

Manipulação de Arquivos

A classe File permite manipulação de arquivos e diretórios na pasta storage.

Métodos da Classe File

• isDir($dir): Verifica se um diretório existe. Use get() para retornar o resultado.
• isFile($file): Verifica se um arquivo existe.
• rename($newName): Renomeia um arquivo ou diretório.
• delete(): Deleta um arquivo ou diretório.
• permissions($mode): Altera as permissões de um arquivo/diretório.
• save($file, $path = ''): Salva um arquivo no diretório especificado.
• readFile(): Lê um arquivo.

Exemplos:

File::isDir("meuDiretorio", true)->get(); // Cria diretório se não existir
File::isFile("imagem.png")->delete()->get(); // Deleta arquivo

Personalização de Páginas de Erro

Para personalizar as páginas de erro, edite o arquivo views/err.php. Um exemplo básico para exibir uma página de erro 404:

Response::abort(404, 'Página não encontrada');

Exibindo Páginas (Views)

Para retornar uma view dentro do controlador, utilize o método view da classe Response:

return Response::view("nome-da-view", ['variavel' => $valor]);

Estrutura de Arquivos de View

• As views devem estar na pasta views/.

• Você pode organizar as views em subpastas e referenciá-las usando o ponto (.) para acessar:

  Response::view("pasta.nome-da-view", ['variavel' => $valor]);
  

Exemplo de view:

<h1>Bem-vindo, <?= $variavel ?></h1>

Manipulação de Banco de Dados (SQL)

Conexão com o Banco de Dados

A classe sql gerencia a conexão e manipulação de dados no banco. A conexão é configurada com as credenciais no arquivo .env.

Exemplos de Uso:

• Inserir dados:

  sql::INSERT("users")->add(['name' => 'John', 'email' => 'john@example.com'])->execute();
  

• Selecionar dados:

  $user = sql::SELECT("users")->where("id", 1)->get();
  

• Atualizar dados:

  sql::UPDATE("users")->set(['name' => 'Jane'])->where("id", 1)->execute();
  

• Deletar dados:

  sql::DELETE("users")->where("id", 1)->execute();
  

Classe Request

A classe Request facilita o acesso aos dados das requisições HTTP. Use-a para acessar os dados das superglobais $_POST, $_GET, $_FILES e $_SERVER.

Métodos:

• input($name): Retorna o valor de um campo $_POST.
• query($name): Retorna o valor de um parâmetro $_GET.
• files($name): Retorna os arquivos enviados através de $_FILES.
• header($name): Retorna o valor de um cabeçalho HTTP.

Exemplo de uso:

$request = new Request();

// Acessando POST
$username = $request->input('username');

// Acessando GET
$searchQuery = $request->query('search');

// Acessando arquivos
$file = $request->files('upload');

// Acessando cabeçalho
$userAgent = $request->header('user-agent');

Sistema de Debug com Estilo

Sistema de debug similar ao Laravel com exibição visual atraente. As funções de debug funcionam apenas quando DEBUG=true está configurado no arquivo .env.

Configuração

# .env
DEBUG=true   # Habilita debug
DEBUG=false  # Desabilita debug

Funções de Debug

dd(...$vars)

Exibe variáveis com estilo e interrompe a execução.

dd($usuario, $dados); // Exibe e para tudo

dump(...$vars)

Exibe variáveis com estilo sem interromper a execução.

dump($usuario, $dados); // Exibe e continua

logView($data, $label = 'INFO')

Armazena informações em log no arquivo storage/logs/debug.log. Útil para registrar dados durante a execução.

logView($usuario, 'USER_INFO'); // Registra em storage/logs/debug.log
logView(['status' => 'ok'], 'PROCESS');

cutErr($callback, $logError = false)

Captura erros com try-catch. Exibe o erro na tela ou registra em log conforme o parâmetro.

Parâmetros:

• $callback: Função a ser executada
• $logError: false = exibe na tela (padrão), true = salva em storage/logs/errors.log

// Exibir erro na tela
cutErr(function() {
    $resultado = sql::SELECT("usuarios")->where("id", 999)->first();
    echo "ID do usuário: " . $resultado['id'];
});

// Registrar erro em log
cutErr(function() {
    $arquivo = fopen('arquivo_inexistente.txt', 'r');
}, true); // Erro será salvo em storage/logs/errors.log

Exemplo com autenticação:

cutErr(function() {
    $usuario = sql::SELECT("usuarios")->where("email", $_POST['email'])->first();
    
    if (!$usuario || !password_verify($_POST['senha'], $usuario['password'])) {
        throw new E