JamminCoder / Phox

A lightweight, powerful, yet easy to understand MVC framework for PHP.

Phox

A lightweight, powerful, minimalistic, easy to understand MVC framework for PHP. This framework is very similar to Laravel, but much more lightweight, and meant for apps that are a little to big to not use a framework, but too small to use something like Laravel.

Models are still experimental. They can only save data at the moment.

Basic overview

public/index.php is the entery point for the framework. All requests are sent here.
Routes are registered public/index.php, the router takes care of assigning different actions for each route.
Controllers are placed in Phox/Controllers/.
Models are places in Phox/Models (Not implemented yet).
Views are stored in views/ and are rendered with the Twig template engine.

You may use DB::query() to make secure queries to the DB after you call DB::connect()

Register routes in index.php:

<?php

require_once __DIR__ . '/../config/ini.php';
require_once __DIR__ . '/../vendor/autoload.php';


use Phox\Router\Router;

// Use Router::get for retreiving pages and data.
Router::get('/hello', function () {
  return 'Hello, Phox!';
});

// Use Router::post() for posting data
Router::post('/post-name', function () {
  $name = $_POST['name'];
  
  // do something with $name...
});

Use the View::render() function to load views:

// public/index.php

use Phox\View\View;

Router::get('', function () {
  View::render('home.php'); // load views/home.php
});

<!-- views/home.php -->

<h1>Welcome to the home page!</h1>

Pass in data to Twig views:

<?php

use Phox\View\View;

Router::get('/home', function () {
    return View::render('home.php', ['name' => 'john', 'height' => '5`6']);
});

Then you can access the variables from the Twig template:

Hello, I'm {{ name }}, my height is {{ height }}.

Read more about the Twig template engine

Use URI segments to pass in parameters (EXPERIMENTAL)

// public/index.php


// When '/article/1' is visited in the browser, this will display 'Welcome to article 1', 
// When 'article/2' is visitid, this will display 'Welcome to article 2'
Router::get('/article/{id}', function ($id) {
  return "Welcome to article $id";
});

Use controllers instead of closures in routes:

// Phox/Controllers/HomeController.php
<?php

namespace Phox\Controllers;

class HomeController {
  public static function home () {
    return View::render('home.php');
  }
  
  public static function displayFunnyMessage () {
    return 'Eat that bagel or the bagel will eat you.';
  }
  
};

// public/index.php

use Phox\Controllers\HomeController;

Router::get('/home', [HomeController::class, 'home']);
Router::get('/funny', [HomeController::class, 'displayFunnyMessage']);

Breif overview of Models (EXPERIMENTAL)

<?php

// File: `phox/Models/User.php`

namespace Phox\Models;
use Phox\Models\Model;

class User extends Model {
	public $table = 'users'; // Name of DB table to use.

	// All of the columns that are to be filled with this Model
	// must be listed here.
	public array $fillable [
		'username',
		'password,
		'uuid'
	];
};

Then you can create a new instance of a the Model, assign it data, and save it:

<?php
use Phox\Models\User;

// Create a new user and store their info in the DB
$user = new User([
	'username' => $_POST['username'],
	'password' => password_hash($_POST['password'], PASSWORD_BCRYPT),
	'uuid' => bin2hex(random_bytes(32));
]);

$user->save(); // Save the user

Use the DB class to make queries to the database securly.

<?php
// index.php

use Phox\Database\DB;
// The DB file can be anywhere really, just not in the public/ folder!
$DBFilePath = '../database.php';
/**
 * Your DB file should look like this:
 * 
 * <?php
 * $dbPassword = 'database_password';
 * $dbUsername = 'database_user';
 * $dbName = 'database_name';
 * $dbHost = "localhost";
 * $dbType = "mysql";
 * $pdoOptions = array (PDO::ATTR_PERSISTENT => true);
 */

// DB::connect() only needs to be called once, usually this is done in the `index.php` file.

DB::connect($DBFilePath);

Once DB::connect is called, you can make queries from any file just by inlcuding the DB class:

namespace Phox\Controllers;
use Phox\Database\DB;

class ExampleController {
  public static funciton databaseDemo () {
    return DB::query('SELECT * FROM users WHERE username = "john_doe";');
  }
};

More documentation to come!