JsonValue

class JsonValue extends AbstractObject implements IdAble

Properties

| | $lastQuery | | from AbstractObject |

Methods

__construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

from AbstractObject

null|array|string|int|float|bool

queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

from AbstractObject

array

asArray()

Decode an array from json

bool

asBoolean()

Decode a boolean from json

int

asInteger()

Decode an integer from json

string

asString()

Decode a string from json

Json

contents(bool|null $pretty = false, string|null $indent = ' ')

Return the value encoded as json

JsonValue

field(array $path)

Lookup the field at the given path, and return its value.

array

fields()

List fields of the encoded object

AbstractId

id()

A unique identifier for this JSONValue.

JsonValue

newBoolean(bool $value)

Encode a boolean to json

JsonValue

newInteger(int $value)

Encode an integer to json

JsonValue

newString(string $value)

Encode a string to json

JsonValue

withContents(Json $contents)

Return a new json value, decoded from the given content

JsonValue

withField(array $path, JsonValue $value)

Set a new field at the given path

Details

in AbstractObject at line 13 __construct(AbstractClient $client, QueryBuilderChain $queryBuilderChain)

No description

Parameters

| AbstractClient | $client | | | QueryBuilderChain | $queryBuilderChain | |

in AbstractObject at line 19 protected null|array|string|int|float|bool queryLeaf(QueryBuilder $leafQueryBuilder, string $leafKey)

No description

Parameters

| QueryBuilder | $leafQueryBuilder | | | string | $leafKey | |

Return Value

| null|array|string|int|float|bool | |

at line 16 array asArray()

Decode an array from json

Return Value

| array | |

at line 25 bool asBoolean()

Decode a boolean from json

Return Value

| bool | |

at line 34 int asInteger()

Decode an integer from json

Return Value

| int | |

at line 43 string asString()

Decode a string from json

Return Value

| string | |

at line 52 Json contents(bool|null $pretty = false, string|null $indent = ' ')

Return the value encoded as json

Parameters

| bool|null | $pretty | | | string|null | $indent | |

Return Value

| Json | |

at line 67 JsonValue field(array $path)

Lookup the field at the given path, and return its value.

Parameters

| array | $path | |

Return Value

| JsonValue | |

at line 77 array fields()

List fields of the encoded object

Return Value

| array | |

at line 86 AbstractId id()

A unique identifier for this JSONValue.

Return Value

| AbstractId | |

at line 95 JsonValue newBoolean(bool $value)

Encode a boolean to json

Parameters

| bool | $value | |

Return Value

| JsonValue | |

at line 105 JsonValue newInteger(int $value)

Encode an integer to json

Parameters

| int | $value | |

Return Value

| JsonValue | |

at line 115 JsonValue newString(string $value)

Encode a string to json

Parameters

| string | $value | |

Return Value

| JsonValue | |

at line 125 JsonValue withContents(Json $contents)

Return a new json value, decoded from the given content

Parameters

| Json | $contents | |

Return Value

| JsonValue | |

at line 135 JsonValue withField(array $path, JsonValue $value)

Set a new field at the given path

Parameters

| array | $path | | | JsonValue | $value | |

Return Value

| JsonValue | |

Generated by Doctum, a API Documentation generator and fork of Sami.