Flow PHP

from_json()

Parameters

$path : Path|string

• string is internally turned into stream

$pointer : string|null = null

• if you want to iterate only results of a subtree, use a pointer, read more at https://github.com/halaxa/json-machine#parsing-a-subtree - @deprecate use withPointer method instead

$schema : null|Schema = null

• enforce schema on the extracted data - @deprecate use withSchema method instead

from_json_lines()

Used to read from a JSON lines https://jsonlines.org/ formatted file.

Parameters

$path : Path|string

• string is internally turned into stream

to_json()

Parameters

$path : Path|string

$flags : int = JSON_THROW_ON_ERROR

• PHP JSON Flags - @deprecate use withFlags method instead

$date_time_format : string = DateTimeInterface::ATOM

• format for DateTimeInterface::format() - @deprecate use withDateTimeFormat method instead

$put_rows_in_new_lines : bool = false

• if you want to put each row in a new line - @deprecate use withRowsInNewLines method instead

to_json_lines()

Used to write to a JSON lines https://jsonlines.org/ formatted file.

Parameters

$path : Path|string

schema_from_json_schema()

Convert a JSON Schema (https://json-schema.org) document into a Flow Schema.

Parameters

$json_schema : array<string, mixed>|Path|string

• decoded document, raw JSON document or a path to a schema file

$client : null|ClientInterface = null

• PSR-18 http client, required to resolve remote http(s) references

$request_factory : null|RequestFactoryInterface = null

• PSR-17 request factory, required to resolve remote http(s) references

schema_to_json_schema()

Convert a Flow Schema into a JSON Schema (https://json-schema.org, draft 2020-12) document.

Parameters

$schema : Schema