README

A minimalist PHP framework for building REST APIs and web applications.

Features

🚀 Lightweight and fast
🎯 REST API focused
🔌 Dynamic helpers
🛣️ Simple routing system
🔒 Built-in security
📝 Automatic logging
💾 Simple caching
🗄️ Storage management
🔑 Sessions and cookies
🌐 Virtual hosts support
🔄 External API integration
🛡️ Authentication helpers
✨ Input validation
📦 Database support (via Medoo)
📧 Mailer support (via PHPMailer)

Installation

composer require jdanielcmedina/lapa

Quick Start

require 'vendor/autoload.php';
$app = new Lapa\Lapa();

// Basic route
$app->on('GET /', function() {
    return ['message' => 'Hello World!'];
});

// Protected route
$app->on('GET /protected', function() {
    if (!$this->requireAuth()) {
        return;
    }
    return ['data' => 'protected content'];
});

// REST API example
$app->on('POST /users', function() {
    $data = $this->validate([
        'name' => 'required|min:3',
        'email' => 'required|email'
    ]);
    
    if (!$data) return; // Validation failed
    
    return $this->success($data, 'User created');
});

Documentation

Request Handling

// GET parameters
$query = $this->get('search');           // Single parameter
$allGet = $this->get();                  // All GET parameters

// POST data
$name = $this->post('name');             // Single field
$allPost = $this->post();                // All POST data

// Combined request data
$all = $this->request();                 // All request data
$specific = $this->request('field');     // Specific field

// JSON body
$json = $this->body();                   // Full body
$field = $this->body('field');           // Specific field

Response Methods

// Success responses
return $this->success($data);                    // 200 OK
return $this->success($data, 'Created', 201);    // 201 Created

// Error responses
return $this->error('Invalid input', 400);       // 400 Bad Request
return $this->error('Unauthorized', 401);        // 401 Unauthorized

// Custom responses
return $this->response($data, 'json');           // JSON
return $this->response($html, 'html');           // HTML
return $this->response($text, 'text');           // Plain text
return $this->response($xml, 'xml');             // XML

Authentication & Protection

// Protect routes
$app->on('GET /api/data', function() {
    if (!$this->requireAuth()) {
        return;
    }
    return ['data' => 'protected'];
});

// Admin routes
$app->on('GET /admin', function() {
    if (!$this->requireAdmin()) {
        return;
    }
    return ['admin' => 'dashboard'];
});

Data Validation

$validated = $this->validate([
    'name' => 'required|min:3',
    'email' => 'required|email',
    'age' => 'numeric|min:18',
    'role' => 'in:user,admin'
]);

Database Operations

// Select
$users = $this->db->select('users', '*');

// Insert
$id = $this->db->insert('users', [
    'name' => 'John',
    'email' => 'john@example.com'
]);

// Update
$this->db->update('users',
    ['status' => 'active'],
    ['id' => 1]
);

// Delete
$this->db->delete('users', ['id' => 1]);

File Management

// Upload
$filename = $this->upload('photo');

// Download
$this->download('file.pdf', 'custom-name.pdf');

// Storage
$path = $this->storage('public');    // Get storage path
$this->clear('cache');               // Clear storage

External API Integration

// GET request
$data = $this->import('https://api.example.com/data', [
    'headers' => ['Authorization' => 'Bearer ' . $token]
]);

// POST request
$result = $this->import('https://api.example.com/users', [
    'method' => 'POST',
    'data' => ['name' => 'John'],
    'headers' => ['X-API-Key' => 'key']
]);

Session & Cookies

// Sessions
$this->session('user_id', 123);          // Set
$id = $this->session('user_id');         // Get
$this->session('user_id', false);        // Remove

// Cookies
$this->cookie('theme', 'dark', [         // Set with options
    'expire' => time() + 86400,
    'secure' => true
]);
$theme = $this->cookie('theme');         // Get
$this->cookie('theme', false);           // Remove

Configuration

Create storage/app/config.php:

return [
    'debug' => true,
    'timezone' => 'UTC',
    
    'db' => [
        'type' => 'mysql',
        'host' => 'localhost',
        'database' => 'db_name',
        'username' => 'user',
        'password' => 'pass'
    ],
    
    'mail' => [
        'host' => 'smtp.example.com',
        'port' => 587,
        'username' => 'user@example.com',
        'password' => 'password'
    ]
];

Directory Structure

lapa/
├── routes/
│   ├── web.php
│   └── api.php
├── storage/
│   ├── app/           # Private storage by default
│   ├── cache/
│   ├── logs/
│   └── uploads/       # Public files
└── src/
    ├── Lapa.php
    └── helpers.php

Views

Estrutura de Views

O Lapa Framework possui um sistema modular de views, incluindo suporte a partials (componentes reutilizáveis).

Estrutura recomendada:

views/
├── partials/          # Componentes reutilizáveis
│   ├── header.php     # Cabeçalho do site
│   ├── footer.php     # Rodapé do site
│   ├── sidebar.php    # Barra lateral
│   └── nav.php        # Menu de navegação
├── layouts/           # Layouts base
│   └── default.php    # Layout padrão
└── pages/            # Páginas do site
    ├── home.php
    └── about.php

Usando Partials

Os partials são pequenos componentes reutilizáveis que podem ser incluídos em qualquer view:

<!-- views/layouts/default.php -->
<!DOCTYPE html>
<html>
<head>
    <title><?= $title ?></title>
</head>
<body>
    <?php $this->partial('header', ['title' => $title]) ?>
    
    <div class="container">
        <?php $this->partial('nav') ?>
        
        <main>
            <?= $content ?>
        </main>
        
        <?php $this->partial('sidebar', ['user' => $user]) ?>
    </div>
    
    <?php $this->partial('footer') ?>
</body>
</html>

<!-- views/pages/home.php -->
<?php $this->partial('header', ['title' => 'Home']) ?>

<div class="content">
    <h1>Bem-vindo!</h1>
    <p>Conteúdo da página...</p>
</div>

<?php $this->partial('footer') ?>

Passando Dados para Partials

Cada partial pode receber seus próprios dados:

// Na rota
$app->view('pages/home', [
    'title' => 'Home Page',
    'user' => $user
]);

// No partial
$this->partial('header', [
    'title' => $title,
    'showMenu' => true
]);

$this->partial('sidebar', [
    'user' => $user,
    'menuItems' => $items
]);

Estrutura de Partials

Os partials devem estar na pasta views/partials/ e podem ser organizados em subpastas:

<!-- views/partials/header.php -->
<header>
    <h1><?= $title ?></h1>
    <?php if ($showMenu ?? false): ?>
        <?php $this->partial('nav/main') ?>
    <?php endif ?>
</header>

<!-- views/partials/nav/main.php -->
<nav>
    <ul>
        <li><a href="/">Home</a></li>
        <li><a href="/about">About</a></li>
    </ul>
</nav>

Características dos Partials

Organização modular do código
Reutilização de componentes
Escopo isolado de variáveis
Suporte a subdiretórios
Passagem de dados específicos
Aninhamento de partials

Requirements

PHP 7.4+
Composer
PHP Extensions:
- JSON
- PDO (optional)
- Fileinfo

Changelog

Version 1.5.0

Removed middleware complexity in favor of helpers
Improved authentication system
Added import() method for external API integration
Enhanced request/response handling
Added more test coverage
Code cleanup and optimization
Updated documentation

License

MIT License - see the LICENSE file for details.

Contributing

Fork the project
Create your feature branch (git checkout -b feature/AmazingFeature)
Commit your changes (git commit -m 'Add some AmazingFeature')
Push to the branch (git push origin feature/AmazingFeature)
Open a Pull Request

Author

Daniel Medina - @jdanielcmedina

jdanielcmedina / lapa

Maintainers

Details