Build a job listing website from the ground up without using any frameworks or libraries (PHP 8, MYSQL) It includes a custom Laravel-like router, controller classes, views, a database layer and a project structure using namespaces and PSR-4 autoloading. It highlights how to structure a PHP project without using any frameworks or libraries.
- PHP 7.4 or higher
- MySQL 5.7 or higher
- Clone the repo into your document root (www, htdocs, etc)
- Create a database called
workopia
- Import the
workopia.sql
file into your database - Rename
config/_db.php
toconfig/db.php
and update with your credentials - Run
composer install
to set up the autoloading - Set your document root to the
public
directory
You will need to set your document root to the public
directory. Here are some instructions for setting the document root for some popular local development tools:
If you are using the PHP built-in server, you can run the following command from the project root:
php -S localhost:8000 -t public
If you are using XAMPP, you can set the document root in the httpd.conf
file. Here is an example:
DocumentRoot "C:/xampp/htdocs/workopia/public"
<Directory "C:/xampp/htdocs/workopia/public">
If you are using MAMP, you can set the document root in the httpd.conf
file. Here is an example:
DocumentRoot "/Applications/MAMP/htdocs/workopia/public"
<Directory "/Applications/MAMP/htdocs/workopia/public">
If you are using Laragon, you can set right click the icon in the system tray and go to Apache > sites-enabled > auto.workopia.test.conf
. Your file may be named differently.
You can then set the document root. Here is an example:
<VirtualHost *:80>
DocumentRoot "C:/laragon/www/workopia/public"
ServerName workopia.test
ServerAlias *.workopia.test
<Directory "C:/laragon/www/workopia/public">
AllowOverride All
Require all granted
</Directory>
</VirtualHost>
Creating a route in routes.php
looks like this:
$router->get('/lisings', 'ListingController@index');
This would load the index
method in the App/controllers/ListingController.php
file.
You can pass in middleware for authorization. This is an array of roles. If you want the route to be accessbile only to logged in users, you would add the auth
role:
$router->get('/listings/create', 'ListingController@create', ['auth']);
If you only want non-logged in users to access the route, you would add the guest
role:
$router->get('/register', 'AuthController@register', ['guest']);
This project has a public directory that contains all of the assets like CSS, JS and images. This is where the index.php
file is located, which is the entry point for the application.
You will need to set your document root to the public
directory.
All of the core files for this project are in the Framework
directory. This includes the following files:
- Database.php - Database connection and query method (PDO)
- Router.php - Router logic
- Session.php - Session logic
- Validation.php - Simple validations for strings, email and matching passwords
- Authorization.php - Handles resource authorization
- middleware/Authorize.php - Handles authorization middleware for routes
This project uses PSR-4 autoloading. All of the classes are loaded in the composer.json
file:
"autoload": {
"psr-4": {
"Framework\\": "Framework/",
"App\\": "App/"
}
}
This project uses namespaces for all of the classes. Here are the namespaces used:
- Framework - All of the core framework classes
- Framework\Router - All of the router classes
- Framework\Session - All of the session classes
- Framework\Validation - All of the validation classes
- Framework\Authorization - All of the authorization classes
- Framework\Middleware\Authorize - Authorization middleware
- App\Controllers - All of the controllers
The App
directory contains all of the main application files like controllers, views, etc. Here is the directory structure:
- controllers/ - Contains all of the controllers including listings, users, home and error
- views/ - Contains all of the views
- views/partials/ - Contains all of the partial views
- /index.php - Entry point for the application
- public/.htaccess - Handles the URL rewriting
- /helpers.php - Contains helper functions
- /routes.php - Contains all of the routes
- /config/db.php - Contains the database configuration
- composer.json - Contains the composer dependencies