Slenderguy55
Local Build Optimizer
2
MONTHS
2 2 MONTHS OF SERVICE
LEVEL 1
400 XP
In this tutorial, we will explore the creation of a straightforward PHP Routing System for a PHP project that utilizes an MVC (Model, View, and Controller) framework. Throughout this tutorial, I will help you grasp the concept of routing within a PHP project and provide PHP Scripts to create a basic web application with routing functionality.
But before we delve into the coding part, let's first understand the purpose of routing within the context of the MVC architectural pattern.
What is Routing in PHP MVC Framework?
In essence, Routing is a process within the script that maps the intended Controller and Action to be executed based on the requested URL. It offers the advantage of cleaner URLs and enhances the overall structure of your web application.
Implementing a Routing System in your PHP project can also result in the generation of SEO-friendly URLs. For example, consider a simple eCommerce System in PHP that includes a list.php file displaying a list of products. This file is typically associated with the Product Controller of the system's framework. Instead of using a URL like [https://samplestore.com/index.php?controller=Product&view=list]
, you can have a cleaner and more user-friendly URL like [https://samplestore.com/product/list]
Now, let's move on to the coding part of this tutorial.
As mentioned earlier, I will provide a simple web application developed in the PHP programming language that incorporates a Routing System to offer you a practical demonstration of the process.
The application that we'll create contains the following files:
- controllers
-- Index.php
-- Users.php
- .htaccess
- index.php
- routes.php
Modifying the URL Rule using .htaccess
First, we'll start by creating a .htaccess file that includes a script to modify or rewrite the URL rules for our application.
#Activate ModRewrite
RewriteEngine On
#let the folders and files to be access
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
#Rewrite URL
RewriteRule ^(.*)$ index.php?route=$1 [QSA,L]
On the script provided above, it shows that the page will be redirected directly to index.php except of the URL provided leads to a folder or files. The parameters on the URL will serve as the route.
Creating a Routing Class?
Next, let's create a PHP class for the routing system. In this example, the file is known as routes.php. The file contains the following script:
The provided script file explains that the list of permitted routes in this application is defined as $routes. Each item in this array contains an array of data with the following details:
The Routing class includes an object or function that validates the current page URL. If the current URL is found in the list of allowed routes, the controller and other essential information needed for the page will be stored for executing the route or page's intended purpose.
Creating the index file
Now, let's craft the application's index file. This vital file is responsible for loading the routes.php file, which, in turn, initiates the routing class.
Creating the Controllers
Finally, it's time to generate the (2) two controllers required for this application. These controllers house the actions responsible for producing sample content.
Index.php
Users.php
Great job! It's time to verify whether the routing system functions as intended.
To conduct a thorough examination of the application's functionality, please navigate to the following URLs:
Note: Replace [appName] with the name assigned to the folder containing your source code files on your system.
If you'd like to test request method mismatches, you can easily execute a curl command in your terminal or command prompt.
curl -X POST "http://localhost/[appName]/user/23"
DEMO VIDEO:
And there you have it! I hope that this PHP MVC Routing Implementation Tutorial will aid your comprehension of the routing system. Please don't hesitate to download the entire source code I've provided and make improvements as needed. You'll find the download button located beneath this article.
For additional Free Source Code, Tutorials, and articles, delve deeper into this website.
Happy Coding =)
Download
But before we delve into the coding part, let's first understand the purpose of routing within the context of the MVC architectural pattern.
What is Routing in PHP MVC Framework?
In essence, Routing is a process within the script that maps the intended Controller and Action to be executed based on the requested URL. It offers the advantage of cleaner URLs and enhances the overall structure of your web application.
Implementing a Routing System in your PHP project can also result in the generation of SEO-friendly URLs. For example, consider a simple eCommerce System in PHP that includes a list.php file displaying a list of products. This file is typically associated with the Product Controller of the system's framework. Instead of using a URL like [https://samplestore.com/index.php?controller=Product&view=list]
, you can have a cleaner and more user-friendly URL like [https://samplestore.com/product/list]
Now, let's move on to the coding part of this tutorial.
As mentioned earlier, I will provide a simple web application developed in the PHP programming language that incorporates a Routing System to offer you a practical demonstration of the process.
The application that we'll create contains the following files:
- controllers
-- Index.php
-- Users.php
- .htaccess
- index.php
- routes.php
Modifying the URL Rule using .htaccess
First, we'll start by creating a .htaccess file that includes a script to modify or rewrite the URL rules for our application.
#Activate ModRewrite
RewriteEngine On
#let the folders and files to be access
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
#Rewrite URL
RewriteRule ^(.*)$ index.php?route=$1 [QSA,L]
On the script provided above, it shows that the page will be redirected directly to index.php except of the URL provided leads to a folder or files. The parameters on the URL will serve as the route.
Creating a Routing Class?
Next, let's create a PHP class for the routing system. In this example, the file is known as routes.php. The file contains the following script:
- <?php
- /**
- * List of routes
- * Data Type = Array
- */
- $routes
=
[
- [
- "pattern"
=>
'/^index$/'
,
- "method"
=>
"ANY"
,
- "controller"
=>
"Index"
- ]
,
- [
- "pattern"
=>
"/^user\/(\d+)$/"
,
- "method"
=>
"GET"
,
- "controller"
=>
"Users"
,
- "page"
=>
"edit"
- ]
,
- ]
;
- /**
- * Routing Class
- */
- class
Routing{
- // route URI
- public
$route
;
- // Controller
- public
$controller
;
- // the object to execute from the controller
- public
$page
;
- // Post, Get, and other Request Data
- public
$params
=
[
]
;
- // URI parameter = the controller's object argument(s)
- public
$args
=
[
]
;
- public
function
__construct(
$route
=
''
)
{
- if
(
!
empty
(
$route
)
)
{
- $this
->
route
=
$route
;
- // Validate route
- if
(
$this
->
validate_route
(
)
)
{
- // If route is valid
- ob_start
(
)
;
- // load the controller class
- include_once
(
"controllers/{$this->controller}
.php"
)
;
- if
(
!
$this
->
page
)
{
- // If page is not set
- $this
->
page
=
'index'
;
- }
- // Initializing the controller with the request data
- $controller
=
new
(
$this
->
controller
)
(
$this
->
params
)
;
- // Execute the object of the class
- $controller
->
{
$this
->
page
}
(
...
$this
->
args
)
;
- echo
ob_get_clean
(
)
;
- }
else
{
- // Throw an Error if route is not valid
- throw
new
ErrorException(
"Undefined Route."
)
;
- }
- }
else
{
- // Throw an Error if route is not defined
- throw
new
ErrorException(
"Undefined Route."
)
;
- }
- }
- protected
function
validate_route(
)
{
- global
$routes
;
- foreach
(
$routes
as
$route
)
{
- /**
- * Check if the route is allowed
- */
- if
(
preg_match
(
$route
[
'pattern'
]
,
$this
->
route
,
$matches
)
)
{
- /**
- * Checking if the provided method and the request method are match
- */
- if
(
$route
[
'method'
]
!=
"ANY"
)
{
- if
(
$route
[
'method'
]
!=
$_SERVER
[
'REQUEST_METHOD'
]
)
{
- throw
new
ErrorException(
"Request Method is denied!"
)
;
- }
- }
- /**
- * Defining the Arguments
- */
- if
(
isset
(
$matches
[
1
]
)
)
{
- if
(
!
is_array
(
$matches
[
1
]
)
)
{
- $this
->
args
=
[
$matches
[
1
]
]
;
- }
else
{
- $this
->
args
=
$matches
[
1
]
;
- }
- }
- /**
- * Defining the class Object
- */
- if
(
isset
(
$route
[
'page'
]
)
)
- $this
->
page
=
$route
[
'page'
]
;
- /**
- * Defining the class name
- */
- $this
->
controller
=
$route
[
'controller'
]
;
- // Store POST Request Data
- $this
->
params
[
'post'
]
=
$_POST
?? [
]
;
- // Store GET Request Data
- $this
->
params
[
'get'
]
=
$_GET
?? [
]
;
- // merging matches with params
- $this
->
params
=
array_merge
(
$this
->
params
,
array_filter
(
$matches
)
)
;
- return
true
;
- }
- }
- return
false
;
- }
- }
- ?>
The provided script file explains that the list of permitted routes in this application is defined as $routes. Each item in this array contains an array of data with the following details:
- pattern: The URL pattern to match with the current page URL.
- method: This will be used to check the request method.
- controller: The controller name to execute.
- page: The action from the controller to execute. Default: 'index'
The Routing class includes an object or function that validates the current page URL. If the current URL is found in the list of allowed routes, the controller and other essential information needed for the page will be stored for executing the route or page's intended purpose.
Creating the index file
Now, let's craft the application's index file. This vital file is responsible for loading the routes.php file, which, in turn, initiates the routing class.
- <?php
- // Load Routing Class
- require_once
(
'routes.php'
)
;
- /**
- * Execute Page Routing
- * $_GET['route'] = Route to output
- */
- new
Routing(
rtrim
(
$_GET
[
'route'
]
?? ''
,
'/'
)
)
;
Creating the Controllers
Finally, it's time to generate the (2) two controllers required for this application. These controllers house the actions responsible for producing sample content.
Index.php
- <?php
- class
Index{
- protected
$params
=
[
]
;
- function
__construct(
$params
=
[
]
)
- {
- // Define provided parmaters
- $this
->
params
=
$params
;
- }
- public
function
index(
)
{
- // Sample page content
- echo
"<h1>Sample Index Page</h1>"
;
- // Output the prameters available
- echo
"<pre>"
;
- print_r
(
$this
->
params
)
;
- echo
"</pre>"
;
- }
- }
Users.php
- <?php
- class
Users{
- protected
$params
=
[
]
;
- function
__construct(
$params
=
[
]
)
- {
- // Define provided parmaters
- $this
->
params
=
$params
;
- }
- public
function
index(
)
{
- // Sample page content
- echo
"<h1>User List Page!</h1>"
;
- echo
"<pre>"
;
- print_r
(
$this
->
params
)
;
- echo
"</pre>"
;
- }
- public
function
edit(
$user_id
=
''
)
{
- // Sample page content with the argument
- echo
"<h1>EDIT USER with an ID of: [{$user_id}
]</h1>"
;
- }
- }
Great job! It's time to verify whether the routing system functions as intended.
To conduct a thorough examination of the application's functionality, please navigate to the following URLs:
Note: Replace [appName] with the name assigned to the folder containing your source code files on your system.
Loading…
localhost
Loading…
localhost
If you'd like to test request method mismatches, you can easily execute a curl command in your terminal or command prompt.
curl -X POST "http://localhost/[appName]/user/23"
DEMO VIDEO:
And there you have it! I hope that this PHP MVC Routing Implementation Tutorial will aid your comprehension of the routing system. Please don't hesitate to download the entire source code I've provided and make improvements as needed. You'll find the download button located beneath this article.
For additional Free Source Code, Tutorials, and articles, delve deeper into this website.
Happy Coding =)
Download
You must upgrade your account or reply in the thread to view the hidden content.