Flight PHP Framework

https://docs.flightphp.com/en/v3
Admin
Flight is a fast, simple, and extensible micro-framework for PHP, designed for quickly building web...
Tokens:105,230
Snippets:1,275
Trust Score:8.2
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install the Flight Skeleton App

Source: https://docs.flightphp.com/en/v3

Use Composer to initialize a new project and start the local development server.

```bash
# Create the new project
composer create-project flightphp/skeleton my-project/
# Enter your new project directory
cd my-project/
# Bring up the local dev-server to get started right away!
composer start
```

--------------------------------

### Initialize LLM Credentials

Source: https://docs.flightphp.com/en/v3/single-page

Run this command to start the interactive setup process for connecting an LLM provider to the project.

```bash
php runway ai:init
```

--------------------------------

### Install EasyQuery

Source: https://docs.flightphp.com/en/v3/single-page

Install the library via Composer.

```bash
composer require knifelemon/easy-query
```

--------------------------------

### Install Simple Job Queue

Source: https://docs.flightphp.com/en/v3/single-page

Install the library via Composer.

```bash
composer require n0nag0n/simple-job-queue
```

--------------------------------

### LLM Initialization Output Example

Source: https://docs.flightphp.com/en/v3/single-page

Example of the interactive prompts displayed during the ai:init command execution.

```text
Welcome to AI Init!
Which LLM API do you want to use? [1] openai, [2] grok, [3] claude: 1
Enter the base URL for the LLM API [https://api.openai.com]:
Enter your API key for openai: sk-...
Enter the model name you want to use (e.g. gpt-4, claude-3-opus, etc) [gpt-4o]:
Credentials saved to .runway-creds.json
```

--------------------------------

### Install and Configure FlightMail

Source: https://docs.flightphp.com/en/v3/single-page

Initial setup for the FlightMail plugin using the standard installation method.

```php
use ryanstubbs\FlightMail\MailPlugin;

// Tell FlightMail where to send mail from and through.
MailPlugin::install([
    'dsns' => [
        'default' => 'smtp://user:pass@localhost:1025',
    ],
    'from' => 'no-reply@example.com',
]);

Flight::route('/signup', function () {
    Flight::mail()->compose()
        ->to('new-user@example.com')
        ->subject('Welcome aboard!')
        ->html('<h1>Welcome!</h1><p>We are glad you are here.</p>')
        ->send();
});

Flight::start();
```

--------------------------------

### Install Session Plugin

Source: https://docs.flightphp.com/en/v3/single-page

Command to install the session handler via Composer.

```bash
composer require flightphp/session
```

--------------------------------

### Install ActiveRecord via Composer

Source: https://docs.flightphp.com/en/v3/single-page

Use this command to install the library in your project.

```bash
composer require flightphp/active-record
```

--------------------------------

### Install Composer locally

Source: https://docs.flightphp.com/en/v3/single-page

Downloads the Composer installer script and executes it with PHP to create a local composer.phar file.

```bash
$ curl -sS https://getcomposer.org/installer | php
```

--------------------------------

### Install Migration Library via Composer

Source: https://docs.flightphp.com/en/v3/single-page

Commands to install the migration library or the standalone CLI tool.

```bash
composer require "byjg/migration"
```

```bash
composer require "byjg/migration-cli"
```

--------------------------------

### Install FlightPHP Async

Source: https://docs.flightphp.com/en/v3/single-page

Composer command to install the Async package.

```bash
composer require flightphp/async
```

--------------------------------

### SELECT Queries

Source: https://docs.flightphp.com/en/v3/single-page

Examples of selecting columns and using table aliases.

```php
// Select all columns
$q = Builder::table('users')->build();
// SELECT * FROM users

// Select specific columns
$q = Builder::table('users')
    ->select(['id', 'name', 'email'])
    ->build();
// SELECT id, name, email FROM users

// With table alias
$q = Builder::table('users')
    ->alias('u')
    ->select(['u.id', 'u.name'])
    ->build();
// SELECT u.id, u.name FROM users AS u
```

--------------------------------

### Run Built-in PHP Server

Source: https://docs.flightphp.com/en/v3/single-page

Command to start the development server.

```bash
php -S localhost:8000 -t public/
```

--------------------------------

### EasyQuery Quick Start

Source: https://docs.flightphp.com/en/v3/single-page

Construct a query and execute it using Flight's SimplePdo.

```php
use KnifeLemon\EasyQuery\Builder;

$q = Builder::table('users')
    ->select(['id', 'name', 'email'])
    ->where(['status' => 'active'])
    ->orderBy('created_at DESC')
    ->limit(10)
    ->build();

// Use with Flight's SimplePdo
$users = Flight::db()->fetchAll($q['sql'], $q['params']);
```

--------------------------------

### Install Session Manager

Source: https://docs.flightphp.com/en/v3/single-page

Composer command to install the Ghostff/Session package.

```bash
composer require ghostff/session
```

--------------------------------

### Install CommentTemplate

Source: https://docs.flightphp.com/en/v3/single-page

Install the CommentTemplate package via Composer.

```bash
composer require knifelemon/comment-template
```

--------------------------------

### Project Directory Structure

Source: https://docs.flightphp.com/en/v3/single-page

Example of a standard project file organization.

```text
project/
├── source/
│   ├── layouts/
│   │   └── default.php
│   ├── components/
│   │   ├── header.php
│   │   └── footer.php
│   ├── css/
│   │   ├── bootstrap.min.css
│   │   └── custom.css
│   ├── js/
│   │   ├── app.js
│   │   └── bootstrap.min.js
│   └── homepage.php
├── public/
│   └── assets/           # Generated assets
│       ├── css/
│       └── js/
└── vendor/
```

--------------------------------

### Install Swoole via PECL or Package Manager

Source: https://docs.flightphp.com/en/v3/single-page

Commands to install the Swoole extension on your system.

```bash
pecl install swoole
# or openswoole
pecl install openswoole

# or with a package manager (Debian/Ubuntu example)
sudo apt-get install php-swoole
```

--------------------------------

### Skeleton-style Namespace Example

Source: https://docs.flightphp.com/en/v3/single-page

Example of a standard PSR-style namespace structure.

```php
/**
 * app/Controller/MyController.php
 */
namespace App\Controller;

class MyController {
    // ...
}
```

--------------------------------

### Install and Manage PHP on Rocky Linux

Source: https://docs.flightphp.com/en/v3/install

Commands for configuring repositories, installing PHP versions, and switching modules using dnf.

```bash
sudo dnf install epel-release
```

```bash
sudo dnf install https://rpms.remirepo.net/enterprise/remi-release-8.rpm
sudo dnf module reset php
```

```bash
sudo dnf install php
```

```bash
sudo dnf module install php:remi-7.4
```

```bash
sudo dnf module reset php
sudo dnf module enable php:remi-8.0
sudo dnf install php
```

```bash
php -v
```

--------------------------------

### Install FlightMail and Dependencies

Source: https://docs.flightphp.com/en/v3/single-page

Composer commands to install the plugin and optional template or enhancement libraries.

```bash
composer require ryanstubbs/flightmail
```

```bash
composer require twig/twig      # for .twig templates
composer require latte/latte    # for .latte templates
```

```bash
composer require pelago/emogrifier         # for CSS inlining ("inline_css")
composer require league/html-to-markdown   # for Markdown text parts ("text_from_html")
```

--------------------------------

### Install and Manage PHP on Ubuntu

Source: https://docs.flightphp.com/en/v3/install

Commands for updating packages, installing PHP versions, managing modules, and switching versions via update-alternatives.

```bash
sudo apt update
```

```bash
sudo apt install php
```

```bash
sudo apt install php8.1
```

```bash
sudo apt install php8.1-mysql
```

```bash
sudo update-alternatives --set php /usr/bin/php8.1
```

```bash
php -v
```

--------------------------------

### Install Supervisord

Source: https://docs.flightphp.com/en/v3/single-page

Commands to install the supervisor process control system on various operating systems.

```bash
# On Ubuntu/Debian
sudo apt-get install supervisor

# On CentOS/RHEL
sudo yum install supervisor

# On macOS with Homebrew
brew install supervisor
```

--------------------------------

### Initialize CommentTemplate

Source: https://docs.flightphp.com/en/v3/single-page

Basic setup for the CommentTemplate engine.

```php
<?php
require_once 'vendor/autoload.php';

use KnifeLemon\CommentTemplate\Engine;

$app = Flight::app();
```

--------------------------------

### Bootstrap swoole_server.php

Source: https://docs.flightphp.com/en/v3/single-page

The main entry point that initializes the Flight app and conditionally starts the Swoole server driver.

```php
// swoole_server.php
<?php

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

$app = Flight::app();

$app->route('/', function() use ($app) {
    $app->json(['hello' => 'world']);
});

if (!defined('NOT_SWOOLE')) {
    // Require the SwooleServerDriver class when running in Swoole mode.
    require_once __DIR__ . '/SwooleServerDriver.php';

    Swoole\Runtime::enableCoroutine();
    $Swoole_Server = new SwooleServerDriver('127.0.0.1', 9501, $app);
    $Swoole_Server->start();
} else {
    $app->start();
}
```

--------------------------------

### Install Flight Core via Composer

Source: https://docs.flightphp.com/en/v3/install

Use this command to install only the core Flight framework files without additional project scaffolding.

```bash
composer require flightphp/core
```

--------------------------------

### Install Tracy Debugger

Source: https://docs.flightphp.com/en/v3/single-page

Install the Tracy Debugger package via Composer.

```bash
composer require tracy/tracy
```

--------------------------------

### Install Flight Cache via Composer

Source: https://docs.flightphp.com/en/v3/single-page

Command to install the standalone file caching library.

```bash
composer require flightphp/cache
```

--------------------------------

### Define Route and Controller

Source: https://docs.flightphp.com/en/v3/single-page

Example of routing to a controller and implementing a register method with dependency injection.

```php
// index.php
$app->route('POST /register', [ UserController::class, 'register' ]);

// UserController.php
class UserController {
    protected $app;

    public function __construct(flight\Engine $app) {
        $this->app = $app;
    }

    public function register() {
        $email = $this->app->request()->data->email;
        $responseArray = [];
        if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
            $responseArray = ['status' => 'error', 'message' => 'Invalid email'];
        } else {
            $responseArray = ['status' => 'success', 'message' => 'Valid email'];
        }

        $this->app->json($responseArray);
    }
}
```

--------------------------------

### Install PHPUnit via Composer

Source: https://docs.flightphp.com/en/v3/single-page

Installs the PHPUnit testing framework as a development dependency in a PHP project.

```bash
composer require --dev phpunit/phpunit
```

--------------------------------

### AI Instruction Generation Output Example

Source: https://docs.flightphp.com/en/v3/single-page

Example of the interactive prompts displayed during the ai:generate-instructions command execution.

```text
Please describe what your project is for? My awesome API
What database are you planning on using? MySQL
What HTML templating engine will you plan on using (if any)? twig
Is security an important element of this project? (y/n) y
...
AI instructions updated successfully.
```

--------------------------------

### Initialize database connection and insert records

Source: https://docs.flightphp.com/en/v3/single-page

Examples of connecting to various database types and inserting new records using the User model.

```php
// for sqlite
$database_connection = new PDO('sqlite:test.db'); // this is just for example, you'd probably use a real database connection

// for mysql
$database_connection = new PDO('mysql:host=localhost;dbname=test_db&charset=utf8bm4', 'username', 'password');

// or mysqli
$database_connection = new mysqli('localhost', 'username', 'password', 'test_db');
// or mysqli with non-object based creation
$database_connection = mysqli_connect('localhost', 'username', 'password', 'test_db');

$user = new User($database_connection);
$user->name = 'Bobby Tables';
$user->password = password_hash('some cool password');
$user->insert();
// or $user->save();

echo $user->id; // 1

$user->name = 'Joseph Mamma';
$user->password = password_hash('some cool password again!!!');
$user->insert();
// can't use $user->save() here or it will think it's an update!

echo $user->id; // 2
```

--------------------------------

### Define Routes with Controllers

Source: https://docs.flightphp.com/en/v3/single-page

Examples of routing to controller methods using different namespace and folder structures.

```php
// if your MyController is in app/Controller (skeleton) and namespaced App\Controller
// this will not work:
Flight::route('/hello', 'MyController->hello');

// Skeleton-style:
use App\Controller\MyController;
Flight::route('/hello', [ MyController::class, 'hello' ]);

// Older lowercase layout (only if your folders are actually app/controllers):
use app\controllers\MyController;
Flight::route('/hello', [ MyController::class, 'hello' ]);
// or fully qualified:
Flight::route('/hello', [ 'App\Controller\MyController', 'hello' ]);
```

--------------------------------

### Install PHP via Homebrew

Source: https://docs.flightphp.com/en/v3/install

Commands for installing the latest or specific versions of PHP on macOS.

```bash
brew install php
```

```bash
brew tap shivammathur/php
brew install shivammathur/php/php@8.1
```

--------------------------------

### Verify PHP Installation on Windows

Source: https://docs.flightphp.com/en/v3/install

Command to check the installed PHP version in the Windows Command Prompt.

```bash
php -v
```

--------------------------------

### Comprehensive SimplePdo Usage Example

Source: https://docs.flightphp.com/en/v3/single-page

Demonstrates various query types, inserts, updates, deletes, and transactions in a single route.

```php
Flight::route('/users', function () {
    // Get all users
    $users = Flight::db()->fetchAll('SELECT * FROM users');

    // Stream all users
    $statement = Flight::db()->runQuery('SELECT * FROM users');
    while ($user = $statement->fetch()) {
        echo $user['name'];
    }

    // Get a single user
    $user = Flight::db()->fetchRow('SELECT * FROM users WHERE id = ?', [123]);

    // Get a single value
    $count = Flight::db()->fetchField('SELECT COUNT(*) FROM users');

    // Get a single column
    $ids = Flight::db()->fetchColumn('SELECT id FROM users');

    // Get key-value pairs
    $userNames = Flight::db()->fetchPairs('SELECT id, name FROM users');

    // Special IN() syntax
    $users = Flight::db()->fetchAll('SELECT * FROM users WHERE id IN (?)', [[1,2,3,4,5]]);

    // Insert a new user
    $id = Flight::db()->insert('users', [
        'name' => 'Bob',
        'email' => 'bob@example.com'
    ]);

    // Bulk insert users
    Flight::db()->insert('users', [
        ['name' => 'Bob', 'email' => 'bob@example.com'],
        ['name' => 'Jane', 'email' => 'jane@example.com']
    ]);

    // Update a user
    $affected = Flight::db()->update('users', ['name' => 'Bob'], 'id = ?', [123]);

    // Delete a user
    $deleted = Flight::db()->delete('users', 'id = ?', [123]);

    // Use a transaction
    $result = Flight::db()->transaction(function($db) {
        $db->insert('users', ['name' => 'John', 'email' => 'john@example.com']);
        $db->insert('audit_log', ['action' => 'user_created']);
        return $db->lastInsertId();
    });
});
```

--------------------------------

### Fetch Field Example

Source: https://docs.flightphp.com/en/v3/single-page

Demonstrates fetching a single field using the database connection.

```php
$count = Flight::db()->fetchField($q['sql'], $q['params']);
```

--------------------------------

### Logging Service Placeholder

Source: https://docs.flightphp.com/en/v3/single-page

Example file structure for integrating external libraries like Monolog.

```php
// services.php
```

--------------------------------

### Launch APM Dashboard

Source: https://docs.flightphp.com/en/v3/single-page

Start the built-in PHP server to view the APM dashboard.

```bash
php vendor/bin/runway apm:dashboard
```

```bash
php vendor/bin/runway apm:dashboard --host 0.0.0.0 --port 8080 --php-path=/usr/local/bin/php
```

--------------------------------

### Run Built-in PHP Development Server

Source: https://docs.flightphp.com/en/v3/install

Commands to start the local development server, optionally specifying a public directory.

```bash
php -S localhost:8000
# or with the skeleton app
composer start
```

```bash
php -S localhost:8000 -t public/
# with the skeleton app, this is already configured
composer start
```

--------------------------------

### Full PdoWrapper Usage Example

Source: https://docs.flightphp.com/en/v3/single-page

Demonstrates routing, fetching all records, streaming results, and fetching single records/values.

```php
Flight::route('/users', function () {
    // Get all users
    $users = Flight::db()->fetchAll('SELECT * FROM users');

    // Stream all users
    $statement = Flight::db()->runQuery('SELECT * FROM users');
    while ($user = $statement->fetch()) {
        echo $user['name'];
    }

    // Get a single user
    $user = Flight::db()->fetchRow('SELECT * FROM users WHERE id = ?', [123]);

    // Get a single value
    $count = Flight::db()->fetchField('SELECT COUNT(*) FROM users');
```

--------------------------------

### Install Latte via Composer

Source: https://docs.flightphp.com/en/v3/single-page

Use Composer to add the Latte template engine to your project.

```bash
composer require latte/latte
```

--------------------------------

### Install Composer globally

Source: https://docs.flightphp.com/en/v3/single-page

Moves the local composer.phar file to a system-wide directory and makes it executable.

```bash
$ mv composer.phar /usr/local/bin/composer
$ chmod +x composer
```

--------------------------------

### Configure Multiple Supervisor Pipelines

Source: https://docs.flightphp.com/en/v3/single-page

Example configuration for running distinct worker processes in Supervisor.

```ini
[program:email_worker]
command=php /path/to/email_worker.php
# ... other configs ...

[program:notification_worker]
command=php /path/to/notification_worker.php
# ... other configs ...
```

--------------------------------

### Full Mail Plugin Configuration

Source: https://docs.flightphp.com/en/v3/single-page

Reference for all available configuration options during plugin installation.

```php
MailPlugin::install([
    // REQUIRED - transport name => Symfony DSN.
    // The first entry is used when a message doesn't name one.
    'dsns' => [
        'default' => 'smtp://user:pass@localhost:1025',
    ],

    // Transport used when a message has no explicit ->transport() and
    // you don't want the first key. Must exist in "dsns".
    'default_transport' => 'default',

    // Global sender. String, Symfony Address, or ['email' => 'Name'].
    // Applied only when a message doesn't set its own ->from().
    'from' => ['no-reply@example.com' => 'My App'],

    // Default template engine: 'twig', 'latte', or a custom name.
    // Only consulted for templates whose extension isn't a registered renderer.
    'renderer' => 'twig',

    // Where templates live, searched in order; plus an optional cache dir.
    'templates' => [
        'paths' => [__DIR__ . '/mail-templates'],
        'cache' => __DIR__ . '/cache/mail',
    ],

    // Extra options passed straight to Twig\Environment.
    'twig' => ['options' => ['strict_variables' => true]],

    // Tweak the Latte engine at boot: fn(Latte\Engine $engine): void.
    'latte' => ['setup' => static fn (Latte\Engine $e) => $e->addExtension(new MyExtension())],

    // Send-time body enhancements (see "Styling HTML and generating text parts").
    'inline_css' => true,           // or ['css' => '...', 'css_file' => '...']
    'text_from_html' => true,       // or 'plain' / 'markdown'

    // Custom DSN schemes, custom renderers, pre-send hooks (see below).
    'transport_factories' => [],
    'renderers' => [],
    'hooks' => [],

    // Optional plumbing handed to every transport.
    'event_dispatcher' => $dispatcher,  // Symfony MessageEvents
    'logger' => $psr3Logger,
]);
```

--------------------------------

### Initialize Project with Skeleton

Source: https://docs.flightphp.com/en/v3/install

Recommended approach for new projects to automatically set up directory structure, autoloading, and development tools.

```bash
composer create-project flightphp/skeleton my-project/
cd my-project/
composer start
# optional sample DB + posts demo
php runway migrate
```

--------------------------------

### Install Encryption Library via Composer

Source: https://docs.flightphp.com/en/v3/single-page

Use Composer to add the defuse/php-encryption library to your project.

```bash
composer require defuse/php-encryption
```

--------------------------------

### Define Route and Controller

Source: https://docs.flightphp.com/en/v3/single-page

Example of a route handler and a controller class that uses the Flight engine instance.

```php
// index.php
$app->route('POST /register', [ UserController::class, 'register' ]);

// UserController.php
class UserController {
    protected $app;
    public function __construct(flight\Engine $app) {
        $this->app = $app;
    }
    public function register() {
        $email = $this->app->request()->data->email;
        if (!filter_var($email, FILTER_VALIDATE_EMAIL)) {
            return $this->app->json(['status' => 'error', 'message' => 'Invalid email']);
        }
        return $this->app->json(['status' => 'success', 'message' => 'Valid email']);
    }
}
```

--------------------------------

### Initialize Project Directory

Source: https://docs.flightphp.com/en/v3/single-page

Commands to create and enter the project directory.

```bash
mkdir flight-blog
cd flight-blog
```

--------------------------------

### Install FlightPHP APM

Source: https://docs.flightphp.com/en/v3/single-page

Installs the APM package via Composer.

```bash
composer require flightphp/apm
```

--------------------------------

### Handle HEAD and OPTIONS requests

Source: https://docs.flightphp.com/en/v3/single-page

Examples of how Flight automatically manages HEAD and OPTIONS HTTP requests.

```php
Flight::route('GET /info', function() {
    echo 'This is some info!';
});
// A HEAD request to /info will return the same headers, but no body.
```

```php
// For a route defined as:
Flight::route('GET|POST /users', function() { /* ... */ });

// An OPTIONS request to /users will respond with:
//
// Status: 204 No Content
// Allow: GET, POST, HEAD, OPTIONS
```

--------------------------------

### Database Integration Test Commands

Source: https://docs.flightphp.com/en/v3/single-page

Commands to start test databases and execute integration test suites.

```bash
docker-compose up -d postgres mysql mssql
```

```bash
vendor/bin/phpunit
vendor/bin/phpunit tests/SqliteDatabase*
vendor/bin/phpunit tests/MysqlDatabase*
vendor/bin/phpunit tests/PostgresDatabase*
vendor/bin/phpunit tests/SqlServerDblibDatabase*
vendor/bin/phpunit tests/SqlServerSqlsrvDatabase*
```

--------------------------------

### Using AI Helper Commands

Source: https://docs.flightphp.com/en/v3/single-page

Initialize AI settings and generate project instructions for LLMs.

```bash
php runway ai:init
php runway ai:generate-instructions
```

--------------------------------

### Initialize Migration Instance

Source: https://docs.flightphp.com/en/v3/single-page

Register the database driver and create a migration instance to manage version tables.

```php
<?php
// Register the Database or Databases can handle that URI:
\ByJG\DbMigration\Migration::registerDatabase(\ByJG\DbMigration\Database\MySqlDatabase::class);

// Create the Migration instance
$migration = new \ByJG\DbMigration\Migration($connectionUri, '.');

// This command will create the version table in your database
$migration->createVersion();
```

--------------------------------

### Twig Template and Route Usage

Source: https://docs.flightphp.com/en/v3/single-page

Example of a Twig template file and the corresponding route definition to render it.

```twig
{# app/views/home.twig #}
<html>
  <head>
    <title>{% if title %}{{ title }} - {% endif %}My App</title>
    <link rel="stylesheet" href="style.css">
  </head>
  <body>
    <h1>Hello, {{ name }}!</h1>
  </body>
</html>
```

```php
// routes.php
Flight::route('/@name', function ($name) {
    Flight::render('home.twig', [
        'title' => 'Home Page',
        'name' => $name
    ]);
});
```

--------------------------------

### Implement full CRUD routes

Source: https://docs.flightphp.com/en/v3/single-page

Complete example showing list, create, update, and delete operations within FlightPHP routes.

```php
use KnifeLemon\EasyQuery\Builder;

// List users with pagination
Flight::route('GET /users', function() {
    $page = (int) (Flight::request()->query['page'] ?? 1);
    $perPage = 20;

    $q = Builder::table('users')
        ->select(['id', 'name', 'email', 'created_at'])
        ->where(['status' => 'active'])
        ->orderBy('created_at DESC')
        ->limit($perPage, ($page - 1) * $perPage)
        ->build();

    $users = Flight::db()->fetchAll($q['sql'], $q['params']);
    Flight::json(['users' => $users, 'page' => $page]);
});

// Create user
Flight::route('POST /users', function() {
    $data = Flight::request()->data;

    $q = Builder::table('users')
        ->insert([
            'name' => $data->name,
            'email' => $data->email,
            'created_at' => Builder::raw('NOW()')
        ])
        ->build();

    Flight::db()->runQuery($q['sql'], $q['params']);
    Flight::json(['id' => Flight::db()->lastInsertId()]);
});

// Update user
Flight::route('PUT /users/@id', function($id) {
    $data = Flight::request()->data;

    $q = Builder::table('users')
        ->update([
            'name' => $data->name,
            'email' => $data->email,
            'updated_at' => Builder::raw('NOW()')
        ])
        ->where(['id' => $id])
        ->build();

    Flight::db()->runQuery($q['sql'], $q['params']);
    Flight::json(['success' => true]);
});

// Delete user
Flight::route('DELETE /users/@id', function($id) {
    $q = Builder::table('users')
        ->delete()
        ->where(['id' => $id])
        ->build();
```

--------------------------------

### Compare Traditional vs Flight Routing

Source: https://docs.flightphp.com/en/v3/single-page

Examples demonstrating the difference between manual script-based routing and Flight's centralized routing approach.

```php
// /user/view_profile.php?id=1234
if ($_GET['id']) {
    $id = $_GET['id'];
    viewUserProfile($id);
}

// /user/edit_profile.php?id=1234
if ($_GET['id']) {
    $id = $_GET['id'];
    editUserProfile($id);
}

// etc...
```

```php
// index.php
Flight::route('/user/@id', [ 'UserController', 'viewUserProfile' ]);
Flight::route('/user/@id/edit', [ 'UserController', 'editUserProfile' ]);

// In maybe your app/controllers/UserController.php
class UserController {
    public function viewUserProfile($id) {
        // do something
    }
```

--------------------------------

### Implement ActiveRecord classes with relationships

Source: https://docs.flightphp.com/en/v3/single-page

Example implementation of User and Contact classes demonstrating HAS_MANY, HAS_ONE, and BELONGS_TO relationships.

```php
class User extends ActiveRecord{
    protected array $relations = [
        'contacts' => [ self::HAS_MANY, Contact::class, 'user_id' ],
        'contact' => [ self::HAS_ONE, Contact::class, 'user_id' ],
    ];

    public function __construct($database_connection)
    {
        parent::__construct($database_connection, 'users');
    }
}

class Contact extends ActiveRecord{
    protected array $relations = [
        'user' => [ self::BELONGS_TO, User::class, 'user_id' ],
        'user_with_backref' => [ self::BELONGS_TO, User::class, 'user_id', [], 'contact' ],
    ];
    public function __construct($database_connection)
    {
        parent::__construct($database_connection, 'contacts');
    }
}
```

--------------------------------

### Install Homebrew on macOS

Source: https://docs.flightphp.com/en/v3/install

Command to install the Homebrew package manager on macOS systems.

```bash
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
```

--------------------------------

### MailPlugin::install

Source: https://docs.flightphp.com/en/v3/single-page

Configures and initializes the MailPlugin with transport DSNs and global settings.

```APIDOC
## MailPlugin::install

### Description
Initializes the mail plugin with required transport configurations and optional settings for templates, CSS inlining, and global defaults.

### Parameters
- **options** (array) - Required - Configuration array containing 'dsns' (array of transport name to DSN string), 'default_transport' (string), 'from' (string/array), 'renderer' (string), 'templates' (array), 'inline_css' (bool/array), and 'text_from_html' (bool/string).
```

--------------------------------

### Create Public Directory

Source: https://docs.flightphp.com/en/v3/single-page

Command to create the web root directory.

```bash
mkdir public
```

--------------------------------

### Define Runway AI Helper Wrapper

Source: https://docs.flightphp.com/en/v3/single-page

Example of using addOption within a Runway command constructor to facilitate AI-generated command arguments.

```php
public function __construct(array $config)
{
    parent::__construct('make:example', 'Create an example for the documentation', $config);

    // The mode argument is nullable and defaults to completely optional
    $this->addOption('name', 'The name of the example', null);
}
```

--------------------------------

### Initialize Database Connections

Source: https://docs.flightphp.com/en/v3/single-page

Demonstrates three ways to provide a PDO connection to the User model: via constructor, configuration array, or the setDatabaseConnection method.

```php
$pdo_connection = new PDO('sqlite:test.db'); // for example
$user = new User($pdo_connection);
// or
$user = new User(null, [ 'connection' => $pdo_connection ]);
// or
$user = new User();
$user->setDatabaseConnection($pdo_connection);
```

--------------------------------

### Sample Data File

Source: https://docs.flightphp.com/en/v3/single-page

A JSON file used to simulate a database for blog posts.

```json
[
    {
        "slug": "first-post",
        "title": "My First Post",
        "content": "This is my very first blog post with Flight PHP!"
    }
]
```

--------------------------------

### Initialize Permissions

Source: https://docs.flightphp.com/en/v3/single-page

Sets up the permission object with a role and defines a rule for logged-in status.

```php
// index.php
require 'vendor/autoload.php';

// some code 

// then you probably have something that tells you who the current role is of the person
// likely you have something where you pull the current role
// from a session variable which defines this
// after someone logs in, otherwise they will have a 'guest' or 'public' role.
$current_role = 'admin';

// setup permissions
$permission = new \flight\Permission($current_role);
$permission->defineRule('loggedIn', function($current_role) {
    return $current_role !== 'guest';
});

// You'll probably want to persist this object in Flight somewhere
Flight::set('permission', $permission);
```

--------------------------------

### Postgres Trigger Function Examples

Source: https://docs.flightphp.com/en/v3/single-page

Examples of correct and incorrect ways to write SQL trigger functions in Postgres.

```sql
-- DO
CREATE FUNCTION emp_stamp() RETURNS trigger AS $emp_stamp$
    BEGIN
        -- Check that empname and salary are given
        IF NEW.empname IS NULL THEN
            RAISE EXCEPTION 'empname cannot be null'; -- it doesn't matter if these comments are blank or not
        END IF; --
        IF NEW.salary IS NULL THEN
            RAISE EXCEPTION '% cannot have null salary', NEW.empname; --
        END IF; --

        -- Who works for us when they must pay for it?
        IF NEW.salary < 0 THEN
            RAISE EXCEPTION '% cannot have a negative salary', NEW.empname; --
        END IF; --

        -- Remember who changed the payroll when
        NEW.last_date := current_timestamp; --
        NEW.last_user := current_user; --
        RETURN NEW; --
    END; --
$emp_stamp$ LANGUAGE plpgsql;


-- DON'T
CREATE FUNCTION emp_stamp() RETURNS trigger AS $emp_stamp$
    BEGIN
        -- Check that empname and salary are given
        IF NEW.empname IS NULL THEN
            RAISE EXCEPTION 'empname cannot be null';
        END IF;
        IF NEW.salary IS NULL THEN
            RAISE EXCEPTION '% cannot have null salary', NEW.empname;
        END IF;

        -- Who works for us when they must pay for it?
        IF NEW.salary < 0 THEN
            RAISE EXCEPTION '% cannot have a negative salary', NEW.empname;
        END IF;
```

--------------------------------

### Registering Classes with Constructor Parameters

Source: https://docs.flightphp.com/en/v3/single-page

Passing constructor arguments and using callbacks for post-initialization configuration.

```php
// Register class with constructor parameters
Flight::register('db', PDO::class, ['mysql:host=localhost;dbname=test', 'user', 'pass']);

// Get an instance of your class
// This will create an object with the defined parameters
//
// new PDO('mysql:host=localhost;dbname=test','user','pass');
//
$db = Flight::db();

// and if you needed it later in your code, you just call the same method again
class SomeController {
  public function __construct() {
    $this->db = Flight::db();
  }
}
```

```php
// The callback will be passed the object that was constructed
Flight::register(
  'db',
  PDO::class,
  ['mysql:host=localhost;dbname=test', 'user', 'pass'],
  function (PDO $db) {
    $db->setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION);
  }
);
```

--------------------------------

### Update Index File

Source: https://docs.flightphp.com/en/v3/single-page

Initializes the application, registers the view engine, and includes the routes configuration.

```php
<?php
require '../vendor/autoload.php';

use Latte\Engine;

Flight::register('view', Engine::class, [], function ($latte) {
    $latte->setTempDirectory(__DIR__ . '/../cache/');
    $latte->setLoader(new \Latte\Loaders\FileLoader(__DIR__ . '/../app/views/'));
});

require '../app/config/routes.php';

Flight::start();
```

--------------------------------

### Initialize Encryption Library

Source: https://docs.flightphp.com/en/v3/single-page

Import the necessary classes to begin using the encryption library in your bootstrap or index file.

```php
use Defuse\Crypto\Crypto;
use Defuse\Crypto\Key;

/*
 * Set in your bootstrap or public/index.php file
 */
```

--------------------------------

### Tracy Debugger Integration

Source: https://docs.flightphp.com/en/v3/single-page

Installing and initializing Tracy Debugger.

```bash
composer require tracy/tracy
```

```php
<?php
use KnifeLemon\CommentTemplate\Engine;
use Tracy\Debugger;
```

--------------------------------

### Implement Session Login and Middleware

Source: https://docs.flightphp.com/en/v3/single-page

Demonstrates setting session data, committing changes, and protecting routes with manual checks or middleware.

```php
Flight::route('POST /login', function() {
    $session = Flight::session();

    // do your login logic here
    // validate password, etc.

    // if the login is successful
    $session->set('is_logged_in', true);
    $session->set('user', $user);

    // any time you write to the session, you must commit it deliberately.
    $session->commit();
});

// This check could be in the restricted page logic, or wrapped with middleware.
Flight::route('/some-restricted-page', function() {
    $session = Flight::session();

    if(!$session->get('is_logged_in')) {
        Flight::redirect('/login');
    }

    // do your restricted page logic here
});

// the middleware version
Flight::route('/some-restricted-page', function() {
    // regular page logic
})->addMiddleware(function() {
    $session = Flight::session();

    if(!$session->get('is_logged_in')) {
        Flight::redirect('/login');
    }
});
```

--------------------------------

### GET /users

Source: https://docs.flightphp.com/en/v3/single-page

Retrieves a paginated list of active users from the database.

```APIDOC
## GET /users

### Description
Retrieves a paginated list of active users.

### Method
GET

### Endpoint
/users

### Parameters
#### Query Parameters
- **page** (int) - Optional - The page number for pagination.
```

--------------------------------

### Get Database Driver

Source: https://docs.flightphp.com/en/v3/single-page

Access the underlying database driver instance.

```php
<?php
$migration->getDbDriver();
```

--------------------------------

### Migration::createVersion()

Source: https://docs.flightphp.com/en/v3/single-page

Initializes the version control system by creating the necessary version tracking table in the database.

```APIDOC
## Migration::createVersion()

### Description
Creates the version table in the database required for tracking migration progress.
```

--------------------------------

### Retrieving Full URL

Source: https://docs.flightphp.com/en/v3/single-page

Get the complete URL of the current request.

```php
$url = Flight::request()->getFullUrl();
// https://example.com/some/path?foo=bar
```

--------------------------------

### Install MailPlugin with custom transport

Source: https://docs.flightphp.com/en/v3/single-page

Register a custom transport factory for the MailPlugin.

```php
$plugin = MailPlugin::install(['dsns' => ['carrier' => 'mycarrier://key']]);
$plugin->addTransportFactory(new MyCarrierFactory());
```

--------------------------------

### BladeOne Template Engine Integration

Source: https://docs.flightphp.com/en/v3/single-page

Installing and configuring BladeOne for use within Flight.

```bash
composer require eftec/bladeone
```

```php
<?php
// Load BladeOne library
use eftec\bladeone\BladeOne;

// Register BladeOne as the view class
// Also pass a callback function to configure BladeOne on load
Flight::register('view', BladeOne::class, [], function (BladeOne $blade) {
  $views = __DIR__ . '/../views';
  $cache = __DIR__ . '/../cache';

  $blade->setPath($views);
  $blade->setCompiledPath($cache);
});

// Assign template data
Flight::view()->share('name', 'Bob');

// Display the template
echo Flight::view()->run('hello', []);
```

```php
<?php
Flight::map('render', function(string $template, array $data): void {
  echo Flight::view()->run($template, $data);
});
```

--------------------------------

### Recommended Production Configuration

Source: https://docs.flightphp.com/en/v3/single-page

Apply standard security settings for production environments to harden the application.

```php
// index.php or applied from app config / bootstrap
Flight::set('flight.allow_method_override', false);
Flight::set('flight.debug', false);
Flight::set('flight.log_errors', true);
```

--------------------------------

### Initialize Flight Application

Source: https://docs.flightphp.com/en/v3/single-page

Basic initialization of the Flight framework.

```php
Flight::start();
```

--------------------------------

### Complex Session Initialization

Source: https://docs.flightphp.com/en/v3/single-page

Alternative setup for the session manager in a more complex application structure.

```php

use Ghostff\Session\Session;

require 'vendor/autoload.php';

$app = Flight::app();
```

--------------------------------

### Manage Configuration via CLI

Source: https://docs.flightphp.com/en/v3/single-page

Commands for migrating legacy configuration and setting or retrieving values.

```bash
php runway config:migrate
```

```bash
php runway config:set app_root "app/"
```

```bash
php runway config:get app_root
```

--------------------------------

### Use classes and methods as controllers

Source: https://docs.flightphp.com/en/v3/single-page

Demonstrates various ways to map routes to class methods, including static and instance-based calls.

```php
class GreetingController {
    public function hello() {
        echo 'hello world!';
    }
}

Flight::route('/', [ 'GreetingController','hello' ]);
// or
Flight::route('/', [ GreetingController::class, 'hello' ]); // preferred method
// or
Flight::route('/', [ 'GreetingController::hello' ]);
// or 
Flight::route('/', [ 'GreetingController->hello' ]);
```

```php
use flight\Engine;

// GreetingController.php
class GreetingController
{
    protected Engine $app
    public function __construct(Engine $app) {
        $this->app = $app;
        $this->name = 'John Doe';
    }

    public function hello() {
        echo "Hello, {$this->name}!";
    }
}

// index.php
$app = Flight::app();
$greeting = new GreetingController($app);

Flight::route('/', [ $greeting, 'hello' ]);
```

--------------------------------

### Retrieving Base URL

Source: https://docs.flightphp.com/en/v3/single-page

Get the base URL of the application without a trailing slash.

```php
// http://example.com/path/to/something/cool?query=yes+thanks
$url = Flight::request()->getBaseUrl();
// https://example.com
// Notice, no trailing slash.
```

--------------------------------

### Install Runway via Composer

Source: https://docs.flightphp.com/en/v3/single-page

Use Composer to add the Runway package to your project dependencies.

```bash
composer require flightphp/runway
```

--------------------------------

### Enable v2 output buffering behavior

Source: https://docs.flightphp.com/en/v3/single-page

Shows how to restore legacy v2 rendering behavior by setting the flight.v2.output_buffering configuration option.

```php
// index.php
require 'vendor/autoload.php';

Flight::set('flight.v2.output_buffering', true);

Flight::before('start', function(){
    // Now this will be just fine
    echo '<html><head><title>My Page</title></head><body>';
});

// more code 
```

--------------------------------

### Create PHPUnit Configuration

Source: https://docs.flightphp.com/en/v3/single-page

Define the bootstrap file and test directory in a phpunit.xml file.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<phpunit bootstrap="vendor/autoload.php">
    <testsuites>
        <testsuite name="Flight Tests">
            <directory>tests</directory>
        </testsuite>
    </testsuites>
</phpunit>
```

--------------------------------

### Install Cookie Library via Composer

Source: https://docs.flightphp.com/en/v3/single-page

Use Composer to add the overclokk/cookie library to your project.

```bash
composer require overclokk/cookie
```

--------------------------------

### Create a Basic Flight Application

Source: https://docs.flightphp.com/en/v3

A minimal index.php file demonstrating route definition and JSON response handling.

```php
<?php

// if installed with composer
require 'vendor/autoload.php';
// or if installed manually by zip file
// require 'flight/Flight.php';

Flight::route('/', function() {
  echo 'hello world!';
});

Flight::route('/json', function() {
  Flight::json([
    'hello' => 'world'
  ]);
});

Flight::start();
```

--------------------------------

### Install Twig via Composer

Source: https://docs.flightphp.com/en/v3/single-page

Use Composer to add the Twig template engine to your project.

```bash
composer require twig/twig
```

--------------------------------

### Run Database Migrations

Source: https://docs.flightphp.com/en/v3

Execute database migrations using the Runway CLI tool.

```bash
php runway migrate
# then visit /posts and /api/posts
```

--------------------------------

### Define the users table schema

Source: https://docs.flightphp.com/en/v3/single-page

SQL schema definition for the users table used in the examples.

```sql
CREATE TABLE users (
    id INTEGER PRIMARY KEY, 
    name TEXT, 
    password TEXT 
);
```

--------------------------------

### Initialize Flight PHP index.php

Source: https://docs.flightphp.com/en/v3/install

Basic entry point configuration for a Flight PHP application using Composer or direct file inclusion.

```php
<?php

// If you're using Composer, require the autoloader.
require 'vendor/autoload.php';
// if you're not using Composer, load the framework directly
// require 'flight/Flight.php';

// Then define a route and assign a function to handle the request.
Flight::route('/', function () {
  echo 'hello world!';
});

// Finally, start the framework.
Flight::start();
```

--------------------------------

### Controller Class Structure

Source: https://docs.flightphp.com/en/v3/single-page

Example of a controller class using constructor injection for the Flight Engine.

```php
<?php

declare(strict_types=1);

namespace App\Controller;

use flight\Engine;

class MyController
{
    protected Engine $app;

    public function __construct(Engine $app)
    {
        $this->app = $app;
    }

    public function index(): void
    {
        // e.g. $this->app->render('…', […]);
    }
}
```

--------------------------------

### Define Twig Template Content

Source: https://docs.flightphp.com/en/v3/single-page

Example of a Twig template file structure using blocks.

```twig
{% block content %}
    <h1>Home Page</h1>
    <p>Welcome to my app!</p>
{% endblock %}
```

--------------------------------

### Organizing Events in index.php

Source: https://docs.flightphp.com/en/v3/single-page

Demonstrates loading event configurations from an external file and triggering events within a route.

```php
// index.php
require 'vendor/autoload.php';
require 'app/config/events.php';

Flight::route('/login', function () {
    $username = 'bob';
    Flight::triggerEvent('user.login', $username);
    echo "Logged in!";
});

Flight::start();
```

--------------------------------

### Render Latte Template

Source: https://docs.flightphp.com/en/v3/single-page

Example of a Latte template file and the corresponding Flight route to render it.

```html
<!-- app/views/home.latte -->
<html>
  <head>
    <title>{$title ? $title . ' - '}My App</title>
    <link rel="stylesheet" href="style.css">
  </head>
  <body>
    <h1>Hello, {$name}!</h1>
  </body>
</html>
```

```php
// routes.php
Flight::route('/@name', function ($name) {
    Flight::render('home.latte', [
        'title' => 'Home Page',
        'name' => $name
    ]);
});
```

--------------------------------

### Route Controller Injection

Source: https://docs.flightphp.com/en/v3/single-page

Example of defining routes where controllers utilize constructor injection for dependencies.

```php
// If all your controllers have a constructor that needs a PDO object
// each of the routes below will automatically have it injected!!!
Flight::route('/company/@id', [ CompanyController::class, 'view' ]);
Flight::route('/organization/@id', [ OrganizationController::class, 'view' ]);
Flight::route('/category/@id', [ CategoryController::class, 'view' ]);
Flight::route('/settings', [ SettingsController::class, 'view' ]);
```

--------------------------------

### MailPlugin API cheat sheet

Source: https://docs.flightphp.com/en/v3/single-page

Quick reference for MailPlugin setup and message building methods.

```php
// Setup
MailPlugin::install($config)             // register on the global Flight app
MailPlugin::register($app, $config)      // register on a specific Engine
$mailer = Flight::mail();                // the shared Mailer instance

// Building messages
$mailer->compose(): Message
$message->to(...)->from(...)->subject(...)   // standard Symfony Mime methods
$message->text(string)                       // plain string body
$message->html(string)                       // HTML string body
$message->template($name, $params)           // HTML body from a template
$message->htmlTemplate($name, $params)       // alias of template()
$message->textTemplate($name, $params)       // text body from a template
$message->inlineCss() / ->withoutInlineCss() // CSS inlining per message
$message->textFromHtml($mode)                // auto text part: true/'auto'/'plain'/'markdown'/false
$message->withoutTextFromHtml()              // HTML-only email
$message->transport($name)                   // route via a named DSN
$message->send(): ?SentMessage               // render + send

// On the mailer itself
$mailer->send($message): ?SentMessage        // explicit alternative to $message->send()
$mailer->render($template, $params): string  // render without sending
$mailer->addHook(callable): static           // fn(Message $message): void
$mailer->transports(): TransportManager      // get() / has() / names()
$mailer->renderers(): RendererFactory        // create() / has() / add()
```

--------------------------------

### Mocking Dependencies in Tests

Source: https://docs.flightphp.com/en/v3/single-page

Initial setup for a test class that utilizes mocks for external dependencies.

```php
use PHPUnit\Framework\TestCase;
```

--------------------------------

### Define Basic Flight Route

Source: https://docs.flightphp.com/en/v3/single-page

Register a simple GET route that returns a JSON response.

```php
Flight::route('GET /api/hello', function() {
    Flight::json(['message' => 'Hello World!']);
});
```

--------------------------------

### Retrieving Raw Request Body

Source: https://docs.flightphp.com/en/v3/single-page

Get the raw body content of a POST or PUT request.

```php
Flight::route('POST /users/xml', function(){
    $xmlBody = Flight::request()->getBody();
    // do something with the XML that was sent.
});
```
Tokens:
Raw