MVC Framework

Quick Start

# Database (optional)
host=localhost
dbname=your_database
dbuser=root
dbpass=

# Application
APP_ENV=development
BASE_PATH=
MAINTENANCE_MODE=false

composer install

Project Structure

Creating a Controller

Create a new controller in app/Controllers/:

<?php
namespace App\Controllers;

use App\Core\Controller;

class MyController extends Controller
{
    public function index()
    {
        $this->loadPageTranslations('mypage');
        
        $this->data += [
            'viewName' => 'pages/mypage.html.twig',
            'page' => [
                'titulo' => 'My Page',
                'description' => 'Page description',
                'keywords' => 'keywords'
            ],
            'customData' => 'Your custom data here'
        ];
        
        echo $GLOBALS['twig']->render('templates/mainTemplate.html.twig', $this->data);
    }
}

Creating Routes

Add routes in routes.php:

// Simple route
$router->get('/', 'App\Controllers\HomeController@index');

// Route with parameter
$router->get('/user/{id}', 'App\Controllers\UserController@show');

// POST route
$router->post('/submit', 'App\Controllers\FormController@submit');

Creating Views

Create Twig templates in app/Views/pages/:

<div class="container mt-5">
    <h1>Framework Demo & Documentation</h1>
    <p>Learn how to use the MVC Framework</p>
    
        
    <p>Base URL: https://omeupredio.com/</p>
</div>

Using Translations

The framework includes a built-in translation system using JSON metafiles. Here's how to use it:

{
  "titulo": "Minha Página",
  "description": "Descrição da página",
  "keywords": "palavras, chave",
  "t": {
    "welcome": "Bem-vindo",
    "title": "Título da Página",
    "button_save": "Guardar"
  }
}

<?php
namespace App\Controllers;

use App\Core\Controller;

class MyController extends Controller
{
    public function index()
    {
        // Load page-specific translations
        $this->loadPageTranslations('mypage');
        
        $this->data += [
            'viewName' => 'pages/mypage.html.twig',
            'page' => [
                'titulo' => 'My Page'
            ]
        ];
        
        echo $GLOBALS['twig']->render(
            'templates/mainTemplate.html.twig', 
            $this->data
        );
    }
}

<!-- Page translations -->
<h1></h1>
<button></button>

<!-- Global translations -->
<nav>
    <a href="#"></a>
    <a href="#"></a>
</nav>

<!-- Current language -->
<p>Current language: pt</p>

5. Language Switching

The framework includes a language switcher in the header. Users can switch between languages, and the selection is saved in the session.

// Language is automatically detected from session
// Current language: pt

// To manually set language in code:
$_SESSION['lang'] = 'en'; // or 'pt'

// Language route (already configured):
// GET /lang/{lang} → LanguageController@switch

Database Usage (Optional)

The framework works with or without a database. To use a database:

host=localhost
dbname=your_database
dbuser=root
dbpass=your_password

<?php
namespace App\Models;

use App\Core\Model;

class MyModel extends Model
{
    public function getData()
    {
        $this->requireDatabase();
        $stmt = $this->db->prepare("SELECT * FROM table");
        $stmt->execute();
        return $stmt->fetchAll();
    }
}

Framework Features

Code Examples

// routes.php
$router->get('/about', 'App\Controllers\AboutController@index');

// AboutController.php
public function index() {
    $this->data += [
        'viewName' => 'pages/about.html.twig',
        'page' => ['titulo' => 'About Us']
    ];
    echo $GLOBALS['twig']->render('templates/mainTemplate.html.twig', $this->data);
}

// routes.php
$router->get('/user/{id}', 'App\Controllers\UserController@show');

// UserController.php
public function show($id) {
    // $id contains the parameter from URL
    $this->data += [
        'viewName' => 'pages/user.html.twig',
        'userId' => $id
    ];
    echo $GLOBALS['twig']->render('templates/mainTemplate.html.twig', $this->data);
}

// routes.php
$router->get('/contact', 'App\Controllers\ContactController@form');
$router->post('/contact', 'App\Controllers\ContactController@submit');

// ContactController.php
public function submit() {
    $name = $_POST['name'] ?? '';
    $email = $_POST['email'] ?? '';
    // Process form data...
    header('Location: ' . BASE_URL . 'contact?success=1');
}

// 1. Create app/Metafiles/pt/products.json
{
  "titulo": "Produtos",
  "t": {
    "title": "Nossos Produtos",
    "add_to_cart": "Adicionar ao Carrinho"
  }
}

// 2. In ProductsController.php
public function index() {
    $this->loadPageTranslations('products');
    $this->data += [
        'viewName' => 'pages/products.html.twig'
    ];
    echo $GLOBALS['twig']->render('templates/mainTemplate.html.twig', $this->data);
}

// 3. In products.html.twig
<h1></h1>
<button></button>

Tips & Best Practices

• Use translations: Store page content in app/Metafiles/{lang}/ for easy localization
• Check database: Use $this->requireDatabase() in models before database operations
• Environment variables: Store sensitive data in .env file
• Template inheritance: Use mainTemplate.html.twig for consistent layout
• Error handling: Framework handles 404 errors automatically
• Session management: Sessions are started automatically in index.php

Resources