PHPackages x4k-maker/php-mvc - 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. x4k-maker/php-mvc ActiveLibrary[Framework](/categories/framework) x4k-maker/php-mvc ================= 00PHP Since Nov 8Pushed 4y agoCompare [ Source](https://github.com/x4k-maker/php-mvc)[ Packagist](https://packagist.org/packages/x4k-maker/php-mvc)[ RSS](/packages/x4k-maker-php-mvc/feed)WikiDiscussions master Synced 1w ago READMEChangelog (2)DependenciesVersions (1)Used By (0) Welcome to the PHP MVC framework ================================ [](#welcome-to-the-php-mvc-framework) This is a simple MVC framework for building web applications in PHP. It's free and [open-source](LICENSE). It was created for the [Write PHP like a pro: build an MVC framework from scratch](https://davehollingworth.net/phpmvcg) course. The course explains how the framework is put together, building it step-by-step, from scratch. If you've taken the course, then you'll already know how to use it. If not, please follow the instructions below. Starting an application using this framework -------------------------------------------- [](#starting-an-application-using-this-framework) 1. First, download the framework, either directly or by cloning the repo. 2. Run **composer update** to install the project dependencies. 3. Configure your web server to have the **public** folder as the web root. 4. Open [App/Config.php](App/Config.php) and enter your database configuration data. 5. Create routes, add controllers, views and models. See below for more details. Configuration ------------- [](#configuration) Configuration settings are stored in the [App/Config.php](App/Config.php) class. Default settings include database connection data and a setting to show or hide error detail. You can access the settings in your code like this: `Config::DB_HOST`. You can add your own configuration settings in here. Routing ------- [](#routing) The [Router](Core/Router.php) translates URLs into controllers and actions. Routes are added in the [front controller](public/index.php). A sample home route is included that routes to the `index` action in the [Home controller](App/Controllers/Home.php). Routes are added with the `add` method. You can add fixed URL routes, and specify the controller and action, like this: ``` $router->add('', ['controller' => 'Home', 'action' => 'index']); $router->add('posts/index', ['controller' => 'Posts', 'action' => 'index']); ``` Or you can add route **variables**, like this: ``` $router->add('{controller}/{action}'); ``` In addition to the **controller** and **action**, you can specify any parameter you like within curly braces, and also specify a custom regular expression for that parameter: ``` $router->add('{controller}/{id:\d+}/{action}'); ``` You can also specify a namespace for the controller: ``` $router->add('admin/{controller}/{action}', ['namespace' => 'Admin']); ``` Controllers ----------- [](#controllers) Controllers respond to user actions (clicking on a link, submitting a form etc.). Controllers are classes that extend the [Core\\Controller](Core/Controller.php) class. Controllers are stored in the `App/Controllers` folder. A sample [Home controller](App/Controllers/Home.php) included. Controller classes need to be in the `App/Controllers` namespace. You can add subdirectories to organise your controllers, so when adding a route for these controllers you need to specify the namespace (see the routing section above). Controller classes contain methods that are the actions. To create an action, add the **`Action`** suffix to the method name. The sample controller in [App/Controllers/Home.php](App/Controllers/Home.php) has a sample `index` action. You can access route parameters (for example the **id** parameter shown in the route examples above) in actions via the `$this->route_params` property. ### Action filters [](#action-filters) Controllers can have **before** and **after** filter methods. These are methods that are called before and after **every** action method call in a controller. Useful for authentication for example, making sure that a user is logged in before letting them execute an action. Optionally add a **before filter** to a controller like this: ``` /** * Before filter. Return false to stop the action from executing. * * @return void */ protected function before() { } ``` To stop the originally called action from executing, return `false` from the before filter method. An **after filter** is added like this: ``` /** * After filter. * * @return void */ protected function after() { } ``` Views ----- [](#views) Views are used to display information (normally HTML). View files go in the `App/Views` folder. Views can be in one of two formats: standard PHP, but with just enough PHP to show the data. No database access or anything like that should occur in a view file. You can render a standard PHP view in a controller, optionally passing in variables, like this: ``` View::render('Home/index.php', [ 'name' => 'Dave', 'colours' => ['red', 'green', 'blue'] ]); ``` The second format uses the [Twig](http://twig.sensiolabs.org/) templating engine. Using Twig allows you to have simpler, safer templates that can take advantage of things like [template inheritance](http://twig.sensiolabs.org/doc/templates.html#template-inheritance). You can render a Twig template like this: ``` View::renderTemplate('Home/index.html', [ 'name' => 'Dave', 'colours' => ['red', 'green', 'blue'] ]); ``` A sample Twig template is included in [App/Views/Home/index.html](App/Views/Home/index.html) that inherits from the base template in [App/Views/base.html](App/Views/base.html). Models ------ [](#models) Models are used to get and store data in your application. They know nothing about how this data is to be presented in the views. Models extend the `Core\Model` class and use [PDO](http://php.net/manual/en/book.pdo.php) to access the database. They're stored in the `App/Models` folder. A sample user model class is included in [App/Models/User.php](App/Models/User.php). You can get the PDO database connection instance like this: ``` $db = static::getDB(); ``` Errors ------ [](#errors) If the `SHOW_ERRORS` configuration setting is set to `true`, full error detail will be shown in the browser if an error or exception occurs. If it's set to `false`, a generic message will be shown using the [App/Views/404.html](App/Views/404.html) or [App/Views/500.html](App/Views/500.html) views, depending on the error. Web server configuration ------------------------ [](#web-server-configuration) Pretty URLs are enabled using web server rewrite rules. An [.htaccess](public/.htaccess) file is included in the `public` folder. Equivalent nginx configuration is in the [nginx-configuration.txt](nginx-configuration.txt) file. --- Signup for the course [here](https://davehollingworth.net/phpmvcg) and understand how this framework is built from scratch, putting it all together step by step. ### Health Score 15 — LowBetter than 3% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity0 Limited adoption so far Community9 Small or concentrated contributor base Maturity28 Early-stage or recently created project Bus Factor1 Top contributor holds 81% 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. ### Community Maintainers ![](https://www.gravatar.com/avatar/d033964a0f785ce9b76f3351830c071e7c31fb2f2f4f0fdaf1c85b0a9d8b4fc9?d=identicon)[ddddddddd12f](/maintainers/ddddddddd12f) --- Top Contributors [![daveh](https://avatars.githubusercontent.com/u/29439?v=4)](https://github.com/daveh "daveh (17 commits)")[![getsmygets](https://avatars.githubusercontent.com/u/61307511?v=4)](https://github.com/getsmygets "getsmygets (3 commits)")[![Seasle](https://avatars.githubusercontent.com/u/19286158?v=4)](https://github.com/Seasle "Seasle (1 commits)") ### Embed Badge ![Health badge](/badges/x4k-maker-php-mvc/health.svg) ``` [![Health](https://phpackages.com/badges/x4k-maker-php-mvc/health.svg)](https://phpackages.com/packages/x4k-maker-php-mvc) ``` ### Alternatives [laravel/telescope An elegant debug assistant for the Laravel framework. 5.2k67.8M192](/packages/laravel-telescope)[spiral/roadrunner RoadRunner: High-performance PHP application server and process manager written in Go and powered with plugins 8.4k12.2M84](/packages/spiral-roadrunner)[nolimits4web/swiper Most modern mobile touch slider and framework with hardware accelerated transitions 41.8k177.2k1](/packages/nolimits4web-swiper)[laravel/dusk Laravel Dusk provides simple end-to-end testing and browser automation. 1.9k36.7M259](/packages/laravel-dusk)[laravel/prompts Add beautiful and user-friendly forms to your command-line applications. 708181.8M596](/packages/laravel-prompts)[cakephp/chronos A simple API extension for DateTime. 1.4k47.7M121](/packages/cakephp-chronos) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)