Home

Welcome to the MFX wiki!

What is MFX?

MFX is a full-stack PHP framework originally designed to serve as a project basis for Cheese Burgames, a now-defunct french independant video game studio. The first version, originally called php-micro-framework has been introduced in 2013 and matured in 2016. With time, MFX has evolved into a complete framework for external developments.

It can be used as the core of any regular website or API.

License

MFX is released under the MIT license as found here.

System Requirements

• PHP 7.0.2+
• Apache with mod_rewrite module enabled
• Any database management system compatible with PDO (MySQL, MariaDB, PostgreSQL, ...) if you plan to use database storage (see PDO documentation for more information)

Dependencies

Dependencies are currently added directly into the repository or as submodules.

There are four dependencies:

• php-gettext
  Replacement wrapper for handling MO files where the native gettext extension is not available
• Twig (1.x - MFX is not compatible with version 2.x at the moment)
  Template engine
  https://twig.symfony.com/
• PDO database manager
  PDO extended with some nice utility functions
  https://packagist.org/packages/cheese-burgames/pdo-database-manager
• Xhaleera Twig Tools
  Set of useful extensions for Twig (switch blocks, lazy blocks, support for gettext inside the templates)
  https://packagist.org/packages/xhaleera/twig-tools

Getting Started

Go to this page to start using MFX.

Complete documentation

To access a deeper and more complete documentation on the design and usage of MFX, go to the Framework Reference.

Planned Improvements

(This list is not prioritized)

• Making it compatible with Composer
• Adding a setup script
• Testing and improving nginx compatibility
• Making it possible to replace the default router with a custom one
• Improving DatabaseUpdater reliability and error resilience
• Removing php-gettext library dependency (making gettext extension mandatory)
• Updating Twig to version 2.x

Known Issues

(This list is not prioritized)

• The post-route callback may not be called with some request results
• Pre-conditions should be validated before calling pre-route callbacks