vladzimir/f3-tweaks

Tweaks for comfortable work with Fat-Free Framework

dev-main 2025-08-22 11:04 UTC

Requires

• php: ~8.3.0
• ext-openssl: *
• bcosca/fatfree-core: ~3.9.0

GPL-3.0

• tweaks
• F3
• fatfree

README

Tweaks for comfortable work with f3

• IDE auto-suggestions for system variables and easy work with them
• works with F3 v3.9 and PHP v8.3+

Installation

• Method 1: use composer: composer require vladzimir/f3-tweaks

• Method 2: copy the folder lib/* contents an into your F3 lib/ directory or another directory that is known to the AUTOLOADER

How to use

use Tweaks\Tweaks;
use Tweaks\Enums\EnumSystem as System;

//Tweak base functions f3
Tweaks::fw()->Base_Functions_F3();

//Easy access to system variables
System::SEED->set('qSwDeFr');

//Tweaks to access for PHP globals
Tweaks::headers()->get('Host');
Tweaks::params()->getAll();

List tweaks

cookie()
env()
files()
get()
params()
post()
request()
server()
session()
headers()
system()
cache()
url()
routing()
base64()
cipher()
hasher()
password()
scrambler()

Simple use of aliases

Create Enums with you aliases

namespace Enums\Aliases;

use Tweaks\Enums\Interfaces\EnumInterfaceAlias;
use Tweaks\Enums\Traits\EnumTraitAlias;

enum EnumAliasAdmin implements EnumInterfaceAlias
{
    use EnumTraitAlias;

    case ALIAS_NUMBER_1;
    case ALIAS_NUMBER_2;
}

Usage in routes config

use Enums\Aliases\EnumAliasAdmin;
use Tweaks\Tweaks;
use Tweaks\Enums\EnumVerbs;

EnumAliasAdmin::ALIAS_NUMBER_1->route(
    EnumVerbs::GET,
    "/admin/url1",
    [ControllerAdmin::class, 'method1'], //Hint and clickable class/method. Autodetect is static/dynamic method.
    0, //Cache none
    5 //Throttle 5kbps
);

EnumAliasAdmin::ALIAS_NUMBER_2->rest(
    "/admin/url2",
    ControllerAdmin::class
);

//Check is current alias
EnumAliasAdmin::ALIAS_NUMBER_1->isCurrentAlias();
//OR from Tweaks
Tweaks::routing()->isCurrentAlias('@ALIAS_NUMBER_2');

OR with group

Tweaks::routing()->group("/admin", function () {
    EnumAliasAdmin::ALIAS_NUMBER_1->route(
        EnumVerbs::GET,
        "/url1",
        [ControllerAdmin::class, 'method1']
    );

    EnumAliasAdmin::ALIAS_NUMBER_2->route(
        EnumVerbs::GET,
        "/url2",
        [ControllerAdmin::class, 'method2']
    );
});

Usage in templates

use Enums\Aliases\EnumAliasAdmin;
use Tweaks\Tweaks;

echo EnumAliasAdmin::ALIAS_NUMBER_1->getUrl();

Simple reroute

EnumAliasAdmin::ALIAS_NUMBER_1->reroute();

Alias is generated uniquely name, based on enum and case. Therefore, the enum name must be unique to avoid collisions Eg:

EnumAliasAdmin__ALIAS_NUMBER_1 EnumAliasAdmin__ALIAS_NUMBER_2