1. class
  2. Hypervel
  3. \
  4. Testing
  5. \
  6. AssertableJsonString

AssertableJsonString

class AssertableJsonString implements ArrayAccess, Countable

Properties

Jsonable|JsonSerializable|array|string $json

The original encoded json.
protected mixed $decoded

The decoded json contents.

Methods

__construct(Jsonable|JsonSerializable|array|string $jsonable)

Create a new assertable JSON string instance.

mixed
json(string|null $key = null)

Validate and return the decoded response JSON.

mixed
object(string|null $key = null)

Return the decoded JSON with objects as stdClass instances.

AssertableJsonString
assertCount(int $count, string|null $key = null)

Assert that the response JSON has the expected count of items at the given key.

AssertableJsonString
assertExact(array $data)

Assert that the response has the exact given JSON.

AssertableJsonString
assertSimilar(array $data)

Assert that the response has the similar JSON as given.

AssertableJsonString
assertFragment(array $data)

Assert that the response contains the given JSON fragment.

AssertableJsonString
assertMissing(array $data, bool $exact = false)

Assert that the response does not contain the given JSON fragment.

AssertableJsonString
assertMissingExact(array $data)

Assert that the response does not contain the exact JSON fragment.

AssertableJsonString
assertMissingPath(string $path)

Assert that the response does not contain the given path.

bool
hasJsonPath(mixed $data, array $segments)

Determine whether a JSON path exists, where each wildcard matches any child at its level.

AssertableJsonString
assertPath(string $path, mixed $expect)

Assert that the expected value and type exists at the given path in the response.

AssertableJsonString
assertPathCanonicalizing(string $path, array $expect)

Assert that the given path in the response contains all of the expected values without looking at the order.

AssertableJsonString
assertStructure(array|null $structure = null, array|null $responseData = null, bool $exact = false)

Assert that the response has a given JSON structure.

AssertableJsonString
assertSubset(array $data, bool $strict = false)

Assert that the response is a superset of the given JSON.

array
reorderAssocKeys(array $data)

Reorder associative array keys to make it easy to compare arrays.

string
assertJsonMessage(array $data)

Get the assertion message for assertJson.

array
jsonSearchStrings(string|int $key, mixed $value)

Get the strings we need to search for when examining the JSON.

int
count()

Get the total number of items in the underlying JSON array.

bool
offsetExists(mixed $offset)

Determine whether an offset exists.

mixed
offsetGet(mixed $offset)

Get the value at the given offset.

void
offsetSet(mixed $offset, mixed $value)

Set the value at the given offset.

void
offsetUnset(mixed $offset)

Unset the value at the given offset.

Details

at line 37
__construct(Jsonable|JsonSerializable|array|string $jsonable)

Create a new assertable JSON string instance.

Parameters

Jsonable|JsonSerializable|array|string $jsonable

at line 59
mixed json(string|null $key = null)

Validate and return the decoded response JSON.

Parameters

string|null $key

Return Value

mixed

at line 71
mixed object(string|null $key = null)

Return the decoded JSON with objects as stdClass instances.

Unlike json(), this keeps empty and numeric-key JSON objects distinct from arrays.

Parameters

string|null $key

Return Value

mixed

Exceptions

JsonException

at line 83
AssertableJsonString assertCount(int $count, string|null $key = null)

Assert that the response JSON has the expected count of items at the given key.

Parameters

int $count
string|null $key

Return Value

AssertableJsonString

at line 109
AssertableJsonString assertExact(array $data)

Assert that the response has the exact given JSON.

Parameters

array $data

Return Value

AssertableJsonString

at line 128
AssertableJsonString assertSimilar(array $data)

Assert that the response has the similar JSON as given.

Parameters

array $data

Return Value

AssertableJsonString

at line 145
AssertableJsonString assertFragment(array $data)

Assert that the response contains the given JSON fragment.

Parameters

array $data

Return Value

AssertableJsonString

at line 172
AssertableJsonString assertMissing(array $data, bool $exact = false)

Assert that the response does not contain the given JSON fragment.

Parameters

array $data
bool $exact

Return Value

AssertableJsonString

at line 203
AssertableJsonString assertMissingExact(array $data)

Assert that the response does not contain the exact JSON fragment.

Parameters

array $data

Return Value

AssertableJsonString

at line 231
AssertableJsonString assertMissingPath(string $path)

Assert that the response does not contain the given path.

Parameters

string $path

Return Value

AssertableJsonString

at line 252
protected bool hasJsonPath(mixed $data, array $segments)

Determine whether a JSON path exists, where each wildcard matches any child at its level.

Parameters

mixed $data
array $segments

Return Value

bool

at line 282
AssertableJsonString assertPath(string $path, mixed $expect)

Assert that the expected value and type exists at the given path in the response.

Parameters

string $path
mixed $expect

Return Value

AssertableJsonString

at line 298
AssertableJsonString assertPathCanonicalizing(string $path, array $expect)

Assert that the given path in the response contains all of the expected values without looking at the order.

Parameters

string $path
array $expect

Return Value

AssertableJsonString

at line 308
AssertableJsonString assertStructure(array|null $structure = null, array|null $responseData = null, bool $exact = false)

Assert that the response has a given JSON structure.

Parameters

array|null $structure
array|null $responseData
bool $exact

Return Value

AssertableJsonString

at line 352
AssertableJsonString assertSubset(array $data, bool $strict = false)

Assert that the response is a superset of the given JSON.

Parameters

array $data
bool $strict

Return Value

AssertableJsonString

at line 367
protected array reorderAssocKeys(array $data)

Reorder associative array keys to make it easy to compare arrays.

Parameters

array $data

Return Value

array

at line 384
protected string assertJsonMessage(array $data)

Get the assertion message for assertJson.

Parameters

array $data

Return Value

string

at line 399
protected array jsonSearchStrings(string|int $key, mixed $value)

Get the strings we need to search for when examining the JSON.

Parameters

string|int $key
mixed $value

Return Value

array

at line 413
int count()

Get the total number of items in the underlying JSON array.

Return Value

int

at line 421
bool offsetExists(mixed $offset)

Determine whether an offset exists.

Parameters

mixed $offset

Return Value

bool

at line 429
mixed offsetGet(mixed $offset)

Get the value at the given offset.

Parameters

mixed $offset

Return Value

mixed

at line 437
void offsetSet(mixed $offset, mixed $value)

Set the value at the given offset.

Parameters

mixed $offset
mixed $value

Return Value

void

at line 445
void offsetUnset(mixed $offset)

Unset the value at the given offset.

Parameters

mixed $offset

Return Value

void