README

CraftMini is a minimalist PHP framework designed for small projects, learning, or as a foundation for personal framework development.

Features

Routing: Flexible routing system, supporting groups, middleware, named routes, RESTful and API routes.
View Engine: Supports multiple view engines, default is PHP, easily extendable to Blade, Twig, etc.
Session & Flash: Manage sessions, convenient flash messages for one-time notifications.
Database Layer:
- Supports multiple database systems (MySQL, SQLite).
- Supports multiple drivers (mysqli, sqlite3, PDO).
- Adapter pattern for connections and queries.
- Query Builder generates dynamic SQL, separated from the adapter.
- Record Mapper CRUD for each table.
Error & Exception Handling: Error reporting, logging, runtime, parsing, separate exceptions.
Helper: Many utility functions for debugging, var_dump, helper function.
Environment Configuration: Read environment variables from .env, supported by TinyEnv.
Security: Supports secure sessions, maintenance mode, security headers, tokens generation (easily extendable).
Mailing: Simple SMTP mail sending with configuration options.

Basic Usage

Routing:

$router = new Craft\Application\Router();
$router->get('/', [App\Controller\HomeController::class, 'index']);
$router->runInstance();

Controller and View:

use Craft\Application\View;
class HomeController{
    public function index() {
        return View::render('home', ['message' => 'Hello!']);
    }
}

Database:

use App\Model\User;
$test = new User();
$allUsers = $test->all(); // Get all users with Mapper

$User = \Craft\Application\DB::table('users')->select('*')->where('id', 1)->first(); // Get user with Query Builder

Session & Flash:

Craft\Application\Session::flash('msg', 'Success!'); // Set flash message
echo Craft\Application\Session::getFlash('msg'); // Get and clear flash message

System Requirements

PHP >= 7.1
ext-json (For API routes)
TinyEnv
Composer

Installation

Install core framework via Composer (if is not using CraftPHP mini skeleton):

Open your project directory (require having composer.json file) and run:

composer require craftphp/mini-framework:dev-main

Important: Define ROOT_DIR (your project root directory) and INDEX_DIR (your public directory) in your index.php file:

define('ROOT_DIR', __DIR__ . '/'); // The root directory of your project
define('INDEX_DIR', __DIR__ . '/'); // The public directory of your project (where index.php is located)
require ROOT_DIR . 'vendor/autoload.php';

There are some environment variables that should be present in your .env file (create it in your project root if not exists):

## This is the environment configuration file for the Craft PHP framework.
# It contains sensitive information and should not be committed to version control.
APP_URL=http://localhost:8080
APP_NAME=MiniCraft
APP_TIMEZONE=Asia/Ho_Chi_Minh
APP_ENVIRONMENT=development
APP_DEBUG=true

## Maintenance mode configuration
# Set to true to enable maintenance mode, false to disable
MAINTENANCE_MODE=false
# Maintenance mode time configuration
# Set the start and end time for maintenance mode in Unix timestamp format
MAINTENANCE_START_TIME=
MAINTENANCE_END_TIME=

## Database configuration (Used by the DatabaseManager class) [during testing]
# Set the database driver, accept: pdo_mysql, pdo_sqlite, mysqli, sqlite3 (and more if has been added)
DB_DRIVER=pdo_sqlite
# Set the database design connection, only accept: mapper, builder
# Mapper is used for ORM, Builder is used for query builder
DB_DESIGN=builder

# Database mysql configuration
DB_HOST=localhost
DB_PORT=3306
DB_USER=root
DB_PASS=
DB_NAME=manga_reader

# Database sqlite configuration
DB_SQLITE_FILE=manga_reader

Require .htaccess file in your INDEX_DIR (public directory) to route all requests to index.php:

RewriteEngine On

# If the requested file or directory exists, serve it directly
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d

# Otherwise, route all requests to index.php
RewriteRule ^ index.php [QSA,L]

Classes like: Source, Craft error handler will using INDEX_DIR to find logs and source directory.
Create app directory in your project root to store your application files (controllers, models, views, routes, etc).
Create routes handler file with your routing logic: app/Router/web.php and app/Router/api.php (if needed).

// app/Router/web.php
use Craft\Application\Router;
$router = new Router();
$router->get('/', function(){
    return 'Hello, CraftMini!';
});
// Add more routes here...

Add this to your index.php to start CraftMini application (after required Composer autoload):

$app = new Craft\Application\App();
$app->initializeWeb(INDEX_DIR . '/logs'); // Initialize with log directory (need to create it first)
$app->bootWeb(); // Boot web routes

Well done! You can start building your application.

Note: Some other classes of the framework also require specific directory paths:

Craft\Application\View: Uses ROOT_DIR . 'resource/view/' as the default views directory.
Source class: Uses ROOT_DIR . 'source/' as the default source directory.

With CraftPHP mini skeleton, you can create a new project and frame:

composer create-project craftphp/mini-skeleton:dev-main your-project-name

Try to run the built-in PHP server:

php -S localhost:8000 -t public

Contribution

Fork, create a pull request or open an issue to contribute ideas or report bugs. CraftMini is suitable for those who want to learn how to build a PHP framework from scratch or as a foundation for small projects, demos, and experimenting with new ideas.

craftphp / mini-framework

Maintainers

Details