README

Pramnos Framework is a comprehensive PHP MVC framework designed for building robust, scalable web applications. The v1.2 release brings major infrastructure improvements, a complete ORM layer, advanced API support, and enhanced developer experience.

📖 Full documentation: mrpc.github.io/PramnosFramework

Released: July 2026
Minimum PHP Version: 8.1
Database Support: MySQL 8.0+, PostgreSQL 14+, TimescaleDB

🚀 What's New in v1.2?

Database & Query Layer

Read/Write Replicas — Automatic routing of queries to primary and replica connections
Connection Health & Auto-reconnect — Transparent reconnection on dropped connections
DML Query Builder — Fluent interface for SELECT, INSERT, UPDATE, DELETE with dialect support
DDL Schema Builder — Programmatic schema definition with support for migrations
DatabaseCapabilities — Runtime detection of database features (TimescaleDB, JSON, spatial, etc.)
timeBucket() & Time Series Support — Dialect-transparent time bucketing for TimescaleDB/PostgreSQL

Infrastructure & Architecture

Complete ORM — Models with relationships, scopes, and casting
Migration System v2 — Framework-managed migrations with auto-run, versioning, and rollback
Service Providers — Application bootstrap and dependency injection
Feature Registry — Declarative feature management and wiring
Policy Engine — Authorization framework with condition-based access control
Middleware Pipeline — Request/response filtering with composable middleware
Health Check System — Built-in application health monitoring and diagnostics

API & Web Features

PSR Compliance Layer — PSR-7/PSR-15 compatibility for interoperability
Modern Routing — Attribute-based routing with parameter binding and groups
REST API Framework — Scaffolding and conventions for API-first development
Database-Driven CORS — Configuration stored in database with runtime validation
Response Object — Formal HTTP response abstraction
HTTP Testing Infrastructure — Built-in testing helpers for API/web testing

Security Enhancements

CSRF Hardening — Strengthened token validation with session binding
Session Cookie Hardening — Secure cookie attributes and regeneration
View Escaping Helpers — Safe output escaping with context-aware strategies
OAuth2 Server — Full OAuth2 authorization server implementation
2FA/TOTP — Two-factor authentication and time-based one-time passwords
Login Lockout — Brute-force protection with exponential backoff

Developer Experience

Scaffolding System — Generate controllers, views, models, tests with smart defaults
Rich CLI — Comprehensive command-line tools with progress reporting
MCP Server — AI-powered developer assistance (Claude/ChatGPT integration)
Enhanced DebugBar — Migrations, request timeline, cache tracking, and profiling
Form Requests — Validation-focused request objects with automatic routing
Notification Channels — Email, database, and webhook notifications
Admin CRUD Generators — Automatic admin interfaces for database tables

Database Features

Window Functions — RANK(), ROW_NUMBER(), LAG/LEAD support across MySQL 8+ and PostgreSQL
CTEs & Subqueries — Common Table Expressions with with() and subquery builders
Set Operations — UNION/UNION ALL with type coercion
Upsert Operations — INSERT...ON DUPLICATE KEY / INSERT...ON CONFLICT
Aggregate Functions — COUNT, SUM, AVG, MIN, MAX with proper cloning

📚 Documentation

The full documentation is available as a live site at mrpc.github.io/PramnosFramework.

Running the docs locally (Docker required)

# Start the live-reload development server at http://localhost:8000
./dockerdocs serve

# Build the static HTML site into ./site/
./dockerdocs build

# Deploy to GitHub Pages manually
./dockerdocs deploy

No local Python or pip installation is required — everything runs inside Docker.

Getting Started

Installation & Setup - Quick start guide for new projects
v1.2 New Features Reference - Comprehensive feature documentation (implementation reference)

Core Guides by Topic

Database & ORM

Database API Guide - Legacy Database::query() API and patterns
DML Query Builder Guide - Fluent query construction for SELECT/INSERT/UPDATE/DELETE (new in v1.2)
DDL Schema Builder Guide - Programmatic schema definition (new in v1.2)
ORM Guide - Model definition, relationships, scopes, and casting (new in v1.2)
Migration System Guide - Database versioning and auto-run system (new in v1.2)

Web & API

Framework Guide - Controllers, views, and MVC architecture
REST API Guide - Building and deploying REST APIs (updated for v1.2)
Routing Guide - Modern attribute-based routing (new in v1.2)
Response & Status Guide - HTTP response abstraction (new in v1.2)

Authentication & Security

Authentication Guide - Authentication drivers, session management, OAuth2
Authorization & Policies Guide - Policy engine and access control (new in v1.2)
Security Best Practices - CSRF, XSS, injection prevention, and hardening (new in v1.2)

Backend & Infrastructure

Console Commands Guide - Building and running CLI commands
Service Providers Guide - Application bootstrap and dependency injection (new in v1.2)
Health Check Guide - Monitoring and diagnostics (new in v1.2)
Scheduled Tasks Guide - Background job scheduling (new in v1.2)
Queue System Guide - Asynchronous job processing

Developer Tools

Logging System Guide - Structured logging and analytics
Caching Guide - Query, data, and application-level caching
Testing Guide - HTTP tests, factories, seeders (updated for v1.2)
Scaffolding Guide - Code generation tools (new in v1.2)
DebugBar Guide - Development profiling and debugging (updated for v1.2)

Content & UI

Theme System Guide - Template system, widgets, and theming
Document & Output Guide - Multi-format output (HTML, PDF, JSON, etc.)
Validation Guide - Form validation and custom rules
Internationalization Guide - Multi-language support
Email Guide - Email delivery and templates
Media & Storage Guide - File uploads and storage abstraction (updated for v1.2)
Environment Variables Guide - Configuration management

Requirements

Docker and Docker Compose (Recommended for development)
PHP 7.4 or higher (if running natively)
ext-mbstring extension
ext-pdo extension (for database support)
Optional: Redis/Memcached for caching

Installation

The recommended way to start a new project is using the Pramnos Application, which provides a one-line setup experience:

composer create-project mrpc/pramnos-application my-app

Alternatively, you can manually add the framework as a dependency to an existing project:

mkdir my-app && cd my-app
composer require mrpc/pramnosframework
php vendor/bin/pramnos init

The init command will guide you through the setup with smart defaults (e.g., automatic namespace generation and database naming).

✨ Key Features

🏗️ Architecture

MVC Design Pattern - Clean separation of concerns
Component-Based - Modular and reusable components
Namespace Support - PSR-4 compliant autoloading
Factory Pattern - Centralized object creation and management

🔐 Authentication & Security

JWT Token Support - Secure token-based authentication
Session Management - Robust session handling with multiple storage backends
Permission System - Granular access control and user permissions
OAuth2 Support - Built-in OAuth2 server capabilities
CSRF Protection - Request validation and security
Nonce-based CSP - Automatic Content Security Policy with per-request nonces

💾 Database & Caching

Database Abstraction - Support for MySQL, PostgreSQL
Query Builder - Secure parameterized queries with printf-style formatting
Multiple Cache Backends - Redis, Memcached, File-based caching
Database Migrations - Version-controlled database schema changes
Connection Pooling - Efficient database connection management

🌐 Web Features

RESTful Routing - Flexible URL routing with parameter binding
API Framework - Built-in REST API support with versioning
Multiple Output Formats - JSON, XML, HTML, PDF, RSS
Theme System - Pluggable theming with template inheritance
Multilingual Support - Complete internationalization framework

🛠️ Developer Tools

Console Commands - Code generators and maintenance tools
Logging System - Structured logging with multiple handlers
Debug Tools - Built-in debugging and profiling utilities
Testing Support - PHPUnit integration and test helpers

📦 Additional Components

Media Handling - Image processing and file management
Email System - SMTP support with template rendering
Geolocation - Geographic utilities and distance calculations
HTML Utilities - Form builders, datatables, and UI components

Directory Structure

src/Pramnos/
├── Addon/         # Extension modules
├── Application/   # Application core
├── Auth/          # Authentication components
├── Cache/         # Caching utilities
├── Console/       # CLI commands
├── Database/      # Database interaction
├── Document/      # Document handling
├── Email/         # Email services
├── Filesystem/    # File operations
├── Framework/     # Core framework classes
├── General/       # General utilities
├── Geolocation/   # Geolocation services
├── Html/          # HTML utilities
├── Http/          # HTTP request/response
├── Interfaces/    # Framework interfaces
├── Logs/          # Logging functionality
├── Media/         # Media handling
├── Routing/       # URL routing
├── Theme/         # Theming system
├── Translator/    # Translation services
├── User/          # User management
└── helpers.php    # Global helper functions

🚀 Quick Start

Basic Application Setup

<?php
// public/index.php
require __DIR__ . '/../vendor/autoload.php';

// Set the path to your root app directory
define('ROOT', dirname(__DIR__));

// Define start point for performance tracking
define('SP', microtime(true));

// Create an application instance
$app = new Pramnos\Application\Application();

// Initialize the application
$app->init();

// Execute the application
$app->exec();

// Render the output
echo $app->render();

Creating Your First Controller

<?php
namespace MyApp\Controllers;

class WelcomeController extends \Pramnos\Application\Controller
{
    public function __construct(?\Pramnos\Application\Application $application = null)
    {
        // Define public actions (no authentication required)
        $this->addaction(['display', 'about']);
        
        // Define authenticated actions (login required)
        $this->addAuthAction(['dashboard', 'profile']);
        
        parent::__construct($application);
    }
    
    public function display()
    {
        $view = $this->getView('Welcome');
        
        $doc = \Pramnos\Framework\Factory::getDocument();
        $doc->title = 'Welcome to Pramnos Framework';
        
        $this->application->addBreadcrumb('Home', sURL);
        
        return $view->display('welcome');
    }
}

Database Operations

// Using the Pramnos database pattern
$sql = $this->application->database->prepareQuery(
    "SELECT * FROM users WHERE email = %s AND status = %d", 
    $email, 
    $status
);
$result = $this->application->database->query($sql);

// Single record
if ($result->numRows > 0) {
    $user = $result->fields; // Direct access to associative array
}

// Multiple records
$users = [];
while ($result->fetch()) {
    $users[] = $result->fields;
}

Console Commands

The framework includes powerful console commands for development. If using Docker, run these via docker-compose exec php-apache-environment ....

# Generate a full CRUD controller from an existing table
php bin/pramnos create:controller UserController

# Generate a new model
php bin/pramnos create:model User

# Generate API endpoints
php bin/pramnos create:api UserAPI

# Create database migrations
php bin/pramnos create:migration CreateUsersTable

# Run development server
php bin/pramnos serve --port=8080

# Migrate log files to structured format
php bin/pramnos migratelogs var/logs --all

🏗️ Architecture Overview

Framework Components

src/Pramnos/
├── Application/     # Core MVC components (Controllers, Models, Views)
├── Auth/           # Authentication, JWT, Permissions
├── Cache/          # Multi-backend caching system
├── Console/        # CLI commands and tools
├── Database/       # Database abstraction and migrations
├── Document/       # Output rendering (HTML, JSON, PDF, etc.)
├── Email/          # Email handling and templates
├── Framework/      # Base classes and Factory
├── Http/           # Request/Response handling
├── Logs/           # Logging and log management
├── Media/          # File and image processing
├── Routing/        # URL routing and dispatching
├── Theme/          # Theming and template system
├── Translator/     # Internationalization
└── User/           # User management and tokens

Configuration Structure

app/
├── app.php          # Main application configuration
├── config/          # Additional configuration files
│   ├── database.php
│   ├── cache.php
│   └── settings.php
├── language/        # Translation files
├── migrations/      # Database migrations
└── themes/          # Application themes

src/
├── Controllers/     # Application controllers
├── Models/          # Data models
├── Views/           # Template files (.html.php)
└── Api/            # API controllers and routes

🔧 Configuration

Database Configuration

// app/config/database.php
return [
    'host' => 'localhost',
    'username' => 'dbuser',
    'password' => 'dbpass',
    'database' => 'myapp',
    'prefix' => 'app_',
    'type' => 'mysql', // or 'postgresql'
    'port' => 3306
];

Cache Configuration

// app/config/cache.php
return [
    'method' => 'redis', // redis, memcached, memcache, file
    'hostname' => 'localhost',
    'port' => 6379,
    'database' => 0,
    'prefix' => 'myapp_'
];

Application Configuration

// app/app.php
return [
    'namespace' => 'MyApp',
    'theme' => 'default',
    'api_version' => 'v1',
    'addons' => [
        ['addon' => 'UserDatabase', 'type' => 'auth'],
        ['addon' => 'Session', 'type' => 'system']
    ],
    'scripts' => [
        [
            'script' => 'jquery',
            'src' => 'assets/js/jquery.min.js',
            'deps' => [],
            'version' => '3.6.0',
            'footer' => false
        ]
    ],
    /**
     * Content Security Policy (CSP)
     */
    'csp' => [
        'script-src' => ['https://maps.googleapis.com'],
        'style-src' => ['https://fonts.googleapis.com'],
        'font-src' => ['https://fonts.gstatic.com'],
        'img-src' => ['https://maps.gstatic.com'],
        'connect-src' => ['https://maps.googleapis.com']
    ]
];

🌟 Advanced Features

Custom Authentication Addon

<?php
namespace MyApp\Addon\Auth;

class CustomAuth extends \Pramnos\Addon\Addon
{
    public function onAuth($username, $password, $remember, $encrypted, $validate)
    {
        // Custom authentication logic
        return [
            'status' => true,
            'username' => $username,
            'uid' => $userId,
            'email' => $email,
            'auth' => $authHash
        ];
    }
}

API Controller Example

<?php
namespace MyApp\Api\Controllers;

class UsersController extends \Pramnos\Application\Controller
{
    public function display()
    {
        // GET /api/users
        $users = $this->getModel('User')->getList();
        return $this->response(['users' => $users]);
    }
    
    public function postCreateUser()
    {
        // POST /api/users
        $data = $this->getRequestData();
        $user = $this->getModel('User');
        $user->create($data);
        return $this->response(['user' => $user->getData()], 201);
    }
}

Custom Cache Usage

// Using the cache system
$cache = \Pramnos\Cache\Cache::getInstance('user_data', 'user', 'redis');

// Save data
$cache->save($userData, $userId);

// Load data
$userData = $cache->load($userId);

// Clear category
$cache->clear('user');

📄 Documentation

🌐 All of the guides below are also published as a searchable site at mrpc.github.io/PramnosFramework.

The framework includes comprehensive documentation for all major subsystems:

Core System Documentation

Framework Guide - Core framework architecture and concepts
Database API Guide - Database operations and query building
Authentication Guide - User authentication and session management
Cache System Guide - Caching strategies and implementation
Console Guide - Command-line interface and console commands

Feature Documentation

Logging Guide - Logging system and debugging tools
Document & Output Guide - Document generation and output management
Theme System Guide - Theming, templates, and UI customization
Email System Guide - Email sending, templates, and tracking
Media System Guide - File uploads, image processing, and media management
Internationalization Guide - Multi-language support and localization

📄 License

MIT License - see the LICENSE.txt file for details.

👨‍💻 Author

Yannis - Pastis Glaros
Email: mrpc@pramnoshosting.gr

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Development Setup

The framework includes a fully containerized development and testing environment.

Clone the repository:

git clone https://github.com/mrpc/PramnosFramework.git
cd PramnosFramework

Start the Docker environment:
```
docker-compose up -d
```
This will start PHP 8.4 (for testing), MySQL, PostgreSQL/TimescaleDB, and Redis.

Install dependencies and initialize:

docker-compose exec php-apache-environment composer install

Run tests:

# Using the provided wrapper script
./dockertest

# With coverage report
./dockertest --coverage

Guidelines

Core framework code (src/Pramnos/) must remain PHP 7.4 compatible.
Tests (tests/) run on PHP 8.4 and can use modern PHP features.
Follow PSR-4 autoloading standards.
Write tests for new features using PHPUnit 11 with native attributes.
Update documentation when adding features.

If you are developing the framework and want to test the full "new project" experience locally, you can use this one-liner (adjust APP_NAME and the path to PramnosFramework as needed):

APP_NAME=test-app; mkdir $APP_NAME && cd $APP_NAME && composer init -n --name="app/$APP_NAME" && composer config version dev-main && composer config minimum-stability dev && composer config repositories.pramnos path ../PramnosFramework && composer require mrpc/pramnosframework:dev-main && php vendor/bin/pramnos init

🆘 Support

Documentation: Check the docs/ directory
Issues: Submit issues on the project repository
Community: Join our community discussions

mrpc / pramnosframework

Maintainers

Package info

Statistics

Security