PHPackages guilhermecostam/lamiaphp - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Framework](/categories/framework) 4. / 5. guilhermecostam/lamiaphp ActiveProject[Framework](/categories/framework) guilhermecostam/lamiaphp ======================== A minimalist MVC framework for PHP 1.0.0(3y ago)24MITPHP Since Jul 7Pushed 3y ago1 watchersCompare [ Source](https://github.com/guilhermecostam/LamiaPHP)[ Packagist](https://packagist.org/packages/guilhermecostam/lamiaphp)[ RSS](/packages/guilhermecostam-lamiaphp/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (1)Dependencies (2)Versions (3)Used By (0) LamiaPHP ======== [](#lamiaphp) 🏮 A minimalist MVC framework for PHP [![License MIT](https://camo.githubusercontent.com/08cef40a9105b6526ca22088bc514fbfdbc9aac1ddbf8d4e6c750e3a88a44dca/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d626c75652e737667)](https://camo.githubusercontent.com/08cef40a9105b6526ca22088bc514fbfdbc9aac1ddbf8d4e6c750e3a88a44dca/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4c6963656e73652d4d49542d626c75652e737667) [![](https://camo.githubusercontent.com/5ca62441414bacaa54c6c6e5b68e46c76305947b6bf498c4949fc71c1b4b10dd/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4d61696e7461696e65642533462d7965732d677265656e2e737667)](https://camo.githubusercontent.com/5ca62441414bacaa54c6c6e5b68e46c76305947b6bf498c4949fc71c1b4b10dd/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f4d61696e7461696e65642533462d7965732d677265656e2e737667) --- Content ------- [](#content) - [Introduction](#Introduction) - [Installation](#Installation) - [Running Lamia](#Running-Lamia) - [Models, controllers and views](#models-controllers-and-views) - [Model](#Model) - [Controller](#Controller) - [View](#View) - [Routes](#Routes) - [Introducing routes](#Introducing-routes) - [Merging routes](#Merging-routes) - [Database](#Database) - [PDO](#pdo) - [Migrations](#migrations) - [Validating](#Validating) - [Introducing validations](#Introducing-validations) - [Validation list](#Validation-list) - [Testing](#Testing) - [How to contribute](#How-to-contribute) - [License](#License) --- Introduction ------------ [](#introduction) Whenever I would start a simple PHP project without the need for a big framework to help me in the development process I would do the whole process of creating a scope, folder structure, settings and more. So to solve this I had the idea to create a simple base template for these occasions. However, as I was developing, I noticed that the project stopped being a template and became a framework. And so Lamia was born, a minimalist framework written in PHP. --- Installation ------------ [](#installation) To install Lamia, you must have the following dependencies on your machine: - PHP 8.0 (or later) - Composer - Docker - Docker-compose After you have all the dependencies installed, just follow these commands: ``` composer create-project guilhermecostam/lamiaphp example-app cd example-app ``` --- Running Lamia ------------- [](#running-lamia) Installation done, now we will run the application. Initially we will create the .env file and fill in the blank information in it. ``` # create the .env file cp .env.example .env ``` Note that the database host is already defined. ``` DB_HOSTNAME=127.0.0.1 DB_NAME= DB_USERNAME= DB_PASSWORD= ``` This is because the database is being run in docker, so the database host is the docker's IP address, which is usually `127.0.0.1`. > If your machine is not `127.0.0.1`, just run `ifconfig` (linux) or `ipconfig` (windows) to find out which IP your docker is running on. Now we will install the composer dependencies and run the containers. ``` composer install docker-compose up -d ``` Finally, if all the steps have been followed correctly, the application is already running on localhost and ready to receive the [database migrations](#Database). --- Models, controllers and views ----------------------------- [](#models-controllers-and-views) ### Model [](#model) The models must be in the `app/Models/` directory and extend the Model abstract class: ``` # create a symbolic namespace, based in directory namespace App\Models; use App\Core\Model; class Coffee extends Model { // } ``` The models in the application serve to communicate the [Controllers](#controller) with business rules and the database. Therefore, here you should write the database queries, which can be done using the `db` method. For more details, see the [PDO](#pdo) section. ### Controller [](#controller) The controllers must be in the `app/Controllers/` directory and extend the Controller abstract class: ``` namespace App\Controllers; use App\Core\Controller; class CoffeeController extends Controller { // } ``` The controllers in the application serve to intermediate the requests sent by the [Views](#view) with the information provided by [Models](#model). This is also where the validations of the data provided on the forms are made. ### View [](#view) The views must be in the `app/Views/` directory and is the layer where the visual information of the application should be contained. Only templates should come here, CSS styles and JavaScript files that can be accessed publicly should go in the `public/` directory. To render the views you need to import the view class where you want to call it and call the `render` method with the specified directory: ``` use App\Core\View; // ... (new View)->render('coffee/index'); // ... ``` > Note that here you only need to specify the folder created for the view and the file name without the `.php`, because the `render` function already accesses the `app/Views/` directory directly, along with the extension. If you want to send information to the View scope, just create an array containing it. To access it in the view, just call the variable `$args` specifying the key sent: ``` # in controller $messages = [ 'lorem' => 'ipsum' ]; (new View)->render('coffee/index', $messages); # in view $args['lorem']; // return must be: 'ipsum' ``` Finally, views also render http errors. Just create the view with the error you want in the `app/Views/error/` directory and call the `errorCode` function passing the error as an integer. It also has a `redirect` method which redirects to the url passed as a parameter: ``` # error code render (new View)->errorCode(500); # redirect to url (new View)->redirect('/'); ``` > It is worth noting that the `errorCode` function also takes arguments like `render`. --- Routes ------ [](#routes) ### Introducing routes [](#introducing-routes) The application routes must be in the `routes/` directory. The correct way to write them is to separate them into files that have nomenclatures related to the grouped routes. > For example, the routes responsible for a coffee CRUD should be contained in the `coffee.php` file, and those for a beer CRUD should be contained in `beer.php`. However, nothing stops you from putting all of the application's routes into a single file. To create routes is simple. Just include the Router classes and the controllers that have the functions to be used: ``` use App\Core\Router; use App\Controllers\CoffeeController; ``` After that, simply create an array `$routes` and structure it as follows, calling the Router's `createRoute` function: ``` $routes = [ '/coffee/create' => (new Router)->createRoute(CoffeeController::class, 'create'), '/coffee/edit' => (new Router)->createRoute(CoffeeController::class, 'edit'), ]; return $routes; ``` In case of fetching an undefined route, the application is already prepared to return a 404 error view. ### Merging routes [](#merging-routes) For the system to recognize the routes created, it is necessary to merge the files created in the `web.php` file: ``` $routes = array_merge( include 'coffee.php', include 'beer.php', ); ``` --- Database -------- [](#database) ### PDO [](#pdo) For the database MySQL is being used. We will use PDO to communicate with the database and create queries. In the abstract class Model the connection to the database is already made with the instance of the Connection class. Just call the `db` attribute in the class that extends model and call the following methods: ``` # query for returns rows $this->db->row('SELECT * FROM beers'); # query for returns columns $this->db->column('SELECT * FROM beers'); ``` It is worth pointing out that it is also possible to bind values with the mentioned methods. Just create the following query, passing also an array with parameter that are the values to be replaced: ``` # query for returns rows with bind params $params = [ 'field' => 'brand' ]; $this->db->row('SELECT :field FROM beers', $params); ``` ### Migrations [](#migrations) In Lamia you can use migrations via [Phinx](https://phinx.org/). The migrations automatically go into the `database/migrations/` directory by creating them with the following command: ``` /vendor/bin/phinx create MyNewMigration ``` For more details on writing migrations and the rest of Phinx's functionality, see its [documentation.](https://book.cakephp.org/phinx/0/en/index.html) --- Validating ---------- [](#validating) ### Introducing validations [](#introducing-validations) If you want to validate the data in a form, Lamia has a native functionality for this. Just create files to write the rules to in the `app/Requests/` directory. In each file you must extend the abstract class Request: ``` # create a symbolic namespace, based in directory namespace App\Requests; use App\Core\Request; class CreateCoffeeRequest extends Request { // } ``` To perform validations, you must create a public method `validations`. This will return an `array_merge` with the return of each validated field. The `validate` method called in the merge must receive two parameters. These are the name of the field to be validated and an array of validations that should be applied to the value assigned to the field. ``` public function validations(): array { return array_merge( parent::validate('lorem', [ 'required' => 'Field should be required', 'isString' => 'Field should be string', ]), parent::validate('ipsum', [ 'isBoolean' => 'Field should be boolean', ]), ); } ``` > Observations: > > - The array that 'validate' receives must have items where the key is the name of the validation predefined in the application and the value is the message to be displayed if the validation fails. > - Note that each call of the extended `validate` method of Request is for one field of the form. Now just include the request where you want to perform the validations and call the `validations` method: ``` use App\Requests\CreateCoffeeRequest; // ... $messages = (new CreateCoffeeRequest)->validations(); // ... ``` ### Validation list [](#validation-list) Here is a list of all the validations available in the application: NameDescriptionrequiredValidate if value is emptyisArrayValidate if value is an arrayisStringValidate if value is an stringisIntegerValidate if value is an integerisFloatValidate if value is an floatisBooleanValidate if value is an booleanisEmailValidate if value is an booleanisUrlValidate if value is an urlisValidDateValidate if value is a valid date--- Testing ------- [](#testing) For the unit tests [PHPUnit](https://phpunit.de/) is being used. The tests should be written in the `tests/` directory and to run them just run the following command: ``` # for a specific test /vendor/bin/phpunit -v tests/ExampleTest.php # for a specific path /vendor/bin/phpunit -v tests ``` For more details on writing tests, assertion lists, and the rest of PHPUnit's functionality, see its [documentation.](https://phpunit.readthedocs.io/en/9.5/) --- How to contribute ----------------- [](#how-to-contribute) Do you want to contribute to the Lamia? Just follow these instructions: 1. Fork this repository. 2. Clone your repository. 3. Create a branch with your feature: `git checkout -b my-feature` 4. Commit your changes: `git commit -m 'feat: My new feature'` 5. Push to your branch: `git push origin my-feature` 6. Come in Pull Requests from the original project and create a pull request with your changes for `dev` branch. After the merge of your pull request is done, you can delete your branch and wait for the feedback. --- License ------- [](#license) This project is licensed under the MIT License - see the [LICENSE](https://github.com/guilhermecostam/LamiaPHP/blob/main/LICENSE) page for details. ### Health Score 22 — LowBetter than 22% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity6 Limited adoption so far Community7 Small or concentrated contributor base Maturity48 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Unknown Total 1 Last Release 1405d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/99961e0e2a165081d395cc19720db0d9f59ade0f5dfb145d0ef7b15e39c572b0?d=identicon)[guilhermecostam](/maintainers/guilhermecostam) --- Top Contributors [![guilhermecostam](https://avatars.githubusercontent.com/u/53948210?v=4)](https://github.com/guilhermecostam "guilhermecostam (60 commits)") --- Tags frameworkmvcphp ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/guilhermecostam-lamiaphp/health.svg) ``` [![Health](https://phpackages.com/badges/guilhermecostam-lamiaphp/health.svg)](https://phpackages.com/packages/guilhermecostam-lamiaphp) ``` ### Alternatives [elgg/elgg Elgg is an award-winning social networking engine, delivering the building blocks that enable businesses, schools, universities and associations to create their own fully-featured social networks and applications. 1.7k15.7k5](/packages/elgg-elgg)[oleksandr-torosh/yona-cms Yona CMS - open source content management system (CMS). Written in Phalcon PHP Framework (v 1.3.x). Has a convenient modular structure. Has simple configuration and architecture. Can be easily modified for any task with any loads. 3652.1k](/packages/oleksandr-torosh-yona-cms)[vesp/core Vesp core library to make backend simple 243.8k5](/packages/vesp-core)[forme/framework An MVC framework for WordPress. 175.0k3](/packages/forme-framework)[bluzphp/skeleton Skeleton application for Bluz, a lightweight PHP framework 431.7k](/packages/bluzphp-skeleton) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)