src/site/php host-helpers.php

Functions

cfw_host(string  $name) : mixed

Reads a capability the host installed on the Module.

string

$name

The capability the host installed on the Module.

mixed —

The host function, or NULL when there is no bridge.

package	Application

cfw_call(callable  $fn, array  $payload) : array<string,mixed>

Sends one request across the bridge and decodes the reply.

callable	$fn	The host function from cfw_host().
array	$payload	The request, run through the pw codec.

array —

The decoded reply, or an ok => false refusal naming what went wrong.

package	Application

cfw_sql(string  $sql, array  $params = []) : array<string,mixed>

Runs one SQL statement on the object's database.

string	$sql	One statement.
array	$params	Positional or named bindings.

array —

The host reply: ok, and rows on a read.

package	Application

cfw_txn(array}>  $statements, bool  $commit = true, array{sql: string, params: array}|null  $read = null) : array<string,mixed>

Runs statements in one transaction, optionally reading inside it.

array}>	$statements	The statements to run in one transaction.
bool	$commit	Whether to commit rather than roll back.
array{sql: string, params: array}\|null	$read	A statement to run inside the transaction and report.

array —

The host reply: ok, and readResult when a read was asked for.

package	Application