Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/clagiordano/weblibs-mvc
weblibs-mvc is an simple and lightweight php routing component.
https://github.com/clagiordano/weblibs-mvc
mvc php routing weblibs-mvc
Last synced: 28 days ago
JSON representation
weblibs-mvc is an simple and lightweight php routing component.
- Host: GitHub
- URL: https://github.com/clagiordano/weblibs-mvc
- Owner: clagiordano
- License: lgpl-3.0
- Created: 2015-02-22T14:41:10.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-08-21T22:45:47.000Z (over 6 years ago)
- Last Synced: 2024-11-18T07:48:39.075Z (about 1 month ago)
- Topics: mvc, php, routing, weblibs-mvc
- Language: PHP
- Homepage:
- Size: 138 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
 
# weblibs-mvc
weblibs-mvc is an simple and lightweight php routing component.
This component can have a RESTful support simply adding an *.htaccess* file, see below for more details.
[](https://insight.sensiolabs.com/projects/336cc1e2-157e-456c-85ba-7f105683fb80)
Based on http://php-html.net/tutorials/model-view-controller-in-php/
Based on http://phpro.org/tutorials/Model-View-Controller-MVC.html#9
## Description of the main components
## Application
The application class is the main component wich handle and relates components between them.
### Controller
The Controller is the C in MVC.
The base controller is a simple abstract class that defines the
structure of all controllers.
By including the registry here, the registry is available to all class
that extend from the base controller. An index() method has also been
included in the base controller which means all controller classes that
extend from it must have an index() method themselves.
### Registry
The registry is an object where site wide variables can be stored without
the use of globals.
By passing the registry object to the controllers that need them,
we avoid pollution of the global namespace and render our variables safe.
We need to be able to set registry variables and to get them.
### Routing
The router class is responsible for loading up the correct controller.
It does nothing else. The value of the controller comes from the URL.
### Template
The templates themselves are basically HTML files with a little PHP embedded.
Do not let the separation Nazi's try to tell you that you need to have full
separation of HTML and PHP.
Remember, PHP is an embeddable scripting language.
This is the sort of task it is designed for and makes an efficient
templating language. The template files belong in the views directory.
## Installation
The recommended way to install weblibs-mvc is through [Composer](https://getcomposer.org).
```bash
composer require clagiordano/weblibs-mvc
```
### Adding RESTful support to destination project
Simply add into yours project root a file named ***.htaccess***
*(webserver must be allow override)* which contains the following lines:
```apacheconf
RewriteEngine on
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php?rt=$1 [L,QSA]
```
this simple steps allow your application make RESTful calls like:
```http
http://www.example.com/clients/68563
http://www.example.com/access/login
http://www.example.com/chart/
http://www.example.com/products/6574
```
## Usage
```php
/**
* Composer autoload
*/
require_once __DIR__ . '/vendor/autoload.php';
/**
* Import required classes
*/
use clagiordano\weblibs\mvc\Application;
use clagiordano\weblibs\mvc\Registry;
use clagiordano\weblibs\mvc\Router;
use clagiordano\weblibs\mvc\Template;
/**
* Init base application
* @var Application $application
*/
$application = new Application();
/**
* Router setup
*/
$application->setRouter(
new Router($application)
);
/**
* set the path to the controllers directory
*/
$application->getRouter()->setControllersPath(
__DIR__ . '/controllers'
);
/**
* Template setup
*/
$application->setTemplate(
new Template($application)
);
/**
* load the controller / run the application
*/
$application->getRouter()->loader();
```
## Legal
*Copyright (C) Claudio Giordano *