README

Modular MODEL VIEW CONTROLLER with Router

Created on Tue Oct 31 2023
Copyright (c) 2023 BitsHost

Rasmus Lerdorf: PHP Frameworks all suck!

https://www.youtube.com/watch?v=DuB6UjEsY_Y&ab_channel=matperino

upMVC - MMVC, PHP MVC with modules. Modular MVC(Model, View, Controller) derive from Hierarchical Model‐View‐Controller (HMVC).

Introducing MODULAR MVC - Empowering Your Development

In the realm of modern frameworks, it often feels like they do everything except what truly matters. These frameworks tend to add layers of abstraction that demand you to learn new skills and pathways whenever you decide to switch. They also tend to clutter themselves with superfluous options, solving simple problems in needlessly convoluted ways.

Consider PHP, including its blade templating engine. Why introduce yet another template engine when PHP is already equipped for the task? Delving into a new framework often necessitates a substantial relearning effort, pushing you far beyond your existing PHP knowledge.

So, why should you choose MMVC?

MMVC, standing for Modular Model View Controller, is not about reinventing the wheel. Instead, it's about optimizing the use of exceptional components. It offers a structured, straightforward approach, and its versatility proves invaluable for project management and development.

But why MMVC specifically?

Modularity: MMVC allows you to work on a module without impacting the rest of your project. Modules can be interchanged and integrated seamlessly, enhancing your development agility.
Language Freedom: Perhaps most importantly, you have the freedom to write your modules in your preferred language, whether it's PHP, JS, PYTHON, or modern technologies like TS and React. There are no constraints on your creativity.
Development-Centric: MMVC was designed with development in mind. You can steer your project in any direction you desire, utilizing your own autoloader or composer autoload. Composer/packagist usage is optional, not obligatory.

What truly sets MMVC apart is its ability to harness the latest PHP capabilities without constraint. No more endless loops, as this framework liberates your development possibilities.

Install:

(since there is no release yet)

composer require bitshost/upmvc:dev-main

or

composer require bitshost/upmvc:dev-master

(NOTE: When utilizing upMVC as a library, you need place index.php or its content in the folder/file where you wish to utilize it, as well as add .htaccess rules in your .htaccess or copy/paste rules)

or

composer create-project bitshost/upmvc:dev-main yourFolderNameHere

or

composer create-project bitshost/upmvc:dev-master yourFolderNameHere

or - current directory(include point(.))

composer create-project bitshost/upmvc:dev-main .

Settings:

/etc/Config.php

/etc/ConfigDatabase.php

/modules/mail/MailController.php

Add routes:

1 - General Routes - > etc/Routes.php

2 - Specific Routes(specific routing) - > modules/yourmodule/routes/Routes.php

3 - Adding module routes in Modules Initialiser - > etc/InitMods.php

Note:

A friendly URL is a short and simple web address that redirects to a longer web address. Friendly URLs are called Aliases in Sitecore.

We achieve this by combining some .htacces rules with module routes. Check modules/test/routes/Routes.php and the .htaccess file - you will notice the rules established in the.htaccess file for these specific routes - you may build as many as you like.

In the same file, modules/test/routes/Routes.php, you will see for demonstration purposes how you may handle a large number of URLs with parameters (such as an idProduct) in a very straightforward way.

Steps

Edit /etc/Config.php, /etc/ConfigDatabase.php, /modules/mail/MailController.php with your data.
Make your module in the MVC style (model, view, controller).
You may or may not wish to utilize BASE MODEL, BASE VIEW and BASE CONTROLLER from the common/bmvc subdirectory.
BaseModel contains all of the data required for CRUD OPERATIONS; simply expand it in your module model and you have a CRUD ready-made module; see example module modules/user.
Make a distinctive namespace for each module
Your module routes should be kept under modules/YourModule/routes - file Routes.php
Because these routes should be presented to Router, you must provide their namespace to InitMods.php and initialize your module routes.
Don't forget to update composer.json with your new namespaces for your module and routes, as well as refresh composer from the terminal:
composer dump-autoload
php composer.phar dump-autolad
setup your PHPMailer - mail/MailController.php

You have more than one method of accomplishing things in example modules, upMVC - don't enforce RULES like others do, but respect architecture models MVC, MMVC, and pure PHP and OOP programming rules.

The Names Convention

Considering recommendations:

Model, View, Controller - will be called by using module name in their name. For example, module name = books:
Model.php - class Model; View.php - class View; Controller.php - class Controller;
and make a distinctive namespace for each module - namespace ModuleName - e.g. Books;
Your module routes should be kept under modules/yourModule/routes - file Routes.php:
- Routes.php class Routes in folder /modules/books/routes
- namespace ModuleName\Routes, e.g. Books\Routes

BitsHost Team

Diagram:

File Structure:

bitshost / upmvc

Maintainers

Details