Snippets

use Shipeasy\Client;

// construct once per callsite (cheap; binds the user)
$client = new Client($currentUser);

$enabled = $client->getFlag(
    'new_checkout',   // gate name
    false,            // optional $default — returned ONLY when unevaluable
);                    //   (SDK not ready / flag not in blob), NOT when the gate is off

use Shipeasy\Client;

// construct once per callsite (cheap; binds the user)
$client = new Client($currentUser);

$value = $client->getConfig(
    'billing_copy',                // config name
    ['headline' => 'Welcome'],       // optional $default — returned when the config key is absent
);

use Shipeasy\Client;

// construct once per callsite (cheap; binds the user)
$client = new Client($currentUser);

$panic = $client->getKillswitch(
    'payments',   // kill switch name
    null,                   // optional $switchKey — read a named per-key override
);                          //   (null = top-level value; unconfigured key falls back to it too)

use Shipeasy\Client;

// construct once per callsite (cheap; binds the user)
$client = new Client($currentUser);

// track($event, $props = [])
//   $event — the event your metric is built on (required)
//   $props — optional payload; numeric/string fields you can sum/filter on
//            in a metric (private attributes are stripped before egress)
$client->track('checkout_started', ['amount' => 49, 'currency' => 'usd']);

use Shipeasy\Client;

// construct once per callsite
$client = new Client($currentUser);

$client->track('checkout_started');   // $props are optional

use function Shipeasy\see;

try {
    charge($order);
} catch (\Throwable $e) {
    // ->causesThe($subject)   what the error affects (e.g. "checkout"; default "app")
    // ->to($outcome)          the terminal — what you do about it; builds + fires once
    see($e)->causesThe('checkout')->to('use the backup processor');
    fallbackCharge($order);
}

use function Shipeasy\see;

try {
    charge($order);
} catch (\Throwable $e) {
    // ->to($outcome, $array)  PREFERRED: fold the extras into the terminal. The
    //                         consequence sentence stays whole and there is no
    //                         ordering to remember.
    see($e)->causesThe('checkout')->to('use cached prices', ['order_id' => $oid]);

    // ->to fires synchronously here, so a trailing ->extras AFTER ->to is
    // ignored with a warning (it never throws into the catch block) — the
    // extras are DROPPED. Use the inline form above, or addExtras() below.
    // see($e)->causesThe('checkout')->to('use cached prices')->extras(['order_id' => $oid]);

    // NEVER: extras wedged between the subject and the outcome — it splits the
    // consequence sentence in half and is hard to read.
    // see($e)->causesThe('checkout')->extras(['order_id' => $oid])->to('use cached prices');
}

use function Shipeasy\addExtras;
use function Shipeasy\see;

// Buffer extras earlier in the request — from any layer, not just the catch.
// Every see() report that fires LATER in the same request carries them, so you
// don't have to thread context down into the catch site. A chained ->extras /
// ->to extra of the same key wins over the ambient one.
addExtras(['order_id' => $order->id, 'tenant' => $tenant->slug]);

// ...deep in a service, later in the same request...
try {
    charge($order);
} catch (\Throwable $e) {
    // report carries order_id + tenant automatically.
    see($e)->causesThe('checkout')->to('use cached prices');
}

// PHP is share-nothing per request: under PHP-FPM / mod_php the buffer resets
// per request automatically. Under a long-running runtime (Swoole / RoadRunner /
// a resident worker loop) call Shipeasy\clearExtras() at request end.

use function Shipeasy\seeViolation;

// a bad state that isn't an exception — the name is a STABLE fingerprint; put
// variable data in ->extras(), never the name. ->to() is the terminal.
seeViolation('missing_invoice')->causesThe('billing')->to('skip the dunning email');

use function Shipeasy\controlFlowException;

try {
    parse($token);
} catch (\Throwable $e) {
    // transmits nothing; ->because(...) / ->extras() are local-debug only
    controlFlowException($e)->because('end of stream is expected');
}