1. class
  2. JsonBrowser
  3. \
  4. JsonBrowser

JsonBrowser

class JsonBrowser implements IteratorAggregate

Helper class for working with JSON-encoded data

Constants

OPT_NONEXISTENT_EXCEPTIONS

Throw exceptions instead of using NULL for nonexistent children & siblings
ERR_DECODING_ERROR

Error decoding JSON data
ERR_UNKNOWN_TYPE

Encountered an unknown type
ERR_UNKNOWN_CHILD

Unknown child
ERR_UNKNOWN_SIBLING

Unknown sibling
TYPE_NULL

NULL type
TYPE_BOOLEAN

Boolean type
TYPE_STRING

String type
TYPE_NUMBER

Number type
TYPE_INTEGER

Integer type (subset of TYPE_NUMBER)
TYPE_ARRAY

Array type
TYPE_OBJECT

Object type

Methods

__construct(string $json, int $options = 0)

Create a new instance

bool
childExists(mixed $key)

Check whether a child element exists

JsonBrowser
getChild(mixed $key)

Get a child node

Iterator
getIterator()

Get an iterator handle

string
getJSON(int $options = \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES | \JSON_UNESCAPED_UNICODE)

Get the JSON source for the current node

mixed
getKey()

Get the node index key (i.e. the child name within the parent node)

JsonBrowser
getNodeAt(string $path)

Get the node at a given path

JsonBrowser|null
getParent()

Get parent node

string
getPath()

Get the node path

JsonBrowser
getRoot()

Get root node

JsonBrowser
getSibling(mixed $key)

Get a sibling node

int
getType()

Get the document value type

mixed
getValue()

Get the document value

mixed
getValueAt(string $path)

Get the value at a given path

bool
isNotType(int $types)

Test whether the document value is not of a given type

bool
isType(int $types, bool $all = false)

Test whether the document value is of a given type

bool
siblingExists(mixed $key)

Check whether a sibling exists

Details

at line 81
__construct(string $json, int $options = 0)

Create a new instance

Parameters

string $json JSON-encoded data
int $options Configuration options (bitmask)

at line 117
bool childExists(mixed $key)

Check whether a child element exists

Parameters

mixed $key Index key

Return Value

bool Whether the given child exists

at line 137
JsonBrowser getChild(mixed $key)

Get a child node

Parameters

mixed $key Index key

Return Value

JsonBrowser Child node

at line 168
Iterator getIterator()

Get an iterator handle

Return Value

Iterator Iterator instance

at line 181
string getJSON(int $options = \JSON_PRETTY_PRINT | \JSON_UNESCAPED_SLASHES | \JSON_UNESCAPED_UNICODE)

Get the JSON source for the current node

Parameters

int $options Bitwise options for json_encode()

Return Value

string Encoded JSON string

at line 193
mixed getKey()

Get the node index key (i.e. the child name within the parent node)

Return Value

mixed Index key within parent node, or null if this is the root

at line 206
JsonBrowser getNodeAt(string $path)

Get the node at a given path

Parameters

string $path JSON pointer to the requested node

Return Value

JsonBrowser

at line 227
JsonBrowser|null getParent()

Get parent node

Return Value

JsonBrowser|null Parent node

at line 239
string getPath()

Get the node path

Return Value

string The node path as a JSON pointer

at line 251
JsonBrowser getRoot()

Get root node

Return Value

JsonBrowser Root node

at line 264
JsonBrowser getSibling(mixed $key)

Get a sibling node

Parameters

mixed $key Index key

Return Value

JsonBrowser

at line 282
int getType()

Get the document value type

Return Value

int

at line 322
mixed getValue()

Get the document value

Return Value

mixed

at line 335
mixed getValueAt(string $path)

Get the value at a given path

Parameters

string $path JSON pointer to the requested node

Return Value

mixed Value at the given path

at line 348
bool isNotType(int $types)

Test whether the document value is not of a given type

Parameters

int $types Types to test for

Return Value

bool Whether the type does not match

at line 362
bool isType(int $types, bool $all = false)

Test whether the document value is of a given type

Parameters

int $types Types to test for
bool $all Whether to require all types, or just one

Return Value

bool Whether the type matches

at line 378
bool siblingExists(mixed $key)

Check whether a sibling exists

Parameters

mixed $key Index key

Return Value

bool Whether the sibling exists