The project is template for blank PHP project based on MVC architecture.
The application is seperated to controllers (handling requests), models (handling database data)
and views (rendering templates).
Tags: PHP, MVC
This project was created for purpose to easily create solution for simple MVC application.
The application doesn't require any specia configuration besided .env file. You can create env file
manually or copy file .env.example to new file with name .env.
Example of .env file:
APP_NAME=MVC App
APP_URL=http://localhost
DB_HOST=
DB_USER=
DB_PASS=
DB_NAME=
First you will need define environment variables in file .env to ensure
that connection to MySQL database can be done. Fill out DB_HOST, DB_USER, DB_PASS and DB_NAME variables:
DB_HOST=
DB_USER=
DB_PASS=
DB_NAME=
Then you can execute SQL queries using methods fetchOne, fetchAll or execute.
<?php
use Lib\Application\DB;
...
$result = DB::fetchAll('SELECT * FROM users');
...When you are using parameters that you pass to SQL query, you should replace values in SQL query with key :name_of_column and values then pass to second parameter, in which expects associative array of values with keys as name of columns.
<?php
use Lib\Application\DB;
...
$result = DB::execute('INSERT INTO users(first_name, last_name, login, password) VALUES(:first_name, :last_name, :login, :password)', [
'first_name' => $firstName,
'last_name' => $lastName,
'login' => $login',
'password' => $password
]);
...Models are entity objects that interact with database and each model corresponds to its database table. Models allow you easily interact with database using their methods such as finding records by their primary key, saving them with current state of their data or deleting them.
First you will need to create new class for your model. Each model should extends base model class \Lib\Application\Model and should be located in
app/models directory. Name of class should be in pascal case to easily resolve table name for its model.
<?php
namespace App\Models;
use Lib\Application\Model;
class User extends Model
{
...
}If you have custom defined table names you can override name of table that corresponds to your model using protected property with type string.
If you define $tableName predefined query methods will use this name and will not resolve based on class name.
<?php
namespace App\Models;
use Lib\Application\Model;
class User extends Model
{
protected string $tableName = 'wp_users';
...
}You can populate model attributes with associative array using static methods create, update or with method fill on instance.
These methods will set only attributes that are listed in $fillable field so you should override base model field with your columns:
<?php
namespace App\Models;
use Lib\Application\Model;
class User extends Model
{
protected string $fillable = [
'fullname',
'username',
'email'
];
...
}If you don't want to populate some columns while querieng records from database, you can use $hidden field
to list column names that you don't want to be populated if you use methods like find, findMany or all.
You could that by overriding this field like this:
<?php
namespace App\Models;
use Lib\Application\Model;
class User extends Model
{
protected string $hidden = [
'password'
];
...
}Controller is object that contains methods for handling individual requests based on given url. Controllers should handle user's input, communicate with DB and respond to user with result.
URLs are resolved by schema https://example.com/{CONTROLLER}/{ACTION}/{PARAMETER}. Final URL should look like
https://example.com/users/get/1 where:
- controller is
UsersController - action will be handler by
UsersControllermethodgetAction - parameter will be
1
First you will need to create you controller class in app\controllers directory that will be extending from class \Lib\Application\Controller.
Name of class should contains Controller and should be in pascal case to find its file.
Each action corresponds to controller's method ended with Action in name.
<?php
namespace App\Controllers;
use Lib\Application\Controller;
class UsersController extends Controller
{
....
public function getAction()
{
}
}You can respond to user with some view template using .phtml file. Views are located in app/views directory and can be rendered
by controller's method renderView($view, $data) or returning response object with view($view, $data) method.
Both functions are expecting view that represents name of view and $data representing data extracted to view template.
View name is based on filepath relative from app/views directory without file extension. Where directory seperator is replaced by ..
So for view file app/views/users/index.phtml should view name be users.index.
<?php
namespace App\Controllers;
use Lib\Application\Controller;
class UsersController extends Controller
{
....
public function indexAction()
{
return $this->response()->view('users.index');
}
}If you want to respond to user with JSON data you can return response object with json($data) method through response() method on controller isntance.
<?php
namespace App\Controllers;
use Lib\Application\Controller;
class UsersController extends Controller
{
....
public function indexAction()
{
return $this->response()->json([
'users' => [
...
]
]);
}
}Views seperate presentational logic from business logic and data from database. View templates are located in app/views directory and actual template is .phtml file.
View templates are HTML files in which are extracted data from controller and PHP functions can be also used in templates. Simple template might look like this:
<html>
<head>
</head>
<body>
<h1><?= $data['title'] ?></h1>
</body>
</html>