Skip to content

Divergence/framework

Repository files navigation

Code Coverage Latest Stable Version Build Status Latest Unstable Version Scrutinizer Code Quality License


Divergence is a PHP framework designed for rapid development and modern practices without becoming an over abstracted mess.

Requires PHP 8.1+

Minimal Model

<?php

namespace App\Models;

use Divergence\Models\Model;
use Divergence\Models\Mapping\Column;

class Article extends Model
{
    public static $tableName = 'articles';

    #[Column(type: 'string', notnull: true)]
    private string $Title;

    #[Column(type: 'clob', notnull: true)]
    private string $Body;
}

Purpose

This collection of classes contains my favorite building blocks for developing websites with PHP and they have an impressive track record with hundreds of currently active websites using one version or another of the classes in this framework. While they were originally written years ago they are all PSR compatible and support modern practices out of the box.

Unit testing the code base and providing code coverage is a primary goal of this project.

Main Features

  • Models

    • Real PHP classes.
    • Declare fields with static arrays or PHP 8 attributes (#[Column(...)]).
    • Declare relationships with static arrays or PHP 8 attributes (#[Relation(...)]).
    • Built in support for relationships and object versioning.
    • Speed up prototyping and automate new deployments by automatically creating tables based on your models when none are found.
    • Built in support for MySQL and SQLite.
  • Routing

    • Simpler, faster, tree based routing system.
    • Built with basic class inheritance in mind.
  • Controllers

    • PSR-7 compatible controllers.
    • Pre-made REST API controllers allow you to build APIs rapidly.
    • 100% Unit test coverage for filters, sorters, and conditions.
    • Build HTTP APIs in minutes by extending RecordsRequestHandler and setting the one config variable: the name of your model class.
    • Use a pre-made security trait with RecordsRequestHandler or extend it and write in your own permissions.
    • Standard permissions interface allows reuse of permission traits from one model to another.
  • Templates

    • Out of the box support for Twig
  • Media

    • Out of the box support for a media storage.
    • Automated thumbnail generation for JPEG, GIF, PNG, and PDF.
    • Built in support for MP4 and WEBM chunkable emitters allowing you to easily host videos with the ability to seek.
    • Manage media remotely with a built in JSON API using the standard permissions interface for all controllers.
    • Supports POST and PUT request types for media uploads.

Installation

composer require divergence/divergence

The divergence/cli package is also available to initialize new projects and manage database configurations from the command line.

Running Tests

# Run all test suites
composer test

# MySQL suite only
composer test:mysql

# SQLite in-memory suite only
composer test:sqlite

Contributing To Divergence

All issues and pull requests should be filed on the Divergence/framework repository.

License

The Divergence framework is open-sourced software licensed under the MIT license

Credits

Packages

 
 
 

Contributors

Languages