php.class.MiniRoute v2.3

Version 2.3

The value after the / makes a controller callback. Which can be a separate class or a function. For example http://mysite.com/contacts will call the controller called Contacts. This controller can be a php Class or a simple function.

The default targeted method is index(), so if you have:

http://mysite.com/home

The class Home will be called and the method index() will be executed.

http://mysite.com/home/map

The class Home will be called and the method map() will be executed. If the method map is not present in the chosen class, this value "map" will be added to the params array.

The params array, is an array that will contain all the parameters after the controller/method:

http://mysite.com/home/map/1/NewYork

This will execute Home controller map() method and it will pass two parameters.

Main fiels:

• Route.php
• .htaccess - optional

Example files:

• index.php
• controllers/Home.php
• controllers/About.php
• controllers/Contact.php

How to use:

You may put Route.php wherever you want, but .htaccess
must be in the site root folder! The .htaccess file is used to remove
the need of the /index.php/ file call in the URI.

IMPORTANT .htaccess works only on apache2 server with rewrite enabled.

sudo a2enmod rewrite

...also you need to enable AllowOverride All, in the 000-default.conf file, add this after the line DocumentRoot /var/www/html. If your root html directory is something other, then write that:

<Directory "/var/www/html">
	AllowOverride All
</Directory>

After doing everything, restart apache using the command sudo service apache2 restart.

File: .htaccess

<IfModule mod_rewrite.c>
	RewriteEngine On
	RewriteBase /bau/
	RewriteCond %{REQUEST_FILENAME} !-f
	RewriteCond %{REQUEST_FILENAME} !-d
	RewriteRule ^(.+)$ index.php/$1 [QSA,L]
</IfModule>

Replace /projects/php.class.MiniRoute/ with your site path.

File: index.php

<?php

// Including Route.php Class
require ('lib/Route.php');

// Including controllers
require ('controllers/Home.php');
require ('controllers/Contact.php');
require ('controllers/About.php');

// Instantiating new $route Object and set some settings
$route = new Route([
  "view_path" => "./views/"
]);

// when using Classes
$route->add('/', 'Home');
$route->add('/about', 'About');
$route->add('/contact', 'Contact');

// when using functions
$route->add('/map', function() use ($route) {
    echo 'this is a func for map';
});

$route->submit();

To be able to receive parameters in a Class method or function callback,
you need to pass the instance of the Route class.

$route->add('/contact', function() use ($route) {

	// pretty parameters
    $route->getParams();

    // query string parameters
    $route->getData();
});

class Contact {

    function index(Route $route) {

		// pretty parameters
        $route->getParams();

        // query string parameters
        $route->getData();
    }
}

Use the render method to load php views

class About {

    public function index(Route $route) {
        $route->render("about", [
            "title"  => "About Page",
            "params" => $route->getParams(),
            "query"  => $route->getData(),
        ]);
    }
}