Aller au contenu principal
Version: Canary 🚧

🪒 Helpers

Introduction​

Les helpers sont des fonctions raccourcies chargées dans l'application qui permet de faire rapidement certaine action. Voici la liste des helpers qui existe dans l'application Bow Framework. Voici les helpers dispnoble dans l'application.

Helper de gestion HTTP​

app, config, response, request, json, download, set_status_code, view, session, cookie, create_csrf_token, csrf_token, csrf_field, method_field, generate_token_csrf, verify_csrf, csrf_time_is_expired, sanitize, secure, set_header, get_header, redirect, send, curl, url, flash, validator, route, old, client_locale, redirect_back

Base de donnée​

db, table, get_last_insert_id, db_select, db_select_one, db_insert, db_delete, db_update, db_statement, db_transaction, db_transaction_started, db_rollback, pdo, set_pdo, db_commit, db_seed

Sécurité​

encrypt, decrypt, app_hash, bow_hash

Gestion d'évènement​

listen_event, listen_event_once, listen_transmission_event, listen__transmission_event, emitter, emit_event

Système de storage​

ftp, s3, config, mount, file_system, cache

helper Application​

app_env, app_assets, app_abort, app_abort_if, app_mode, auth, logger

Chaine de caractère​

str_slug, str_is_mail, str_is_domain, str_is_slug, str_is_alpha, str_is_lower, str_is_upper, str_is_alpha_num, str_shuffle_words, str_wordify, str_plurial, str_camel, str_snake, str_contains, str_capitalize, str_random, str_force_in_utf8, e, str_fix_utf8

Email​

email, raw_email

Autre​

debug, sep, collect, trans, t, __

Utilisation​

app​

Ce helper permet d'avoir accès au container de Bow Framework.

app("mail");

config​

Permet d'avoir accès à la configuration de Bow Framework.

config("mail")

response​

Permet d'avoir accès à une instance de \Bow\Http\Response::class.Elle doit être utilisée impérativement dans un controlleur. Avoir plus d'information sur les méthodes possible ici

return response($content = "hello papac", $code = 200);

request​

Permet d'avoir accès à une instance de \Bow\Http\Request::class. Elle doit être utilisée impérativement dans un controlleur. Avoir plus d'information sur les méthodes possible ici

$name = request()->get("name");

json​

Permet d'utiliser le méthode json de \Bow\Http\Response::class. Elle doit être utilisée impérativement dans un controlleur.

return json(["name" => "papac"], $code = 200);
// {"name": "papac"}

download​

Permet lors d'une requête de télécharger un fichier et elle est liée sur la classe \Bow\Http\Response::class. Elle doit être utilisée impérativement dans un controlleur.

$file = "/path/to/file.png";
$filename = "photo.png";

return download($file, $filename);

set_status_code​

Permet de modifier le code du statut http de réponse et elle est liée sur la classe \Bow\Http\Response::class. Elle doit être utilisée impérativement dans un controlleur.

set_status_code(404);

view​

Permet de compiler une vue dans Bow Framework.

return view("view.name", ["name" => "papac"], $code = 200);

session​

Permet de manipuler l'interface de session dans Bow Framework.

session($value, $default = null)
  • Si aucun argument n'est passĂ©. Elle recupère l'instance de la session
  • Si default est fournie et que la valeur n'existe pas elle sera retournĂ© comme valeur de remplacement
  • Si $value est un tableau associatif elle ajoutera ces informations dans la session en couple de clĂ© valeur.
cookie("name", "papac");
// papac

create_csrf_token​

create_csrf_token();
// papac

csrf_token​

$token = csrf_token();
// papac

csrf_field​

$field = csrf_field();
// <input type="hidden" name="token" value="token_value" />

method_field​

$method = method_field("DELETE")
// <input type="hidden" name="_method" value="DELETE" />

generate_token_csrf​

generate_token_csrf();
// papac

verify_csrf​

verify_csrf($token);
// bool

csrf_time_is_expired​

csrf_time_is_expired();
// bool

sanitize​

$name = sanitize("papa'c")
// papac

secure​

$name = request()->get("name");
// papac

set_header​

set_header("X-Token-API", $token);

get_header​

$token = get_header("X-Token-API");
// papac

redirect​

return redirect();
// papac

redirect_back​

return redirect_back();

send​

return send("hello papac");
// hello papac

curl​

curl("https://github.com/bowphp");

url​

$name = request()->get("name");
// papac

flash​

$name = request()->get("name");
// papac

validator​

$name = request()->get("name");
// papac

route​

$name = request()->get("name");
// papac

old​

$name = request()->get("name");
// papac

client_locale​

$name = request()->get("name");
// papac

https://github.com/bowphp/framework/blob/4.0/src/Support/helper.php

Il manque quelque chose ?

Si vous rencontrez des problèmes avec la documentation ou si vous avez des suggestions pour améliorer la documentation ou le projet en général, veuillez déposer une issue pour nous, ou envoyer un tweet mentionnant le compte Twitter @bowframework ou sur directement sur le github.