Coesion/Core Framework Overview

This repository provides a lightweight PHP 8.5+ application core with routing, HTTP handling, persistence, configuration, and utilities.

It is designed for small-to-medium services and web apps that need a clear request lifecycle without a full-stack framework.

Usage overview:

• Autoloading: Loader registers classes/ and resolves class names to files.
• Namespaces: optional Core\ aliases are registered automatically (e.g., Core\Route).
• Configuration: Options loads configuration from PHP, INI, JSON, arrays, or .env files.
• Requests: Request reads headers, input, and body; Negotiation handles Accept headers.
• Routing: Route defines URL patterns and middleware, and Route::dispatch() resolves requests.
• Responses: Response builds and sends headers, body, and content types.
• Persistence: SQL, Persistence, and Model provide a minimal ORM.
• Events and filters: Events, Event, Filters, and Filter enable hooks and overrides.
• API: API, Resource, Collection, and REST provide RESTful data exposure.
• Utilities: Text, Hash, Token, CSV, ZIP, Shell, Work and others support common tasks.

Typical use cases:

• HTTP APIs and web apps with simple routing and response handling.
• Internal tools or admin panels using View for template rendering.
• Jobs and background processing via Job and Work.
• Data import/export pipelines using CSV and ZIP.

Performance:

• Autoload optimization: composer dump-autoload -o
• Build single-file artifact: php tools/build-core.php
• OPcache preload (web/FPM): set opcache.enable=1, opcache.preload=/path/to/dist/core.php, and opcache.preload_user=www-data (or your PHP-FPM user). Optional for partial control: opcache.file_cache=/path/to/opcache.

Single-file deploy (optional):

• Build: php tools/build-core.php
• Include: require DIR . '/dist/core.php';
• Note: dist/core.php is generated from framework classes and optimized for preload/distribution.

FrankenPHP:

• Classic mode: works like standard PHP-FPM; no special changes required.
• Worker mode: use tools/frankenphp-worker.php and ensure Response::reset() is called per request.
• Docker + Caddyfile:
• Use the official FrankenPHP image and mount your app.
• Add a Caddyfile route to your public entrypoint.
• Static binary guide: see docs/guides/FrankenPHP.md.

Class reference:

• API
• REST
• Collection
• Resource
• Core
• Cache
• Auth
• Check
• CLI
• CSV
• CSRF
• Deferred
• Dictionary (abstract)
• Email
• Error (alias)
• Errors
• Event
• Events (trait)
• File
• Filter
• Filters (trait)
• Hash
• HTTP
• HTTP_Request
• HTTP_Response
• Gate
• Job
• Loader
• Map
• Message
• MessageReadOnly
• Migration
• Model (abstract)
• Module (trait)
• Negotiation
• Options
• Password
• Persistence (trait)
• Redirect
• Relation (trait)
• Request
• Response
• RateLimiter
• Route
• RouteGroup
• SecurityHeaders
• Service
• Session
• SessionReadOnly
• Shell
• SQL
• SQLConnection
• Structure
• TaskCoroutine
• Text
• Token
• URL
• View
• Work
• ZIP

Guides:

• Installation
• Packagist Artifact Publishing
• NPM Artifact Publishing
• Releasing
• Security Audit
• Examples
• FrankenPHP
• REST API With Auth
• Agentic Audit
• Agent Snapshot
• Agents Quickstart
• Agent Use Cases
• Why Core for Agents
• Interop
• Migrations
• Code Generation
• Agent KPIs
• Agent KPI Log
• Proof Weekly Template
• Distribution Playbook
• Router Benchmarks
• API
• REST
• Route Cache Extension
• Classes