Fat-Free Framework

https://fatfreeframework.com/3.9/
Admin
Fat-Free Framework is a lightweight PHP micro-framework designed to help developers build dynamic...
Tokens:231,970
Snippets:2,004
Trust Score:8.7
Update:1 week ago
Show doc for...
Tokens:
Raw
### run usage example

Source: https://fatfreeframework.com/3.9/base

Example of using run to start the framework. It sets up a route and then calls run.

```php
$f3 = require __DIR__.'/lib/base.php';
$f3->route('GET /',function(){
    echo "Hello World";
});
$f3->run();
```

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

### get method example

Source: https://fatfreeframework.com/3.9/basket

Retrieves the value of a field. Example displays '5'.

```php
echo $basket->get('cherry'); // displays '5'
```

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

### Basic XML-RPC ping handler setup

Source: https://fatfreeframework.com/3.9/pingback

Complete example of setting up a ping handler: a callback function, a route, and a listener function that binds the callback to the Web\Pingback listen() method.

```php
// the callback function called by the listen() function. Takes 2 parameters
function pingCallBackHandler($sourceURL, $reqBody) {
	$logger = new Log('pings.log');
	$logger->write('Incoming ping from '.$sourceURL);
	// any processing on the $reqBody
	$logger->write('Request body length is '.
			\UTF::instance()->strlen($reqBody));
}

// a route as an example, e.g.
$f3->route('GET /listener','PingListener');

// the function to bind to the listener:
function PingListener($f3, $params) {

	$pingback = new \Web\Pingback;
	// bind it with our custom callback function
	$pingback->listen('pingCallBackHandler');
	return;
}
```

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

### on('start')

Source: https://fatfreeframework.com/3.9/websocket

Registers a handler for the 'start' event, which is executed when the server is started. The handler receives the server instance as an argument.

```APIDOC
## Event: start

### Description
Executed when the server is started.

### Method
Event registration via `on()`

### Parameters
- **callable** (callable) - Required - The event handler function. Receives `\CLI\WS $server` as argument.

### Example
```php
$server->on('start', function($server) {
    echo 'Server started';
});
```
```

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

### OpenID::get usage example

Source: https://fatfreeframework.com/3.9/openid

Example call to the get method. Returns TRUE or FALSE.

```php
$is_valid = $openid->get('is_valid'); // returns TRUE or FALSE
```

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

### __construct() usage example

Source: https://fatfreeframework.com/3.9/pingback

Example instantiation of the Pingback class.

```php
$pingback = new Pingback (  )
```

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

### OpenID::set usage example

Source: https://fatfreeframework.com/3.9/openid

Example call to the set method. Displays 'checkid_setup'.

```php
echo $openid->set('openid.mode', 'checkid_setup'); // displays 'checkid_setup'
```

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

### Shell syntax examples for CLI routing

Source: https://fatfreeframework.com/3.9/routing-engine

Shows how shell arguments and options map to HTTP GET requests. Space-separated arguments become path components, and options become query string parameters.

```bash
php index.php test
```

```bash
php index.php log show --limit=50 --full
```

```bash
php index.php cache clear -f -v -i -n=23
```

```bash
php index.php cache clear -fvi -n=23
```

```bash
php index.php cache clear -fvin=23
```

```bash
php index.php cache -fvin=23 clear
```

```bash
php index.php -fvin=23 cache clear
```

```bash
php index.php -fvi cache clear -n=23
```

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

### render example: basic usage

Source: https://fatfreeframework.com/3.9/preview

Example of rendering a template file with the `render` method.

```php
echo $tmpl->render('layout.html'); // assumes layout.html is in the UI folder
```

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

### PHP template engine example with multilingual get()

Source: https://fatfreeframework.com/3.9/views-and-templates

Longer version using PHP as the template engine. Calls $f3->get() with the language key and optional formatting arguments.

```php
<?php $f3=Base::instance(); ?>
<h1><?php echo $f3->get('love'); ?></h1>
<p>
    <?php echo $f3->get('today',time()); ?>.<br />
    <?php echo $f3->get('money',365.25); ?><br />
    <?php echo $f3->get('pi', 3.1415); ?>
</p>
```

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

### checkout() usage example

Source: https://fatfreeframework.com/3.9/basket

Example showing how to use checkout() to retrieve all items and clear the basket.

```php
$basket_items = $basket->checkout();
```

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

### __construct() usage example

Source: https://fatfreeframework.com/3.9/basket

Example showing how to instantiate the Basket class with a custom key.

```php
$basket = new Basket( 'puppy-cart' );
```

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

### copyfrom() example 1: array input

Source: https://fatfreeframework.com/3.9/basket

Example showing how to hydrate the basket using an array directly.

```php
$basket->copyfrom(array('name'=>'banana', 'amount'=> 15));
$basket->get('name'); // banana
```

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

### render example: with mime and ttl

Source: https://fatfreeframework.com/3.9/preview

Example of rendering a template with a custom MIME type and caching for 5 minutes.

```php
$flow = $tmpl->render('widgets/tweeter-feeds.html', 'application/json', NULL, 300 ); // cache for 5 minutes
```

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

### drop example

Source: https://fatfreeframework.com/3.9/jig

Example of using the drop method to clean the storage directory. The comments show the directory contents before and after.

```php
$db=new \DB\Jig('jig/'); // jig/ directory is empty
$db->write('file1.dat',$data1); // jig/ contains file1.dat
$db->write('file2.dat',$data2); // jig/ contains file1.dat and file2.dat
$db->drop(); // jig/ directory is now empty
```

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

### start event handler signature

Source: https://fatfreeframework.com/3.9/websocket

Signature for the 'start' event handler. The handler receives the server instance as an argument.

```php
callable start ( \CLI\WS $server )
```

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

### drop() usage example

Source: https://fatfreeframework.com/3.9/basket

Example showing how to use drop() to completely empty the basket.

```php
$basket->drop();
```

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

### sync usage example

Source: https://fatfreeframework.com/3.9/base

Example of using sync to ensure the PHP global SESSION matches the F3 variable SESSION.

```php
$f3->sync('SESSION'); // ensures PHP global var SESSION is the same as F3 variable SESSION
```

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

### $option example

Source: https://fatfreeframework.com/3.9/sql-mapper

Example of the $option array with order, group, limit, and offset values.

```php
array(
	'order' => 'score DESC, team_name ASC',
	'group' => 'score, player',
	'limit' => 20,
	'offset' => 0
)
```

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

### Complete CSRF protection example

Source: https://fatfreeframework.com/3.9/session

Complete example showing how to set up a route with CSRF protection using the Session class.

```php
$f3->DB=new DB\SQL('mysql:host=127.0.0.1;port=3306;dbname=test;','user','p4ssw0rd');

$f3->route('GET|POST /test-csrf',function($f3,$params){

    new DB\SQL\Session($f3->DB,'sessions',TRUE,NULL,'CSRF');
    // or:
    // $sess=new DB\SQL\Session($f3->DB);
    // $f3->CSRF=$sess->csrf();

    if ($f3->VERB=='POST') {
        $token = $f3->get('POST.token');
        $csrf = $f3->get('SESSION.csrf');
        if (empty($token) || empty($csrf) || $token!==$csrf) {
            echo 'CSRF attack!';
        else
            echo 'Your name is '.$f3->get('POST.name');
        die();
    }

    $f3->copy('CSRF','SESSION.csrf');

    echo '<form action="" method="post">'.
        '<input type="text" name="name" value="" placeholder="Your name"/>'.
        '<input type="hidden" name="token" value="'.$f3->CSRF.'"/>'.
        '<button type="submit">Submit</button></form>';

});
```

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

### calendar example with weeks starting Sunday

Source: https://fatfreeframework.com/3.9/matrix

Example of using calendar with $first=0 to get a calendar for June 2014 with weeks starting on Sunday. The returned array has weeks as arrays with day numbers indexed from 0 (Sunday) to 6 (Saturday).

```php
$cal = $matrix->calendar('2014-06', 0); // with weeks starting on Sunday
/*
array(
	array(0=>1,1=>2,2=>3,3=>4,4=>5,5=>6,6=>7),   // 1st day of the month is a Sunday, index 0
	array(0=>8,1=>9,2=>10,3=>11,4=>12,5=>13,6=>14),
	array(0=>15,1=>16,2=>17,3=>18,4=>19,5=>20,6=>21),
	array(0=>22,1=>23,2=>24,3=>25,4=>26,5=>27,6=>28),
	array(0=>29,1=>30)
) */
```

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

### Hello World with Composer

Source: https://fatfreeframework.com/3.9/getting-started

Alternative setup using Composer. Run 'composer require bcosca/fatfree-core' first, then use the autoloader and Base::instance() to create the application.

```php
require 'vendor/autoload.php';
$f3 = \Base::instance();
$f3->route('GET /',
    function() {
        echo 'Hello, world!';
    }
);
$f3->run();
```

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

### Passing format arguments to get()

Source: https://fatfreeframework.com/3.9/base

Demonstrates passing arguments to get() for format placeholders, as a shorthand for $f3->format().

```php
$f3->set('var1','Current date: {0,date} - Current time: {0,time}');
$f3->set('var2','Departure: {0,date} - Arrival: {1,date}');
echo $f3->get('var1',time());//shorthand for $f3->format($f3->get('var1'),time());
echo $f3->get('var2',array($timestamp1,$timestamp2));//shorthand for $f3->format($f3->get('var2'),$timestamp1,$timestamp2);
```

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

### calendar example with weeks starting Monday

Source: https://fatfreeframework.com/3.9/matrix

Example of using calendar with $first=1 to get a calendar for June 2014 with weeks starting on Monday. The returned array has weeks as arrays with day numbers indexed from 0 (Monday) to 6 (Sunday).

```php
$cal = $matrix->calendar('2014-06', 1); // with weeks starting on Monday
/*
array(
	array(6=>1),                                 // 1st day of the month is a Sunday, index 6
	array(0=>2,1=>3,2=>4,3=>5,4=>6,5=>7,6=>8),
	array(0=>9,1=>10,2=>11,3=>12,4=>13,5=>14,6=>15),
	array(0=>16,1=>17,2=>18,3=>19,4=>20,5=>21,6=>22),
	array(0=>23,1=>24,2=>25,3=>26,4=>27,5=>28,6=>29),
	array(0=>30)
) */
```

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

### log() usage and output example

Source: https://fatfreeframework.com/3.9/pingback

Example call to log() and its output showing permalink URLs found in inspected pages.

```php
echo $pingback->log();
```

```text
// Outputs:
Mon, 06 Jan 2014 10:23:00 +0100 /comments-feed?page=pingback/cf [permalink:/pingback]
   /pingback2?page=pingback/client

Mon, 06 Jan 2014 10:23:01 +0100 /rss2-feed?page=pingback/rss2 [permalink:/rss2-ping]
 /pingback2?page=rss2-ping/client
 
```

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

### Get database log with $db->log()

Source: https://fatfreeframework.com/3.9/databases

Echo the database log to get a list of all database instructions issued.

```php
echo $db->log();
```

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

### Hello World with base.php

Source: https://fatfreeframework.com/3.9/getting-started

Creates a basic Fat-Free application by requiring base.php and defining a GET route for the root URL. Save as index.php in the web root. Ensure the require assignment comes before any output to avoid HTTP header errors.

```php
<?php
$f3 = require('path/to/base.php');
$f3->route('GET /',
    function() {
        echo 'Hello, world!';
    }
);
$f3->run();
```

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

### mset usage example with prefix

Source: https://fatfreeframework.com/3.9/base

Shows how to append a prefix to all key names using the second argument.

```php
$f3->mset(
    array(
        'var1'=>'value1',
        'var2'=>'value2',
        'var3'=>'value3',
    ),
    'pre_'
);

echo $f3->get('pre_var1'); // value1
echo $f3->get('pre_var2'); // value2
echo $f3->get('pre_var3'); // value3
```

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

### UTF::substr examples

Source: https://fatfreeframework.com/3.9/utf-unicode-string-manager

Examples of extracting substrings with positive and negative start offsets.

```php
$utf->substr('El pingüino Wenceslao hizo kilómetros',  3,8); // returns 'pingüino'
$utf->substr('El pingüino Wenceslao hizo kilómetros',-10,4); // returns 'kiló'
```

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

### Load configuration file with $f3->config()

Source: https://fatfreeframework.com/3.9/framework-variables

Loads a configuration file (setup.cfg) as a code substitute for lengthy $f3->set() statements.

```php
$f3->config('setup.cfg');
```

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

### location usage example

Source: https://fatfreeframework.com/3.9/geo

Example of using location to get geolocation data for the client IP. The output includes city, country, coordinates, and more.

```php
$geo = \Web\Geo::instance();
var_dump($geo->location()); // locate client IP
/* returns:
array (size=12)
  'request' => string '85.2.88.43' (length=10)
  'credit' => string 'Some of the returned data includes GeoLite data created by MaxMind, available from <a href=\'http://www.maxmind.com\'>http://www.maxmind.com</a>.' (length=145)
  'city' => string 'Lutry' (length=5)
  'area_code' => string '0' (length=1)
  'dma_code' => string '0' (length=1)
  'country_code' => string 'CH' (length=2)
  'country_name' => string 'Switzerland' (length=11)
  'continent_code' => string 'EU' (length=2)
  'latitude' => string '46.504902' (length=9)
  'longitude' => string '6.6852' (length=6)
  'region_code' => string '23' (length=2)
  'region_name' => string '23' (length=2)
*/
```

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

### trans() method example

Source: https://fatfreeframework.com/3.9/sql

Checks if a transaction is active and starts one if not.

```php
if (!$db->trans())
    $db->begin();
```

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

### Configure framework with config()

Source: https://fatfreeframework.com/3.9/base

Parses a .ini-style configuration file and sets up framework variables and routes. If the second argument is TRUE, template strings are interpreted, enabling dynamic configs.

```php
null config ( string $file [, bool $allow = FALSE ])
```

```ini
[globals]
foo = bar
baz = {{@foo}}
```

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

### tzinfo usage example

Source: https://fatfreeframework.com/3.9/geo

Example of using tzinfo to get timezone details for 'Australia/Darwin'. The output shows offset, country, latitude, longitude, and dst flag.

```php
/** @var \Web\Geo $geo */
$geo = \Web\Geo::instance();
var_dump($geo->tzinfo('Australia/Darwin'));
/* returns:
array (size=5)
  'offset' => float 9.5
  'country' => string 'AU' (length=2)
  'latitude' => float -12.46667
  'longitude' => float 130.83333
  'dst' => boolean false
*/
```

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

### log() method example

Source: https://fatfreeframework.com/3.9/sql

Shows how to retrieve the SQL profiler log, which includes timestamps and execution times in milliseconds.

```php
$db->exec('INSERT INTO mytable(name) VALUES(?)','Clyde');
$db->exec('INSERT INTO mytable(name) VALUES(?)','Don');
$db->exec('INSERT INTO mytable(name) VALUES(?)','Elliott');

echo $db->log();

// outputs:
Mon, 27 Dec 2013 12:26:05 +0100 (2.0ms) INSERT INTO mytable(name) VALUES('Clyde')
Mon, 27 Dec 2013 12:26:05 +0100 (3.6ms) INSERT INTO mytable(name) VALUES('Don')
Mon, 27 Dec 2013 12:26:05 +0100 (1.3ms) INSERT INTO mytable(name) VALUES('Elliott')
```

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

### weather usage example

Source: https://fatfreeframework.com/3.9/geo

Example of using weather to get weather data for a specific IP's location. Requires an API key. The output includes weather condition, temperature, humidity, and more.

```php
$geo = \Web\Geo::instance();
$loc = $geo->location('95.143.172.183'); // locate specific IP
$key = 'SECRET'; // The API key
var_dump($geo->weather($loc['latitude'],$loc['longitude'],$key));
/* returns:
array (size=17)
  'weatherCondition' => string 'n/a' (length=3)
  'clouds' => string 'few clouds' (length=10)
  'observation' => string 'ETHF 171620Z 33002KT 9999 FEW160 SCT210 05/00 Q1025 BLU+' (length=56)
  'windDirection' => int 330
  'ICAO' => string 'ETHF' (length=4)
  'elevation' => int 181
  'countryCode' => string 'DE' (length=2)
  'cloudsCode' => string 'FEW' (length=3)
  'lng' => float 9.2666666666667
  'temperature' => string '5' (length=1)
  'dewPoint' => string '0' (length=1)
  'windSpeed' => string '02' (length=2)
  'humidity' => int 70
  'stationName' => string 'Fritzlar' (length=8)
  'datetime' => string '2013-12-17 16:20:00' (length=19)
  'lat' => float 51.116666666667
  'hectoPascAltimeter' => int 1025
*/
```

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

### Simple GET request with var_dump output

Source: https://fatfreeframework.com/3.9/web

Example of a simple GET request to download a remote file, with the var_dump output showing the returned array structure including body, headers, engine, cached, and error fields.

```php
var_dump( \Web::instance()->request('http://www.golem.de/1303/98339-55766-i_rc.jpg' ));
/* returns:

array(4) {
    'body' => string " IMAGE BINARY DATA " (length=7761)
    'headers' =>
        array (size=14)
        0 => string 'HTTP/1.1 200 OK' (length=15)
        1 => string 'Server: nginx' (length=13)
        2 => string 'Date: Thu, 18 Dec 2013 12:40:11 GMT' (length=35)
        3 => string 'Content-Type: image/jpeg' (length=24)
        4 => string 'Content-Length: 7761' (length=20)
        5 => string 'Connection: close' (length=17)
        6 => string 'Keep-Alive: timeout=3' (length=21)
        7 => string 'Last-Modified: Fri, 22 Mar 2013 09:41:02 GMT' (length=44)
        8 => string 'ETag: "514c272e-1e51"' (length=21)
        9 => string 'X-UPSTREAM: www1.golem.de' (length=25)
        10 => string 'Expires: Sun, 18 Jan 2014 12:40:11 GMT' (length=38)
        11 => string 'Cache-Control: max-age=2678400' (length=30)
        12 => string 'X-Cache-Status: HIT' (length=19)
        13 => string 'Accept-Ranges: bytes' (length=20)
    'engine' => string 'cURL' (length=4)
    'cached' => boolean false
    'error' => string '' (length=0)
}
*/
```

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

### Create products table with SQL

Source: https://fatfreeframework.com/3.9/databases

Defines the products table used in the virtual field examples. The table includes productID, description, supplierID, unitprice, and quantity columns.

```sql
CREATE TABLE products (
    productID VARCHAR(30),
    description VARCHAR(255),
    supplierID VARCHAR(30),
    unitprice DECIMAL(10,2),
    quantity INT,
    PRIMARY KEY(productID)
);
```

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

### ref usage example with existing key

Source: https://fatfreeframework.com/3.9/base

Shows how to get a reference to an existing hive key and modify it, updating the framework variable.

```php
$f3->set('name','John');
$b = &$f3->ref('name'); // $b is a reference to framework variable 'name' , not a copy
$b = 'Chuck'; // modifiying the reference updates the framework variable 'name'
echo $f3->get('name'); // Chuck
```

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

### reroute usage examples

Source: https://fatfreeframework.com/3.9/base

Examples of reroute usage: permanent redirect for moved pages, temporary redirect for Post/Redirect/Get, rerouting to current route with GET verb when no URL is given, external URLs, named routes, and dynamic parameters in named routes.

```php
// an old page is moved permanently
$f3->route('GET|HEAD /obsoletepage', function($f3) {
    $f3->reroute('/newpage', true);
});

// whereas a Post/Redirect/Get pattern would just redirect temporarily
$f3->route('GET|HEAD /login', 'AuthController->viewLoginForm');
$f3->route('POST /login', function($f3) {
    if( AuthController->checkLogin == true )
        $f3->reroute('/members', false);
    else
        $f3->reroute('/login', false);
});

// if no $url parameter is set, it'll reroute to the current route with GET verb
$f3->route('POST /search', function($f3) {
    // back to search form, if an empty term was submitted
    if ($f3->devoid('POST.search_term'))
        $f3->reroute();
});

// we can also reroute to external URLs
$f3->route('GET /partners', function($f3) {
    $f3->reroute('http://externaldomain.com');
});

// it's also possible to reroute to named routes
$f3->route('GET @beer_list: /beer', 'Beer->list');
$f3->route('GET /old-beer-page', function($f3) {
    $f3->reroute('@beer_list');
});

// even with dynamic parameter in your named route
$f3->route('GET @beer_producers: /beer/@country/@village', 'Beer->byproducer');
$f3->route('GET /old-beer-page', function($f3) {
    $f3->reroute('@beer_producers(@country=Germany,@village=Rhine)');
});
// but it'll also work with any unnamed tokenized URL
$f3->reroute('/beer/@country/@village',TRUE)
```

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

### get: Return value of e-mail header

Source: https://fatfreeframework.com/3.9/smtp

Returns the value of an e-mail header as a string or NULL. Example displays the 'From' header value.

```php
echo $smtp->get('From'); // displays e.g. 'J. W. von Goethe <jwgoethe@famousauthors.org>'
```

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

### Usage with Jig Mapper

Source: https://fatfreeframework.com/3.9/jig

Example of initializing the database using the Jig Mapper. It shows adding records with the mapper and saving them.

```php
$mapper = new \DB\Jig\Mapper($db, $file);
$mapper->username = 'userA';
$mapper->password = '57d82jg05';
$mapper->save();
$mapper->reset();
$mapper->username = 'userB';
$mapper->password = 'kbjd94973';
$mapper->save();
```

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

### parse: Parse key-value pairs into an array

Source: https://fatfreeframework.com/3.9/base

The parse method converts a string of key-value pairs into an array. The first example shows basic parsing and accessing values. The second example stores the parsed array into The Hive using mset, then retrieves values with get.

```php
$array = $f3->parse('framework=f3 , speed=fast , features=full');
echo $array['framework'];  // 'f3'
echo $array['speed'];  // 'fast'
```

```php
$array = $f3->parse('framework=f3 , speed=fast , features=full');
$f3->mset($array);
echo $f3->get('framework');  // 'f3'
echo $f3->get('speed');      // 'fast'
```

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

### Dynamic route handler with @action token

Source: https://fatfreeframework.com/3.9/routing-engine

Routes GET /products/@action to the Products class method named by the URL segment. For example, /products/itemize calls Products->itemize().

```php
$f3->route('GET /products/@action','Products->@action');
```

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

### rel() - Return Path Relative to Base Directory

Source: https://fatfreeframework.com/3.9/base

Returns a path relative to the base directory. Example shows setting BASE and calling rel() to get a relative path.

```php
string rel ( string $url )
```

```php
$f3->set('BASE','http://fatfreeframework.com/');
echo $f3->rel( 'http://fatfreeframework.com/gui/img/supported_dbs.jpg' ); // 'gui/img/supported_dbs.jpg'
```

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

### Create a User model class wrapping Jig Mapper

Source: https://fatfreeframework.com/3.9/jig-mapper

Shows how to set up a model class that extends the Jig Mapper, using the global DB connection and a specific file. Then loads a user by `_id`.

```php
$f3->set('DB',new DB\Jig('data/'));

class User extends \DB\Jig\Mapper {
    public function __construct() {
        parent::__construct( \Base::instance()->get('DB'), 'users.json' );
    }
}

$user = new User();
$user->load(array('@_id = ?','515c570f28de6'));
// etc.
```

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

### Parameterized batch transaction with named and positional placeholders

Source: https://fatfreeframework.com/3.9/databases

A safer version of the batch transaction example using parameterized queries with named (:name) and positional (?) placeholders. Each statement gets its own parameters array.

```php
$db->exec(
    array(
        'DELETE FROM diet WHERE food=:name',
        'INSERT INTO diet (food) VALUES (?)',
        'SELECT * FROM diet'
    ),
    array(
        array(':name'=>'cola'),
        array(1=>'carrot'),
        NULL
    )
);
```

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

### build method example: token to PHP

Source: https://fatfreeframework.com/3.9/preview

Shows the conversion of a token like `{{ @book.title | esc }}` into PHP code using the `build` method.

```php
{{ @book.title | esc }}
```

```php
<?php echo $this->esc($book['title']); ?>
```

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

### bom: Return UTF-8 byte order mark

Source: https://fatfreeframework.com/3.9/utf-unicode-string-manager

Returns the UTF-8 byte order mark (BOM) character. The BOM is optional and must appear at the start of a text stream. Example shows how to prepend the BOM to a file.

```php
string bom (  )
```

```php
$bom = \UTF::instance()->bom();  // $bom = 0xefbbbf
echo '0x'.dechex(ord($bom[0])).dechex(ord($bom[1])).dechex(ord($bom[2])); // displays '0xefbbbf'

// convert/save a file with a BOM at its beginning
$f3->write( $filename, $bom . $f3->read($filename) );
```

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

### find method example with output

Source: https://fatfreeframework.com/3.9/basket

Adds items, finds by key/value pair, and shows the result array structure.

```php
// add item
$basket->set('name','cherry');
$basket->set('amount',5);
$basket->save();
$basket->reset();
// add item
$basket->set('name','peach');
$basket->set('amount',10);
$basket->save();
$basket->reset();

$result = $basket->find('name','cherry');

echo $result[0]->get('amount'); // displays '5' (int)
echo $result[0]->get('name'); // displays 'cherry'

$result = $basket->find();  // array of basket items, if any

// results, e.g.:
array(2) {
  [0]=>
  object(Basket)#7 (3) {
    ["key":protected]=>
    string(5) "sunny"
    ["id":protected]=>
    string(23) "52db5405a64047.97371123"
    ["item":protected]=>
    array(2) {
      ["name"]   =>		string(6) "cherry"
      ["amount"] =>		int(5)
    }
  }
  [1]=>
  object(Basket)#8 (3) {
    ["key":protected]=>
    string(5) "sunny"
    ["id":protected]=>
    string(23) "52db5405a64143.07049859"
    ["item":protected]=>
    array(2) {
      ["name"]   =>		string(5) "peach"
      ["amount"] =>		int(10)
    }
  }
}
```

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

### Extend Magic class and use object as array

Source: https://fatfreeframework.com/3.9/magic

Shows how to extend the abstract Magic class by implementing the required abstract methods (exists, set, get, clear) and then use the resulting object both as an array and with object properties. The example demonstrates that setting a property with $user->name or $user['age'] works interchangeably, and that the magic methods are called automatically.

```php
class User extends Magic {

    protected $data;

    function exists($key) {
        return array_key_exists($key,$this->data);
    }

    function set($key, $val) {
        $this->data[$key] = $val;
    }

    function &get($key) {
        return $this->data[$key];
    }

    function clear($key) {
        unset($this->data[$key]);
    }
}
```

```php
$user = new User();
$user->name = 'John';
$user['age'] = 28;
$user->set('mail','john@email.com');

echo $user['name']; // John
echo $user->get('age'); // 28
echo $user->mail; // john@email.com
```

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

### GET request with URL parameters

Source: https://fatfreeframework.com/3.9/web

Performs a GET request with URL parameters built via http_build_query and appended to the URL. Uses the 'method' => 'GET' option.

```php
$url = 'http://www.mydomain.com/index.php';
$params = array(
    'parameter1' => 'value1',
    'parameter2' => 'value2'
);
$options = array('method' => 'GET');
$url .= '?'.http_build_query($params);

$result = \Web::instance()->request($url, $options);
```

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

### Install Fat-Free Framework with Composer

Source: https://fatfreeframework.com/3.9/home

Install the Fat-Free Framework core package via Composer. Run this command in your project directory to add the framework as a dependency.

```bash
composer require bcosca/fatfree-core

```

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

### Search Examples

Source: https://fatfreeframework.com/3.9/jig-mapper

Examples of using $filter for searching with preg_match and in_array.

```APIDOC
## Search Examples

### Description
Examples of using `$filter` for searching with `preg_match` and `in_array`.

### Using preg_match
```php
$userList = $user->find(array('(isset(@email) && preg_match(? ,@email))','/gmail/'));
// returns all users with an email address that contains GMAIL

// ends with gmail.com => /gmail\.com$/
// starts with john  => /^john/
```

### Using in_array (SQL IN equivalent)
```php
$user->find(array('in_array('_id', [?,?,?])', 1,2,3));
```

### Using in_array with array fields
```php
$post->find(array('isset(@tags) && in_array(@tags, :tags)', ':tags' => ['fat-free', 'php']));
```

### Security Notice
Do not put unvalidated user input into the query. Always use prepared statements as shown.
```

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

### MySQL Connection Example

Source: https://fatfreeframework.com/3.9/sql

Connects to a MySQL database using the \DB\SQL class with host, port, database name, username, and password.

```php
$db=new \DB\SQL('mysql:host=localhost;port=3306;dbname=mysqldb','username','password');
```

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

### OpenID::clear usage example

Source: https://fatfreeframework.com/3.9/openid

Example call to the clear method.

```php
$openid->clear('openid.sig');
```

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

### begin, rollback, commit transaction example

Source: https://fatfreeframework.com/3.9/sql

Shows a full transaction lifecycle: begin, insert, rollback, insert, commit. Only the last insert is committed.

```php
// state 1: empty table
$db->begin();
$db->exec('INSERT INTO mytable(name) VALUES(?)','Alfred');
$db->exec('INSERT INTO mytable(name) VALUES(?)','Bonnie');
// state 2: table contains 2 rows
$db->rollback();
// state 3: back to state 1
$db->exec('INSERT INTO mytable(name) VALUES(?)','Clyde');
// state 4: table contains 1 row
$db->commit();
// state 5: changes commited
// end of transaction: only Clyde has been inserted to database
```

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

### Getting last inserted ID with get('_id')

Source: https://fatfreeframework.com/3.9/sql-mapper

Shows how to get the ID of the last inserted row or the last value from a sequence object using the reserved key '_id'.

```php
$lastInsertedID = $mapper->get('_id'); // get the ID of the last inserted row or the last value from a sequence object
```

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

### Run a route from CLI with web syntax

Source: https://fatfreeframework.com/3.9/routing-engine

Emulates an HTTP GET request to the specified route from the command line. Query strings are supported.

```bash
cd /path/to/test/suite
php index.php /my-awesome-route

```

```bash
php index.php /my-awesome-route?foo=bar

```

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

### get method signature

Source: https://fatfreeframework.com/3.9/basket

Signature for the get method, which retrieves the value of a field.

```php
scalar|FALSE get ( string $key )
```

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

### inspect() usage example

Source: https://fatfreeframework.com/3.9/pingback

Example call to the inspect() method with a source URL.

```php
$pingback->inspect($source);
```

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

### Constructor

Source: https://fatfreeframework.com/3.9/jig

Creates a new Jig database instance with a storage directory and optional format.

```APIDOC
## Constructor

### Description
Creates a new Jig database instance.

### Method
Constructor

### Endpoint
\DB\Jig::__construct

### Parameters
- **$dir** (string) - Required - Storage directory name, must end with a trailing slash.
- **$format** (int) - Optional - Storage format: \DB\Jig::FORMAT_JSON or \DB\Jig::FORMAT_Serialized.

### Request Example
```php
$db = new \DB\Jig('jig/', \DB\Jig::FORMAT_JSON);
```

### Response
No return value.
```

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

### Instantiate Web class

Source: https://fatfreeframework.com/3.9/web

Returns a singleton instance of the Web class using the Prefab factory wrapper.

```php
$web = \Web::instance();
```

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

### Configuration file with multi-line string

Source: https://fatfreeframework.com/3.9/framework-variables

Configuration file showing how strings can span over several lines using backslash continuation.

```ini
[globals]
str="this is a \
very long \
string"
```

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

### Base::config

Source: https://fatfreeframework.com/3.9/base

Configures the framework according to .ini-style file settings. Parses a configuration file and sets up framework variables and routes.

```APIDOC
## Base::config

### Description
Configures the framework according to .ini-style file settings. Parses a configuration file and sets up framework variables and routes.

### Method
config

### Signature
```
null config ( string $file [, bool $allow = FALSE ] )
```

### Parameters
- **$file** (string) - Required - Path to the configuration file.
- **$allow** (bool) - Optional - If TRUE, template strings are interpreted, making dynamic configs possible.

### Return Value
- **null** - No return value.

### Example
```
[globals]
foo = bar
baz = {{@foo}}
```
```

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

### ref usage example with new keys and dot notation

Source: https://fatfreeframework.com/3.9/base

Shows how to create new hive keys, array elements, and object properties using ref with the default $add=true, and how to use dot notation.

```php
$new = &$f3->ref('newVar'); // creates new framework hive var 'newVar' and returns reference to it
$new = 'hello world'; // set value of php variable, also updates reference
echo $f3->get('newVar'); // hello world

$new = &$f3->ref('newObj->name');
$new = 'Sheldon';
echo $f3->get('newObj')->name; // Sheldon
echo $f3->get('newObj->name'); // Sheldon
echo $f3->get('newObj.name'); // Sheldon

$a = &$f3->ref('hero.name');
$a = 'SpongeBob';
// or
$b = &$f3->ref('hero'); // variable
$b['name'] = 'SpongeBob';  // becomes array with key 'name'
$my_array = $f3->get('hero');
echo $my_array['name']; // 'SpongeBob'
```

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

### copyto() usage example

Source: https://fatfreeframework.com/3.9/basket

Example showing how to use copyto() to populate a hive variable.

```php
$basket->copyto($key);
```

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

### load method example

Source: https://fatfreeframework.com/3.9/basket

Loads an item by key/value pair and retrieves a field.

```php
$basket->load('name','peach');
echo $basket->get('amount'); // displays '10' (int)
```

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

### Automatic formatting of hive variables with get()

Source: https://fatfreeframework.com/3.9/base

Shows how to set a plural format string in the hive and then fetch and format it in one command using $f3->get(). The # sign is replaced by the numeral passed to get().

```php
$f3->set('a_books_story',
	'{0, plural,'.
		'zero	{There is n#thing on the table.},'.
		'one	{A book is on the table.},'.
		'two	{Two (#) books are on this table.},'.
		'other	{There are # books on the table.}'.
	'}'
);
echo $f3->get('a_books_story',0); // displays 'There is n0thing on the table.'
echo $f3->get('a_books_story',1); // displays 'A book is on the table.'
echo $f3->get('a_books_story',2); // displays 'Two (2) books are on this table.'
echo $f3->get('a_books_story',7); // displays 'There are 7 books on the table.'
```

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

### run

Source: https://fatfreeframework.com/3.9/base

Matches routes against the incoming URI and calls their route handlers.

```APIDOC
## run

### Description
Match routes against incoming URI and call their route handler. This is the main entry point to process the current request.

### Method
N/A (Framework method)

### Signature
```
null run ()
```

### Example
```
$f3 = require __DIR__.'/lib/base.php';
$f3->route('GET /',function(){
    echo "Hello World";
});
$f3->run();
```

### Notes
- After processing, the matching route pattern is saved in the PATTERN var, the current HTTP request URI in the URI var, and the request method in the VERB var.
- The PARAMS var contains all tokens as named keys, and additionally all tokens and wildcards as numeric keys, depending on their order of appearance.
- Generates a 404 error when a tokenized class doesn't exist.
- If a static and dynamic route pattern both match the current URI, the static route pattern has priority.
```

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

### mset usage example without prefix

Source: https://fatfreeframework.com/3.9/base

Shows how to set multiple hive variables at once using mset.

```php
$f3->mset(
    array(
        'var1'=>'value1',
        'var2'=>'value2',
        'var3'=>'value3',
    )
);

echo $f3->get('var1'); // value1
echo $f3->get('var2'); // value2
echo $f3->get('var3'); // value3
```

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

### card() usage example: echo $audit->card('343760667618602');

Source: https://fatfreeframework.com/3.9/audit

Example of using the card() method to retrieve the credit card type for a valid number. The example displays 'American Express' for the given number.

```php
echo $audit->card('343760667618602'); // displays 'American Express'
```

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

### OpenID::exists usage example

Source: https://fatfreeframework.com/3.9/openid

Example call to the exists method. Returns TRUE or FALSE.

```php
$exists = $openid->exists($key); // returns TRUE or FALSE
```

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

### Routing and rendering a template with Template::instance()

Source: https://fatfreeframework.com/3.9/views-and-templates

Sets up a route that assigns a value to the 'name' variable and renders the template using the singleton Template instance.

```php
$f3=require('lib/base.php');
$f3->route('GET /',
    function($f3) {
        $f3->set('name','world');
        echo \Template::instance()->render('template.htm');
    }
);
$f3->run();

```

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

### log example

Source: https://fatfreeframework.com/3.9/jig

Example of using jot and log to add and retrieve a log entry. The output shows the RFC 2822 formatted date and the frame.

```php
$db->jot('Merry Christmas');
echo $db->log();  // "Wed, 25 Dec 2013 08:27:58 +0100 Merry Christmas"
```

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

### OpenID::verified usage example

Source: https://fatfreeframework.com/3.9/openid

Example call to the verified method. Returns TRUE or FALSE.

```php
$openid->verified($proxy); // returns TRUE or FALSE
```

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

### OpenID::auth usage example

Source: https://fatfreeframework.com/3.9/openid

Example call to the auth method. Returns TRUE or FALSE.

```php
$openid->auth($proxy, $attr, $reqd); // returns TRUE or FALSE
```
Tokens:
Raw