Flight

https://github.com/flightphp/core
Admin
Flight is a fast, simple, extensible PHP framework for building RESTful web applications with zero...
Tokens:43,521
Snippets:421
Trust Score:8.8
License:MIT
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Start Flight Framework

Source: https://github.com/flightphp/core/wiki/02-Installation

Start the Flight framework after defining routes.

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

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

### Include Flight Framework

Source: https://github.com/flightphp/core/wiki/02-Installation

Include the Flight framework in your index.php file.

```php
require 'flight/Flight.php';
```

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

### Install Flight with Composer

Source: https://github.com/flightphp/core/blob/master/README.md

Install the Flight framework using Composer. Run this command in your project directory.

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

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

### Install dependencies with Composer

Source: https://github.com/flightphp/core/blob/master/tests/README.md

Run this command to install the project dependencies before executing the tests.

```bash
composer install
```

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

### Define a Route in Flight

Source: https://github.com/flightphp/core/wiki/02-Installation

Define a route and assign a function to handle the request in Flight.

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

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

### Register class with setup callback

Source: https://github.com/flightphp/core/wiki/04-Extending

Pass a callback as the fourth argument to Flight::register to run setup code immediately after class construction. The callback receives the new object instance, as shown with a Database connection that calls connect().

```php
// The callback will be passed the object that was constructed
Flight::register('db', 'Database', array('localhost', 'mydb', 'user', 'pass'), function($db){
  $db->connect();
});
```

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

### Nginx Server Configuration for Flight

Source: https://github.com/flightphp/core/wiki/02-Installation

Configure Nginx to route all requests to /index.php for the Flight framework. Add this to your server declaration.

```nginx
server {
  location / {
    try_files $uri $uri/ /index.php;
  }
}
```

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

### Apache .htaccess Rewrite Rules

Source: https://github.com/flightphp/core/wiki/02-Installation

Configure Apache to route all requests to index.php for the Flight framework. Place this in your .htaccess file.

```apache
RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
RewriteRule ^(.*)$ index.php [QSA,L]
```

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

### Flight::start

Source: https://github.com/flightphp/core/wiki/16 Framework Methods

Starts the framework and begins processing the request.

```APIDOC
## Flight::start

### Description
Starts the framework and begins processing the request.

### Method
Flight::start

### Usage Example
```php
Flight::start();
```
```

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

### Flight::app

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Gets the application object instance.

```APIDOC
## Flight::app

### Description
Gets the application object instance.

### Method
Flight::app

### Request Example
```php
$app = Flight::app();
```
```

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

### Basic Flight route and start

Source: https://github.com/flightphp/core/wiki/01-Introduction

Minimal Flight application that responds to the root route with 'hello world!'. Requires PHP 5.3 or greater and the Flight.php file.

```php
require 'flight/Flight.php';

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

Flight::start();
```

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

### Template file hello.php with variable output

Source: https://github.com/flightphp/core/wiki/08 Views

Example template file that echoes the 'name' variable passed from the render call. The output would be 'Hello, Bob!'.

```php
Hello, '<?php echo $name; ?>'!
```

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

### Get a new instance with Flight::db(false)

Source: https://github.com/flightphp/core/wiki/04-Extending

By default, registered classes return a shared instance. Pass false to Flight::db() to get a new instance of the Database class.

```php
// Shared instance of Database class
$shared = Flight::db();

// New instance of Database class
$new = Flight::db(false);
```

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

### Run Flight as an object instance with Engine

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Use this when you prefer an object-oriented approach over the global static class. Create a new Engine instance, define a route, and start the app. The route callback echoes 'hello world!'.

```php
require 'flight/autoload.php';

use flight\Engine;

$app = new Engine();

$app->route('/', function(){
    echo 'hello world!';
});

$app->start();
```

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

### Register a before filter with Flight::before

Source: https://github.com/flightphp/core/wiki/06-Filtering

Registers a filter to run before the 'start' method. The filter receives parameters and output by reference for manipulation.

```php
Flight::before('start', function(&$params, &$output){
  // Do something
});
```

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

### Register an after filter with Flight::after

Source: https://github.com/flightphp/core/wiki/06-Filtering

Registers a filter to run after the 'start' method. The filter receives parameters and output by reference for manipulation.

```php
Flight::after('start', function(&$params, &$output){
  // Do something
});
```

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

### Flight::get

Source: https://github.com/flightphp/core/wiki/16 Framework Methods

Gets a variable from the framework's variable store.

```APIDOC
## Flight::get

### Description
Gets a variable from the framework's variable store.

### Method
Flight::get

### Parameters
- **$key** (string) - Required - The key of the variable to retrieve.

### Usage Example
```php
$value = Flight::get('key');
```
```

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

### Basic Flight Application (index.php)

Source: https://github.com/flightphp/core/blob/master/README.md

A minimal Flight application that defines a route for the root path and starts the framework. Requires the autoload file and calls Flight::start() to run.

```php
require 'flight/autoload.php';

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

Flight::start();
```

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

### Filtering process example with custom method

Source: https://github.com/flightphp/core/wiki/06-Filtering

Shows a complete workflow: map a custom method 'hello', add a before filter to change the first parameter to 'Fred', add an after filter to append text to the output, then invoke the method. The expected output is 'Hello Fred! Have a nice day!'.

```php
// Map a custom method
Flight::map('hello', function($name){
  return "Hello, $name!";
});

// Add a before filter
Flight::before('hello', function(&$params, &$output){
  // Manipulate the parameter
  $params[0] = 'Fred';
});

// Add an after filter
Flight::after('hello', function(&$params, &$output){
  // Manipulate the output
  $output .= " Have a nice day!";
}

// Invoke the custom method
echo Flight::hello('Bob');
```

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

### Clear variables with Flight::clear

Source: https://github.com/flightphp/core/wiki/07-Variables

Clear a specific variable by passing its name, or clear all variables by calling Flight::clear with no arguments. The example clears 'id' and then clears all variables.

```php
// Clears the id variable
Flight::clear('id');

// Clears all variables
Flight::clear();
```

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

### Check if a variable exists with Flight::has

Source: https://github.com/flightphp/core/wiki/07-Variables

Use Flight::has to check whether a variable has been set before performing an action. The example checks for 'id' and executes a block if it exists.

```php
if(Flight::has('id')) {
  // Do something
}
```

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

### Get shared or new instance of registered class

Source: https://github.com/flightphp/core/wiki/All documentations in one file

By default, Flight::db() returns a shared instance. Passing false as an argument creates a new instance each time. The example shows both calls.

```php
// Shared instance of the class
$shared = Flight::db();

// New instance of the class
$new = Flight::db(false);
```

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

### Set and get a variable with Flight::set and Flight::get

Source: https://github.com/flightphp/core/wiki/07-Variables

Save a variable with Flight::set and retrieve it elsewhere using Flight::get. The variable 'id' is stored globally and can be accessed anywhere in the application.

```php
// Save your variable
Flight::set('id', 123);

// Elsewhere in your application
$id = Flight::get('id');
```

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

### Register class with constructor parameters

Source: https://github.com/flightphp/core/wiki/04-Extending

Pass an array of constructor parameters to Flight::register so the class is pre-initialized when loaded. The example registers a 'Database' class with connection details, and Flight::db() creates a new Database with those parameters.

```php
// Register class with constructor parameters
Flight::register('db', 'Database', array('localhost','mydb','user','pass'));

// Get an instance of your class
// This will create an object with the defined parameters
//
//     new Database('localhost', 'mydb', 'user', 'pass');
//
$db = Flight::db();
```

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

### Get query parameter as object

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Access query string parameters as an object.

```php
$id = Flight::request()->query->id;
```

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

### Method-specific routing

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Define routes for specific HTTP methods (GET and POST).

```php
Flight::route('GET /', function(){
    echo 'I received a GET request.';
});

Flight::route('POST /', function(){
    echo 'I received a POST request.';
});
```

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

### Set configuration variable with Flight::set

Source: https://github.com/flightphp/core/wiki/07-Variables

Flight uses variables for configuration. Setting 'flight.log_errors' to true enables error logging.

```php
Flight::set('flight.log_errors', true);
```

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

### Register a class with Flight::register

Source: https://github.com/flightphp/core/wiki/04-Extending

Use Flight::register to register a class for lazy instantiation. The example registers a 'User' class and then retrieves an instance via Flight::user().

```php
// Register your class
Flight::register('user', 'User');

// Get an instance of your class
$user = Flight::user();
```

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

### Get query parameter as array

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Access query string parameters as an array.

```php
$id = Flight::request()->query['id'];
```

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

### Breaking the filter chain by returning false

Source: https://github.com/flightphp/core/wiki/06-Filtering

Demonstrates that returning false from any filter stops subsequent filters from being called. In this example, the third filter will not execute because the second returns false.

```php
Flight::before('start', function(&$params, &$output){
  echo 'one';
});

Flight::before('start', function(&$params, &$output){
  echo 'two';

  // This will end the chain
  return false;
});

// This will not get called
Flight::before('start', function(&$params, &$output){
  echo 'three';
});
```

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

### Map a custom method with Flight::map

Source: https://github.com/flightphp/core/wiki/04-Extending

Use Flight::map to define a custom method that can be called like a built-in Flight method. The example maps a 'hello' method that echoes a greeting, then calls it with 'Bob'.

```php
// Map your method
Flight::map('hello', function($name){
  echo "hello $name!";
});

// Call your custom method
Flight::hello('Bob');
```

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

### Get raw request body with getBody()

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Retrieves the raw HTTP request body, useful for PUT requests.

```php
$body = Flight::request()->getBody();
```

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

### Override notFound method with map

Source: https://github.com/flightphp/core/wiki/05-Overriding

Use Flight::map to replace the default notFound behavior with a custom 404 page. The example includes a custom 404 HTML file.

```php
Flight::map('notFound', function(){
  // Display custom 404 page
  include 'errors/404.html';
});
```

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

### Override notFound handler with Flight::map('notFound')

Source: https://github.com/flightphp/core/wiki/09 Error Handling

Customize the default 404 Not Found response by mapping the 'notFound' method. The callback receives no arguments in this example and can implement custom not-found handling logic.

```php
    Flight::map('notFound', function(){
        // Handle not found
    });
```

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

### Method-specific routing with GET and POST

Source: https://github.com/flightphp/core/wiki/03-Routing

Routes respond only to the specified HTTP method. Method-specific routes have precedence over global routes.

```php
Flight::route('GET /', function(){
  echo 'I received a GET request.';
});

Flight::route('POST /', function(){
  echo 'I received a POST request.';
});
```

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

### Send JSONP response with Flight::jsonp and custom callback parameter

Source: https://github.com/flightphp/core/wiki/14-JSON

Sends a JSONP response using the 'q' query parameter to define the callback function name. A GET request like ?q=my_func will produce the wrapped output.

```php
    Flight::jsonp(array('id' => 123), 'q');
```

```php
    my_func({"id":123});
```

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

### Route with regular expression

Source: https://github.com/flightphp/core/wiki/03-Routing

Uses a regular expression in the route pattern to match numeric segments. This example matches /user/1234.

```php
Flight::route('/user/[0-9]+', function(){
  // This will match /user/1234
});
```

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

### Get query parameter as object

Source: https://github.com/flightphp/core/wiki/11 Requests

Accesses a query string parameter using object property syntax on the query property of the request object.

```php
    $id = Flight::request()->query->id;
```

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

### Get query parameter as array

Source: https://github.com/flightphp/core/wiki/11 Requests

Accesses a query string parameter using array syntax on the query property of the request object.

```php
    $id = Flight::request()->query['id'];
```

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

### Break filter chain by returning false

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Returning false in a filter stops the chain, preventing subsequent filters from executing. In this example, the third filter is never called because the second filter returns false.

```php
Flight::before('start', function(&$params, &$output){
    echo 'one';
});

Flight::before('start', function(&$params, &$output){
    echo 'two';

    // This will end the chain
    return false;
});

// This will not get called
Flight::before('start', function(&$params, &$output){
    echo 'three';
});
```

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

### Override error handler with Flight::map('error')

Source: https://github.com/flightphp/core/wiki/09 Error Handling

Customize the default 500 Internal Server Error response by mapping the 'error' method. The callback receives no arguments in this example and can implement custom error handling logic.

```php
    Flight::map('error', function(){
        // Handle error
    });
```

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

### Flight::init

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Initializes the framework to its default settings.

```APIDOC
## Flight::init

### Description
Initializes the framework to its default settings.

### Method
Flight::init

### Request Example
```php
Flight::init();
```
```

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

### Create and run Flight Engine instance

Source: https://github.com/flightphp/core/wiki/17-Framework-Instance

Use this to run Flight as an object instance instead of a global static class. All existing static methods are available as regular class methods.

```php
    require 'flight/autoload.php';

    use flight\Engine;

    $app = new Engine();

    $app->route('/', function(){
        echo 'hello world!';
    });

    $app->start();
```

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

### Core framework methods

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Lists the core static methods for creating custom methods, registering classes, adding filters, managing paths and variables, and initializing the framework.

```php
Flight::map($name, $callback) // Creates a custom framework method.
Flight::register($name, $class, [$params], [$callback]) // Registers a class to a framework method.
Flight::before($name, $callback) // Adds a filter before a framework method.
Flight::after($name, $callback) // Adds a filter after a framework method.
Flight::path($path) // Adds a path for autoloading classes.
Flight::get($key) // Gets a variable.
Flight::set($key, $value) // Sets a variable.
Flight::has($key) // Checks if a variable is set.
Flight::clear([$key]) // Clears a variable.
Flight::init() // Initializes the framework to its default settings.
Flight::app() // Gets the application object instance
```

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

### Flight::notFound

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Sends an HTTP 404 response.

```APIDOC
## Flight::notFound

### Description
Sends an HTTP 404 response.

### Method
Flight::notFound

### Request Example
```php
Flight::notFound();
```
```

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

### Layout template files: header.php, body.php, layout.php

Source: https://github.com/flightphp/core/wiki/08 Views

Three template files used together for a layout: header.php displays the heading, body.php displays the body, and layout.php combines them with the title.

```php
<h1><?php echo $heading; ?></h1>
```

```php
<div><?php echo $body; ?></div>
```

```php
<html>
<head>
<title><?php echo $title; ?></title>
</head>
<body>
<?php echo $header_content; ?>
<?php echo $body_content; ?>
</body>
</html>
```

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

### Flight::render

Source: https://github.com/flightphp/core/wiki/16 Framework Methods

Renders a template file.

```APIDOC
## Flight::render

### Description
Renders a template file.

### Method
Flight::render

### Parameters
- **$file** (string) - Required - The template file to render.
- **$data** (array) - Optional - Data to pass to the template.
- **$key** (string) - Optional - Key to store the rendered output in the variable store.

### Usage Example
```php
Flight::render('header', ['title' => 'Hello']);
```
```

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

### Render template without extension after setting variable

Source: https://github.com/flightphp/core/wiki/08 Views

Renders the 'hello' template (hello.php) after the 'name' variable has been set globally. The .php extension can be omitted.

```php
Flight::render('hello');
```

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

### Extensible framework methods

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Lists the extensible methods that can be filtered or overridden, including routing, rendering, error handling, caching, and JSON responses.

```php
Flight::start() // Starts the framework.
Flight::stop() // Stops the framework and sends a response.
Flight::halt([$code], [$message]) // Stop the framework with an optional status code and message.
Flight::route($pattern, $callback) // Maps a URL pattern to a callback.
Flight::redirect($url, [$code]) // Redirects to another URL.
Flight::render($file, [$data], [$key]) // Renders a template file.
Flight::error($exception) // Sends an HTTP 500 response.
Flight::notFound() // Sends an HTTP 404 response.
Flight::etag($id, [$type]) // Performs ETag HTTP caching.
Flight::lastModified($time) // Performs last modified HTTP caching.
Flight::json($data, [$code], [$encode]) // Sends a JSON response.
Flight::jsonp($data, [$param], [$code], [$encode]) // Sends a JSONP response.
```

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

### Named parameters with regex

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Use regular expressions with named parameters using the ':' delimiter.

```php
Flight::route('/@name/@id:[0-9]{3}', function($name, $id){
    // This will match /bob/123
    // But will not match /bob/12345
});
```

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

### Route with class method

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Use a class method as the route callback.

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

Flight::route('/', array('Greeting','hello'));
```

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

### Run PHPUnit tests

Source: https://github.com/flightphp/core/blob/master/tests/README.md

Executes the unit tests located in the tests directory using PHPUnit.

```bash
vendor/bin/phpunit tests
```

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

### Route with regular function

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Use a regular function as the route callback.

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

Flight::route('/', 'hello');
```

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

### Render layout template with title

Source: https://github.com/flightphp/core/wiki/08 Views

Renders the layout template, which uses the previously saved 'header_content' and 'body_content' variables.

```php
Flight::render('layout', array('title' => 'Home Page'));
```

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

### Flight::redirect

Source: https://github.com/flightphp/core/wiki/16 Framework Methods

Redirects to another URL.

```APIDOC
## Flight::redirect

### Description
Redirects to another URL.

### Method
Flight::redirect

### Parameters
- **$url** (string) - Required - The URL to redirect to.
- **$code** (int) - Optional - HTTP status code for the redirect (default is 302).

### Usage Example
```php
Flight::redirect('/new-location');
```
```

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

### Flight::path

Source: https://github.com/flightphp/core/wiki/16 Framework Methods

Adds a path for autoloading classes.

```APIDOC
## Flight::path

### Description
Adds a path for autoloading classes.

### Method
Flight::path

### Parameters
- **$path** (string) - Required - The directory path to add for autoloading.

### Usage Example
```php
Flight::path('/path/to/classes');
```
```

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

### Flight::notFound

Source: https://github.com/flightphp/core/wiki/16 Framework Methods

Sends an HTTP 400 response.

```APIDOC
## Flight::notFound

### Description
Sends an HTTP 400 response.

### Method
Flight::notFound

### Usage Example
```php
Flight::notFound();
```
```

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

### Flight::map

Source: https://github.com/flightphp/core/wiki/16 Framework Methods

Creates a custom framework method that can be called statically.

```APIDOC
## Flight::map

### Description
Creates a custom framework method that can be called statically.

### Method
Flight::map

### Parameters
- **$name** (string) - Required - The name of the custom method.
- **$callback** (callable) - Required - The callback function to execute when the method is called.

### Usage Example
```php
Flight::map('customMethod', function() { ... });
```
```

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

### Flight::before

Source: https://github.com/flightphp/core/wiki/16 Framework Methods

Adds a filter that runs before a specified framework method.

```APIDOC
## Flight::before

### Description
Adds a filter that runs before a specified framework method.

### Method
Flight::before

### Parameters
- **$name** (string) - Required - The name of the framework method to filter.
- **$callback** (callable) - Required - The callback to execute before the method.

### Usage Example
```php
Flight::before('start', function() { ... });
```
```

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

### Register Smarty as custom view engine

Source: https://github.com/flightphp/core/wiki/08 Views

Registers Smarty as the view class with a callback to configure template directories. Then assigns data and displays a template.

```php
// Load Smarty library
require './Smarty/libs/Smarty.class.php';

// Register Smarty as the view class
// Also pass a callback function to configure Smarty on load
Flight::register('view', 'Smarty', array(), function($smarty){
    $smarty->template_dir = './templates/';
    $smarty->compile_dir = './templates_c/';
    $smarty->config_dir = './config/';
    $smarty->cache_dir = './cache/';
});

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

// Display the template
Flight::view()->display('hello.tpl');
```

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

### Output of layout rendering

Source: https://github.com/flightphp/core/wiki/08 Views

The resulting HTML output when rendering the layout with the given header and body content.

```html
<html>
<head>
<title>Home Page</title>
</head>
<body>
<h1>Hello</h1>
<div>World</div>
</body>
</html>
```

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

### Redirect with custom status code

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Redirects with a custom HTTP status code, here 401.

```php
Flight::redirect('/new/location', 401);
```

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

### Render content for layout with Flight::render

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Passes an optional third parameter to store rendered content in named variables for use in a layout.

```php
Flight::render('header', array('heading' => 'Hello'), 'header_content');
Flight::render('body', array('body' => 'World'), 'body_content');
```

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

### Optional parameters

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Define optional named parameters by wrapping segments in parentheses.

```php
Flight::route('/blog(/@year(/@month(/@day)))', function($year, $month, $day){
    // This will match the following URLS:
    // /blog/2012/12/10
    // /blog/2012/12
    // /blog/2012
    // /blog
});
```

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

### Flight::route

Source: https://github.com/flightphp/core/wiki/16 Framework Methods

Maps a URL pattern to a callback function.

```APIDOC
## Flight::route

### Description
Maps a URL pattern to a callback function.

### Method
Flight::route

### Parameters
- **$pattern** (string) - Required - The URL pattern to match.
- **$callback** (callable) - Required - The callback function to execute when the pattern matches.

### Usage Example
```php
Flight::route('/users', function() { ... });
```
```

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

### Render a view template with Flight::render

Source: https://github.com/flightphp/core/wiki/08 Views

Displays a view template by passing the template file name and optional data array. The data is injected into the template as local variables.

```php
Flight::render('hello.php', array('name' => 'Bob'));
```

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

### Named parameters

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Define named parameters in the route and receive them in the callback.

```php
Flight::route('/@name/@id', function($name, $id){
    echo "hello, $name ($id)!";
});
```

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

### Flight::after

Source: https://github.com/flightphp/core/wiki/16 Framework Methods

Adds a filter that runs after a specified framework method.

```APIDOC
## Flight::after

### Description
Adds a filter that runs after a specified framework method.

### Method
Flight::after

### Parameters
- **$name** (string) - Required - The name of the framework method to filter.
- **$callback** (callable) - Required - The callback to execute after the method.

### Usage Example
```php
Flight::after('start', function() { ... });
```
```

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

### Flight::register

Source: https://github.com/flightphp/core/wiki/16 Framework Methods

Registers a class to a framework method, allowing instantiation and access via Flight.

```APIDOC
## Flight::register

### Description
Registers a class to a framework method, allowing instantiation and access via Flight.

### Method
Flight::register

### Parameters
- **$name** (string) - Required - The name of the framework method.
- **$class** (string) - Required - The class name to register.
- **$params** (array) - Optional - Constructor parameters for the class.
- **$callback** (callable) - Optional - A callback to execute after instantiation.

### Usage Example
```php
Flight::register('db', 'PDO', ['mysql:host=localhost;dbname=test', 'user', 'pass']);
```
```

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

### Add before filter with Flight::before

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Use Flight::before to run a filter before a method executes. The filter can manipulate the input parameters via $params.

```php
Flight::before('start', function(&$params, &$output){
    // Do something
});
```

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

### Route info object

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Pass true as the third parameter to receive the route object in the callback.

```php
Flight::route('/', function($route){
    // Array of HTTP methods matched against
    $route->methods;

    // Array of named parameters
    $route->params;

    // Matching regular expression
    $route->regex;

    // Contains the contents of any '*' used in the URL pattern
    $route->splat;
}, true);
```

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

### Render content for layout with named sections

Source: https://github.com/flightphp/core/wiki/08 Views

Renders header and body templates into named variables ('header_content' and 'body_content') for later use in a layout.

```php
Flight::render('header', array('heading' => 'Hello'), 'header_content');
Flight::render('body', array('message' => 'World'), 'body_content');
```

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

### Flight::set

Source: https://github.com/flightphp/core/wiki/16 Framework Methods

Sets a variable in the framework's variable store.

```APIDOC
## Flight::set

### Description
Sets a variable in the framework's variable store.

### Method
Flight::set

### Parameters
- **$key** (string) - Required - The key of the variable to set.
- **$value** (mixed) - Required - The value to assign to the variable.

### Usage Example
```php
Flight::set('key', 'value');
```
```

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

### Flight::error

Source: https://github.com/flightphp/core/wiki/16 Framework Methods

Sends an HTTP 500 response.

```APIDOC
## Flight::error

### Description
Sends an HTTP 500 response.

### Method
Flight::error

### Parameters
- **$exception** (Exception) - Required - The exception object to handle.

### Usage Example
```php
Flight::error(new Exception('Something went wrong'));
```
```

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

### Access request object with Flight::request()

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Encapsulates the HTTP request into a single object. Provides properties like url, base, method, referrer, ip, ajax, scheme, user_agent, type, length, query, data, cookies, files, secure, accept, and proxy_ip.

```php
$request = Flight::request();
```

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

### Accessing Query Parameters

Source: https://github.com/flightphp/core/wiki/11 Requests

Shows how to retrieve query string parameters from the request object using array or object syntax.

```APIDOC
## Accessing Query Parameters

### Description
Demonstrates how to access query string parameters from the request object. The `query` property can be accessed as an array or an object.

### Method
GET (conceptual - this is a property access, not an HTTP endpoint)

### Endpoint
Flight::request()->query

### Parameters
#### Query Parameters
- **id** (string) - The query parameter to retrieve (example)

### Request Example
```php
// Array syntax
$id = Flight::request()->query['id'];

// Object syntax
$id = Flight::request()->query->id;
```

### Response
#### Success Response
Returns the value of the specified query parameter.

#### Response Example
```php
// Assuming request URL: /example?id=42
$id = Flight::request()->query['id']; // Returns '42'
```
```

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

### Catch-all route with wildcard

Source: https://github.com/flightphp/core/wiki/03-Routing

Routes all requests to a single callback using the '*' pattern.

```php
Flight::route('*', function(){
  // Do something
});
```

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

### Flight::request()->getBody()

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Returns the raw HTTP request body, useful for PUT requests.

```APIDOC
## Flight::request()->getBody()

### Description
Returns the raw HTTP request body, useful for PUT requests.

### Method
Flight::request()->getBody

### Parameters
None.

### Request Example
```php
$body = Flight::request()->getBody();
```

### Response
Returns the raw request body as a string.
```

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

### Flight::map('notFound', ...)

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Overrides the default not-found handler. When a URL can't be found, Flight calls this method. The default behavior sends an HTTP 404 Not Found response with a simple message.

```APIDOC
## Flight::map('notFound', ...)

### Description
Overrides the default not-found handler. When a URL can't be found, Flight calls this method. The default behavior sends an HTTP 404 Not Found response with a simple message.

### Method
Flight::map

### Parameters
- **'notFound'** (string) - Required - The name of the method to map.
- **callback** (callable) - Required - A function that handles the not-found case.

### Request Example
```php
Flight::map('notFound', function(){
    // Handle not found
});
```

### Response
No return value.
```

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

### Set custom views path with flight.views.path

Source: https://github.com/flightphp/core/wiki/08 Views

Changes the default 'views' directory to an alternate path for template files.

```php
Flight::set('flight.views.path', '/path/to/views');
```

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

### Replace Router class with register

Source: https://github.com/flightphp/core/wiki/05-Overriding

Register a custom Router class using Flight::register, then retrieve it with Flight::router(). The custom class must be defined elsewhere.

```php
// Register your custom class
Flight::register('router', 'MyRouter');

// When Flight loads the Router instance, it will load your class
$myrouter = Flight::router();
```

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

### Optional parameters with parentheses

Source: https://github.com/flightphp/core/wiki/03-Routing

Wraps segments in parentheses to make them optional. Unmatched optional parameters are passed as NULL.

```php
Flight::route('/blog(/@year(/@month(/@day)))', function($year, $month, $day){
  // This will match the following URLS:
  // /blog/2012/12/10
  // /blog/2012/12
  // /blog/2012
  // /blog
});
```

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

### Filter function signature

Source: https://github.com/flightphp/core/wiki/06-Filtering

Defines the structure of a filter function in Flight. It receives the method's parameters by reference and the output by reference, allowing manipulation of both.

```php
function(&$params, &$output) {
  // Filter code
}
```

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

### Add after filter with Flight::after

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Use Flight::after to run a filter after a method executes. The filter can manipulate the output via $output.

```php
Flight::after('start', function(&$params, &$output){
    // Do something
});
```

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

### Flight::clear

Source: https://github.com/flightphp/core/wiki/16 Framework Methods

Clears a variable from the framework's variable store, or all variables if no key is given.

```APIDOC
## Flight::clear

### Description
Clears a variable from the framework's variable store, or all variables if no key is given.

### Method
Flight::clear

### Parameters
- **$key** (string) - Optional - The key of the variable to clear. If omitted, all variables are cleared.

### Usage Example
```php
Flight::clear('key');
// or
Flight::clear();
```
```

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

### Flight::json

Source: https://github.com/flightphp/core/wiki/16 Framework Methods

Sends a JSON response.

```APIDOC
## Flight::json

### Description
Sends a JSON response.

### Method
Flight::json

### Parameters
- **$data** (mixed) - Required - The data to encode as JSON.

### Usage Example
```php
Flight::json(['key' => 'value']);
```
```

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

### Flight::etag

Source: https://github.com/flightphp/core/wiki/16 Framework Methods

Performs ETag HTTP caching.

```APIDOC
## Flight::etag

### Description
Performs ETag HTTP caching.

### Method
Flight::etag

### Parameters
- **$id** (string) - Required - The ETag identifier.
- **$type** (string) - Optional - The type of ETag (e.g., 'strong' or 'weak').

### Usage Example
```php
Flight::etag('my-etag');
```
```

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

### Flight::jsonp()

Source: https://github.com/flightphp/core/wiki/14-JSON

Sends a JSONP response by wrapping the JSON-encoded data in a callback function. The callback function name can be specified via a query parameter, defaulting to 'jsonp' if not provided.

```APIDOC
## Flight::jsonp()

### Description
Sends a JSONP response by wrapping the JSON-encoded data in a callback function. The callback function name can be specified via a query parameter, defaulting to 'jsonp' if not provided.

### Method
`Flight::jsonp`

### Parameters
- **data** (mixed) - Required - The data to be JSON encoded and wrapped in the callback.
- **param** (string) - Optional - The name of the query parameter that contains the callback function name. Defaults to `'jsonp'`.

### Request Example
```php
Flight::jsonp(array('id' => 123), 'q');
```

### Response
#### Success Response
- **body** (string) - The JSONP response, which is the callback function name followed by the JSON-encoded data in parentheses.

#### Response Example
```javascript
my_func({"id":123});
```
```

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

### Multiple methods with | delimiter

Source: https://github.com/flightphp/core/wiki/03-Routing

Maps multiple HTTP methods to a single callback using the '|' delimiter.

```php
Flight::route('GET|POST /', function(){
  echo 'I received either a GET or a POST request.';
});
```

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

### Redirect to a new URL with Flight::redirect

Source: https://github.com/flightphp/core/wiki/10 Redirects

Use Flight::redirect('/new/location') to redirect the current request to a new URL. The method accepts the target URL as its first argument.

```php
Flight::redirect('/new/location');
```

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

### Flight::redirect

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Redirects the current request to a new URL. By default sends an HTTP 303 status code, but a custom code can be set.

```APIDOC
## Flight::redirect

### Description
Redirects the current request to a new URL. By default sends an HTTP 303 status code, but a custom code can be set.

### Method
Flight::redirect

### Parameters
- **url** (string) - Required - The new URL to redirect to.
- **code** (int) - Optional - The HTTP status code to use (default 303).

### Request Example
```php
Flight::redirect('/new/location');
```

### Response
No return value.
```

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

### Passing to next route by returning true

Source: https://github.com/flightphp/core/wiki/03-Routing

Returns true from the callback to pass execution to the next matching route. The second route will be called when the condition is met.

```php
Flight::route('/user/@name', function($name){
  // Check some condition
  if ($name != "Bob") {
  // Continue to next route
  return true;
  }
});

Flight::route('/user/*', function(){
  // This will get called
});
```

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

### Route with class method callback

Source: https://github.com/flightphp/core/wiki/03-Routing

Uses a static class method as the route callback. The callback is specified as an array with class name and method name.

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

Flight::route('/', array('Greeting','hello'));
```

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

### Flight::json()

Source: https://github.com/flightphp/core/wiki/14-JSON

Sends a JSON response by encoding the provided data. This method is used to output JSON data to the client.

```APIDOC
## Flight::json()

### Description
Sends a JSON response by encoding the provided data. This method is used to output JSON data to the client.

### Method
`Flight::json`

### Parameters
- **data** (mixed) - Required - The data to be JSON encoded and sent as the response.

### Request Example
```php
Flight::json(array('id' => 123));
```

### Response
#### Success Response
- **body** (string) - The JSON-encoded representation of the provided data.

#### Response Example
```json
{"id":123}
```
```

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

### Flight::set('flight.log_errors', ...)

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Enables or disables logging of errors to the web server. By default errors are not logged.

```APIDOC
## Flight::set('flight.log_errors', ...)

### Description
Enables or disables logging of errors to the web server. By default errors are not logged.

### Method
Flight::set

### Parameters
- **'flight.log_errors'** (string) - Required - The configuration key.
- **value** (bool) - Required - Set to true to enable error logging.

### Request Example
```php
Flight::set('flight.log_errors', true);
```

### Response
No return value.
```

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

### Send JSONP response with default callback parameter

Source: https://github.com/flightphp/core/wiki/14-JSON

When no query parameter name is passed, Flight::jsonp defaults to using 'jsonp' as the query parameter name.

```php
    Flight::jsonp(array('id' => 123));
```

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

### Override Flight's default render method for Smarty

Source: https://github.com/flightphp/core/wiki/08 Views

Maps a custom 'render' method that assigns data and displays the template using the custom view engine.

```php
Flight::map('render', function($template, $data){
    Flight::view()->assign($data);
    Flight::view()->display($template);
});
```

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

### Flight::has

Source: https://github.com/flightphp/core/wiki/16 Framework Methods

Checks if a variable is set in the framework's variable store.

```APIDOC
## Flight::has

### Description
Checks if a variable is set in the framework's variable store.

### Method
Flight::has

### Parameters
- **$key** (string) - Required - The key of the variable to check.

### Usage Example
```php
if (Flight::has('key')) { ... }
```
```

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

### Wildcard for multiple segments

Source: https://github.com/flightphp/core/wiki/03-Routing

Uses the '*' wildcard to match multiple URL segments. This matches /blog/2000/02/01.

```php
Flight::route('/blog/*', function(){
  // This will match /blog/2000/02/01
});
```

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

### Halt with HTTP status code and message using Flight::halt()

Source: https://github.com/flightphp/core/wiki/13 Stopping

Stops the framework and sends an optional HTTP status code and message. The provided message is used as the response body. Any response content before the halt is discarded.

```php
Flight::halt(200, 'Be right back...');
```

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

### Flight::route()

Source: https://github.com/flightphp/core/wiki/03-Routing

Registers a route that matches a URL pattern with a callback function. The callback can be any callable, and routes are matched in the order they are defined.

```APIDOC
## Flight::route()

### Description
Registers a route that matches a URL pattern with a callback function. The callback can be any callable, and routes are matched in the order they are defined.

### Method
- `Flight::route($pattern, $callback, $pass_route = false)`

### Parameters
- **$pattern** (string) - Required - The URL pattern to match. Can include method prefixes, named parameters, optional segments, wildcards, and regular expressions.
- **$callback** (callable) - Required - The function or method to invoke when the route matches.
- **$pass_route** (bool) - Optional - If `true`, the route object is passed as the last parameter to the callback.

### Usage Examples

#### Basic Route
```php
Flight::route('/', function(){
  echo 'hello world!';
});
```

#### Callback as Regular Function
```php
function hello(){
  echo 'hello world!';
}

Flight::route('/', 'hello');
```

#### Callback as Class Method
```php
class Greeting {
  public static function hello() {
    echo 'hello world!';
  }
}

Flight::route('/', array('Greeting','hello'));
```

#### Method-Specific Routing
```php
Flight::route('GET /', function(){
  echo 'I received a GET request.';
});

Flight::route('POST /', function(){
  echo 'I received a POST request.';
});
```

#### Multiple Methods
```php
Flight::route('GET|POST /', function(){
  echo 'I received either a GET or a POST request.';
});
```

#### Regular Expressions
```php
Flight::route('/user/[0-9]+', function(){
  // This will match /user/1234
});
```

#### Named Parameters
```php
Flight::route('/@name/@id', function($name, $id){
  echo "hello, $name ($id)!";
});
```

#### Named Parameters with Regex
```php
Flight::route('/@name/@id:[0-9]{3}', function($name, $id){
  // This will match /bob/123
  // But will not match /bob/12345
});
```

#### Optional Parameters
```php
Flight::route('/blog(/@year(/@month(/@day)))', function($year, $month, $day){
  // This will match the following URLS:
  // /blog/2012/12/10
  // /blog/2012/12
  // /blog/2012
  // /blog
});
```

#### Wildcards
```php
Flight::route('/blog/*', function(){
  // This will match /blog/2000/02/01
});
```

#### Catch-All Route
```php
Flight::route('*', function(){
  // Do something
});
```

#### Passing to Next Route
```php
Flight::route('/user/@name', function($name){
  // Check some condition
  if ($name != "Bob") {
    // Continue to next route
    return true;
  }
});

Flight::route('/user/*', function(){
  // This will get called
});
```

#### Route Info
```php
Flight::route('/', function($route){
  // Array of HTTP methods matched against
  $route->methods;
  // Array of named parameters
  $route->params;
  // Matching regular expression
  $route->regex;
  // Contains the contents of any '*' used in the URL pattern
  $route->splat;
}, true);
```

### Notes
- Routes are matched in the order they are defined; the first match is invoked.
- Method-specific routes have precedence over global routes.
- Optional parameters that are not matched are passed as `NULL`.
- Matching is done on individual URL segments; use `*` to match multiple segments.
- Returning `true` from a callback passes execution to the next matching route.
- The route object (when requested) is always the last parameter passed to the callback.
```

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

### Flight::map('error', ...)

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Overrides the default error handler. All errors and exceptions are caught by Flight and passed to this method. The default behavior sends a generic HTTP 500 Internal Server Error response.

```APIDOC
## Flight::map('error', ...)

### Description
Overrides the default error handler. All errors and exceptions are caught by Flight and passed to this method. The default behavior sends a generic HTTP 500 Internal Server Error response.

### Method
Flight::map

### Parameters
- **'error'** (string) - Required - The name of the method to map.
- **callback** (callable) - Required - A function that receives an Exception object.

### Request Example
```php
Flight::map('error', function(Exception $ex){
    // Handle error
    echo $ex->getTraceAsString();
});
```

### Response
No return value.
```

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

### Stop framework and output current response with Flight::stop()

Source: https://github.com/flightphp/core/wiki/13 Stopping

Stops the framework but outputs the current response content accumulated so far. Use when you want to send the response and prevent further processing.

```php
Flight::stop();
```

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

### Access JSON input from data property

Source: https://github.com/flightphp/core/wiki/All documentations in one file

When sending a request with type application/json and data like {"id": 123}, the data is available from the data property.

```php
$id = Flight::request()->data->id;
```

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

### Named parameters with regex constraint

Source: https://github.com/flightphp/core/wiki/03-Routing

Adds a regular expression constraint to a named parameter using the ':' delimiter. This matches /bob/123 but not /bob/12345.

```php
Flight::route('/@name/@id:[0-9]{3}', function($name, $id){
  // This will match /bob/123
  // But will not match /bob/12345
});
```

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

### Send JSON response with Flight::json

Source: https://github.com/flightphp/core/wiki/All documentations in one file

Passes data to be JSON encoded and sends it as a JSON response.

```php
Flight::json(array('id' => 123));
```
Tokens:
Raw