README
What is Mamaframework?
Mamaframework is a PHP 5.5 full-stack web framework. It is written with speed and
flexibility in mind. It allows developers to build better and easy to maintain
websites with PHP., (*1)
Mamaframework can be used to develop all kind of websites, from your personal blog
to high traffic ones., (*2)
Requirements
Mamaframework is only supported on PHP 5.5 and up. Mamaframework
needs a Database to manage Access Control List. This Database must be MySQL.
Remmember to have the mod rewritte enable., (*3)
Installation
1. Install composer
If you don't have composer installed in your system, install it by following this, (*4)
php -r "readfile('https://getcomposer.org/installer');" > composer-setup.php
php -r "if (hash_file('SHA384', 'composer-setup.php') === 'a52be7b8724e47499b039d53415953cc3d5b459b9d9c0308301f867921c19efc623b81dfef8fc2be194a5cf56945d223') { echo 'Installer verified'; } else { echo 'Installer corrupt'; unlink('composer-setup.php'); } echo PHP_EOL;"
php composer-setup.php
php -r "unlink('composer-setup.php');"
mv composer.phar /usr/local/bin/composer
2. Install project
Usage:
composer create-project mmf/mmf [Directory name]
Example:
composer create-project mmf/mmf mmf
3. Install database
Use included database dump in project root DumpTestDB, (*5)
The document root need to point to public folder, (*6)
At this point the mamaframework may be installed, (*7)
Possible error messages
| Error text |
Possible solution |
{"success":false,"responseData":{"errorCode":1600,"errorMessage":"The URL not match with any of our defined routes"}} |
Go to config/routing.ini to check the declared variable |
{"success":false,"responseData":{"errorCode":0,"errorMessage":"Error trying to connect to db"}} |
Go to config/config.ini to check if the group db_default is correctly configure |
{"success":false,"responseData":{"errorCode":1500,"errorMessage":"User not allow to access"}} |
Check in the database role , permission and role_permission + config/routing.ini if the configuration is correct |
Getting Started
- Representation of directory structre with short description of what includes:
+-- _src (bussines logic)
| +-- _app (App logic)
| +-- _mmf (Framework)
| +-- _translate (PHP translation files)
| +-- .htaccess
| +-- config.ini (configuration of each Mmf module.
| +-- error_page.html (Estandard error page, when framework is not available to load it's own error page)
| +-- index.php (File which instantiates autoloader, frontcontroller, comunicator and config)
| +-- routing.ini (File, that conatins, controller, action and parser of response and request)
+-- _tests
| +-- _src
| | +--_endtoend (basic tests to check if all is well configured)
| | +--_examples_config (examples of config and routing files that we could use in our projects)
| | +--include.common.functions.php (functions to simulated the curl request)
| | +--include.php (file with all the major classes instantiated)
| | +--mamaframework.sql (initial script to instantiate the database)
+-- _docu (documentation generated with APIGen)
+-- README.md
Documentation
Please read the documentation file of core functionalities, present in
(Google drive > MamasĂș Internal > Mamaframework > Documentation > Core Functionalitites)
and class diagram stored in (Google drive > MamasĂș Internal > Mamaframework > Documentation > class diagram > Mmframework)., (*8)
Config file
Config file is written using the .ini syntaxis. Basically is grouped by modules, (*9)
;Mamaframework Core and Application Libs
[app]
;Mamaframework application and plugin structure
[mmfStructure]
;Mamaframework plugin element with core classes
[plugin]
; Not working
[cache]
;Database directory
[db]
;Event directory and event main class
[event]
[healthChecker]
;Input/Ouput managed classes
[io]
;Log path
[log]
;Routing path with routing config path and main routing resoulver class
[routing]
;Session path and session manager
[session]
;ACL path and ACL manager
[acl]
;Authentication path and auth manager (MmfAuthAPI, MmfAuthBasic, MmfAuth, etc)
[auth]
;Language path and language manager classes
[language]
;MVC path, classes, script and css included by default.
[mvc]
;DB parameters all the database configurations
;Configuration of default database
[db_default]
Controllers
the config file bla bla, (*10)
Models
the config file bla bla, (*11)
Views
the config file bla bla, (*12)
Contributing
Mamaframework is a private Mamasu project., (*13)
Running Mamaframework Tests
- Install phpunit from https://phpunit.de page.
- Open the terminal, go to project directory and execute: phpunit --color tests/src/endtoend/ ,
if all goes right, a green message containing 'OK' will apearing.
- If wrong message apears with the message 'db connection error', make sure that config.ini parameters of database are correct and server is working fine.
FAQ
Wallogit.com
