AJAX - Jet\AJAX

Jedná se o velice malou, ale užitečnou třídu, která unifikuje a usnadňuje generování odpovědí na požadavky a operace poslané frontendem aplikace přes XHR.

Metoda	Význam
public static commonResponse( mixed $response_data, array $http_headers=[], int $http_code=200 ) : void	Obecná odpověď ve formátu JSON Parametry: $response_dat Libovolná data, která budou převedena do formátu JSON. (Data samozřejmě musí být do JSON převeditelná, to znamená že třídy objektů musí implementovat PHP rozhraní JsonSerializable. To však všechny relevantní třídy v rámci Jet splňují.) $http_headers Volitelné HTTP hlavičky odpovědi. Viz Jet\Http_Headers. $http_code Vilitelný HTTP kód odpovědi. Viz Jet\Http_Headers.
public static operationResponse( bool $success, array $snippets=[], array $data=[] ) : void	Strukturovaná odpověď na určitou operaci (například odeslání formuláře) ve formátu JSON Parametry: $success Indikuje zda operace proběhla / neproběhla úspěšně (bool). $snippets Vygenerované části UI, které je nutné po operaci (ať byla úspěšná nebo ne - to není rozhodující) překreslit. Fakticky se jedná o pole obsahující kusy HTML a klíče tohoto pole jsou ID HTML elementů do kterých budou tyto kousky HTML umístěny. Příklad: Pokud je přes AJAX odesnán formulář a není validní, tak snippet může být onen formulář doplněný o hodnoty, ale i chybová hlášení, nápovědy a tak dále. $data Libovolná data, která budou převedena do formátu JSON. (Data samozřejmě musí být do JSON převeditelná, to znamená že třídy objektů musí implementovat PHP rozhraní JsonSerializable. To však všechny relevantní třídy v rámci Jet splňují.)

Metoda

Význam

public static commonResponse(
mixed $response_data,
array $http_headers=[],
int $http_code=200
) : void

Obecná odpověď ve formátu JSON

Parametry:

$response_dat
Libovolná data, která budou převedena do formátu JSON. (Data samozřejmě musí být do JSON převeditelná, to znamená že třídy objektů musí implementovat PHP rozhraní JsonSerializable. To však všechny relevantní třídy v rámci Jet splňují.)
$http_headers
Volitelné HTTP hlavičky odpovědi. Viz Jet\Http_Headers.
$http_code
Vilitelný HTTP kód odpovědi. Viz Jet\Http_Headers.

public static operationResponse(
bool $success,
array $snippets=[],
array $data=[]
) : void

Strukturovaná odpověď na určitou operaci (například odeslání formuláře) ve formátu JSON

Parametry:

$success
Indikuje zda operace proběhla / neproběhla úspěšně (bool).
$snippets
Vygenerované části UI, které je nutné po operaci (ať byla úspěšná nebo ne - to není rozhodující) překreslit. Fakticky se jedná o pole obsahující kusy HTML a klíče tohoto pole jsou ID HTML elementů do kterých budou tyto kousky HTML umístěny. Příklad: Pokud je přes AJAX odesnán formulář a není validní, tak snippet může být onen formulář doplněný o hodnoty, ale i chybová hlášení, nápovědy a tak dále.
$data
Libovolná data, která budou převedena do formátu JSON. (Data samozřejmě musí být do JSON převeditelná, to znamená že třídy objektů musí implementovat PHP rozhraní JsonSerializable. To však všechny relevantní třídy v rámci Jet splňují.)