NexusClient

// access
$nexus = NexusClient::create('nxs_…')

NexusClientCopy Anchor Link

class Inverge\Nexus\NexusClient

The Nexus server-side SDK. Framework-agnostic: construct once with an API key and use any resource.

$nexus = NexusClient::create('nxs_live_...');
$nexus->realtime()->emit('orders:42', 'status', ['state' => 'shipped']);
$nexus->events()->capture('order_placed', ['total' => 42.0], ['distinctId' => 'u_1']);
$flags = $nexus->flags()->evaluate('u_1');

__constructCopy Anchor Link

function __construct(Inverge\Nexus\Config $config, ?Inverge\Nexus\Contracts\Transport $transport = NULL, ?Inverge\Nexus\Contracts\Dispatcher $dispatcher = NULL)

Parameters

create()Copy Anchor Link

static function create(string $apiKey, array $options = []): self

Convenience factory using the built-in cURL transport.

Parameters

Returns self

withDispatcher()Copy Anchor Link

function withDispatcher(Inverge\Nexus\Contracts\Dispatcher $dispatcher): self

A clone that delivers through a different dispatcher — e.g. a queued one for fire-and-forget telemetry. Result-returning calls (flags, sessions) shouldn't be used on a deferred dispatcher since they can't return.

Parameters

Returns self

realtime()Copy Anchor Link

function realtime(): Inverge\Nexus\Resource\Realtime

Returns Inverge\Nexus\Resource\Realtime

events()Copy Anchor Link

function events(): Inverge\Nexus\Resource\Events

Returns Inverge\Nexus\Resource\Events

errors()Copy Anchor Link

function errors(): Inverge\Nexus\Resource\Errors

Returns Inverge\Nexus\Resource\Errors

logs()Copy Anchor Link

function logs(): Inverge\Nexus\Resource\Logs

Returns Inverge\Nexus\Resource\Logs

sessions()Copy Anchor Link

function sessions(): Inverge\Nexus\Resource\Sessions

Returns Inverge\Nexus\Resource\Sessions

flags()Copy Anchor Link

function flags(): Inverge\Nexus\Resource\Flags

Returns Inverge\Nexus\Resource\Flags

links()Copy Anchor Link

function links(): Inverge\Nexus\Resource\Links

Returns Inverge\Nexus\Resource\Links

surveys()Copy Anchor Link

function surveys(): Inverge\Nexus\Resource\Surveys

Returns Inverge\Nexus\Resource\Surveys

remoteConfig()Copy Anchor Link

function remoteConfig(): Inverge\Nexus\Resource\RemoteConfig

Returns Inverge\Nexus\Resource\RemoteConfig

push()Copy Anchor Link

function push(): Inverge\Nexus\Resource\Push

Returns Inverge\Nexus\Resource\Push

inApp()Copy Anchor Link

function inApp(): Inverge\Nexus\Resource\InApp

Returns Inverge\Nexus\Resource\InApp

liveActivities()Copy Anchor Link

function liveActivities(): Inverge\Nexus\Resource\LiveActivities

Returns Inverge\Nexus\Resource\LiveActivities

telescope()Copy Anchor Link

function telescope(array $options = []): Inverge\Nexus\Telescope\Telescope

Request-journey tracing (Nexus Telescope). The Laravel and Symfony integrations drive it automatically; call it directly anywhere else. Options apply the first time it is created (see Telescope::__construct()).

Parameters

Returns Inverge\Nexus\Telescope\Telescope

config()Copy Anchor Link

function config(): Inverge\Nexus\Config

Returns Inverge\Nexus\Config

enabled()Copy Anchor Link

function enabled(string $service): bool

Whether a product is switched on (see Services) — e.g. to skip building an expensive payload: if ($nexus->enabled(Services::PUSH)) ….

Parameters

Returns bool

ConfigCopy Anchor Link

class Inverge\Nexus\Config

Immutable SDK configuration. Partner endpoints live under /partner on the base URL and authenticate with the x-api-key header.

__constructCopy Anchor Link

function __construct(string $apiKey, string $baseUrl = 'https://services.inverge.net', float $timeout = 10.0, array $defaultHeaders = [], ?Inverge\Nexus\Services $services = NULL)

Parameters

fromArray()Copy Anchor Link

static function fromArray(string $apiKey, array $options = []): self

services switches products off, e.g. ['push' => false] (unset = from the environment); enabled => false turns everything off.

Parameters

Returns self

services()Copy Anchor Link

function services(): Inverge\Nexus\Services

The effective switches: the explicit ones, else the environment's (read once). */

Returns Inverge\Nexus\Services

httpBase()Copy Anchor Link

function httpBase(): string

The base URL without a trailing slash. */

Returns string

ServicesCopy Anchor Link

class Inverge\Nexus\Services

Per-service on/off switches — turn a Nexus product off without removing the code that uses it. A disabled service makes no network call and never throws: writes are skipped and reads return their neutral value (flags → defaults, Remote Config → defaults, lists → empty).

From the environment (all default to on):

NEXUS_ENABLED=false # everything off NEXUS_PUSH_ENABLED=false # only push off NEXUS_LIVE_ACTIVITIES_ENABLED=false # only Live Activities off

One variable per service — see self::ENV. false, 0, off and no mean off; anything else (or unset) means on.

allEnabled()Copy Anchor Link

static function allEnabled(): self

Everything on. */

Returns self

fromArray()Copy Anchor Link

static function fromArray(array $switches, string|int|bool|null $enabled = true): self

From switches, e.g. ['push' => false] (unknown keys are rejected so a typo can't silently leave a service on). enabled is the master switch.

Parameters

Returns self

fromEnvironment()Copy Anchor Link

static function fromEnvironment(?array $env = NULL): self

From environment variables (getenv, then $_ENV / $_SERVER).

Parameters

Returns self

forPath()Copy Anchor Link

static function forPath(string $path): ?string

The service a /partner/... path belongs to, or null for unswitched paths. */

Parameters

Returns ?string

enabled()Copy Anchor Link

function enabled(string $service): bool

Parameters

Returns bool

reason()Copy Anchor Link

function reason(string $service): string

Why a service is off — for logs. */

Parameters

Returns string