Cheat sheet¶

The calls you need most often, one line each. Every snippet is a fragment for an existing, bootstrapped application: import the functions it uses at the top of your PHP file. Each section links to the chapter with the complete behaviour.

Routes and responses¶

use function Naf\{abort, json, redirect, response, route};

route()->add('GET', '/products/{id}', [ProductController::class, 'show'], 'products.show');
route('products.show', ['id' => 42]);               // '/products/42'

return response('Plain text', 200, ['Content-Type' => 'text/plain; charset=UTF-8']);
return json(['id' => 42], 201);                     // application/json; charset=UTF-8
return redirect(route('products.show', ['id' => 42]));
abort(404, 'Product not found.');                   // throws; renders the error page

Routing · Requests and responses · Errors

Request input¶

use function Naf\{param, request};

$name  = param()->get('name', '');                  // query, form body or JSON body
$city  = param()->get('address.city');              // dot path into nested input
$body  = request()->getParsedBody();                // form fields only
$query = request()->getQueryParams();
$token = request()->getHeaderLine('Authorization');

Check the type of every value before using it; a field can arrive as an array. Requests and responses

Views¶

<?php
use function Naf\View\{asset, s, view};

asset()->add('/css/app.css');
$this->setLayout('layouts.main');
$this->block('content');
?>
<h1><?= s($pageTitle) ?></h1>
<?= view('partials.card', ['item' => $item]) ?>
<?php $this->endblock('content'); ?>

This template expects $pageTitle and $item, plus an application partial at app/views/partials/card.phtml. The layout must print $this->getBlock('content') and the collected CSS tags; see the complete layout in the Views guide. Content outside a captured block is not automatically inserted into a layout. Keep data keys distinct from block names such as title and content.

use function Naf\View\render;

return render('products.show', ['product' => $product]);   // app/views/products/show.phtml

Views and templates

Forms and CSRF¶

use function Naf\Form\validator;
use function Naf\View\render;
use function Naf\request;

$check = validator()->validate((array) request()->getParsedBody(), [
    'email' => 'required|string|email',
    'age'   => 'integer',
]);
if (!$check->isValid()) {
    return render('signup', ['check' => $check])->withStatus(422);
}

<?php use function Naf\Form\{csrf, error, memory}; use function Naf\View\s; ?>
<input type="hidden" name="_csrf" value="<?= s(csrf()->token()) ?>">
<input name="email" value="<?= s(memory('email') ?? '') ?>"> <?= error('email', $check) ?>

Forms and validation

Sessions¶

use function Naf\Session\session;

session()->set('cart', [42, 7]);
$cart = session()->get('cart', []);
session()->flash('notice', 'Saved.');
$notice = session()->getFlash('notice');            // read once, then gone

Sessions

Database¶

use function Naf\Database\database;

$statement = database()->prepare('SELECT * FROM products WHERE id = :id');
$statement->execute(['id' => $id]);
$product = $statement->fetch();                     // associative array or false

vendor/bin/naf db:migration:create
vendor/bin/naf db:migrate up

Database and migrations · ORM

Authentication¶

use Naf\Auth\Credentials\PasswordCredentials;
use function Naf\Auth\auth;

auth()->authenticate(new PasswordCredentials($username, $password));   // bool
auth()->user();                                     // your user model, or null
auth()->requirePermission('products.edit');         // 401 for guests, 403 without the grant
auth()->logout();

Authentication and permissions

Background work¶

use function Naf\Queue\queue;

queue()->push(SendInvoice::class, ['invoice_id' => 42]);

vendor/bin/naf queue:consume
vendor/bin/naf schedule:ticker

Queues and workers · Scheduled jobs · CLI commands

Mail and HTTP¶

use Nyholm\Psr7\Request;
use function Naf\Client\client;
use function Naf\Mail\{mail, mailer};

mailer()->send(mail()->setFrom('shop@example.com')->addTo($email)
    ->setSubject('Your order')->setContent($text, false));

$response = client()->sendRequest(new Request('GET', 'https://api.example.com/status'));

Mail delivery · HTTP client

Configuration, services and logging¶

use function Naf\{app, config, env, log};

$timeout = config('client:timeout', 20);            // colon path into app/config.php
if (env() === \Naf\Core\Environment::PROD) { /* … */ }
app()->container()->set(PaymentGateway::class, fn() => new StripeGateway(config('stripe:key')));
log()->info('Order {id} placed', ['id' => 42]);

Configuration · Configuration keys · Dependency injection · Function index