1. class
  2. Illuminate
  3. \
  4. Testing
  5. \
  6. Fluent
  7. \
  8. AssertableJson

AssertableJson

class AssertableJson implements Arrayable (View source)

Traits

Has
Matching
Debugging
Interaction
Conditionable
Macroable
Tappable
Dumpable

Properties

protected array $interacted

The list of interacted properties.

 from  Interaction
static protected array $macros

The registered string macros.

 from  Macroable

Methods

Has
count(string|int $key, int|null $length = null)

Assert that the prop is of the expected size.

from  Has
Has
countBetween(int|string $min, int|string $max)

Assert that the prop size is between a given minimum and maximum.

from  Has
$this
has(string $key, null $value = null, Closure|null $scope = null)

Ensure that the given prop exists.

from  Matching
Has
hasAll(array|string $key)

Assert that all of the given props exist.

from  Has
Has
hasAny(array|string $key)

Assert that at least one of the given props exists.

from  Has
Has
missingAll(array|string $key)

Assert that none of the given props exist.

from  Has
Has
missing(string $key)

Assert that the given prop does not exist.

from  Has
string
dotPath(string $key = '')

Compose the absolute "dot" path to the given key.

void
interactsWith(string $key)

Marks the property as interacted.

from  Interaction
mixed
prop(string|null $key = null)

Retrieve a prop within the current scope using "dot" notation.

AssertableJson
scope(string $key, Closure $callback)

Instantiate a new "scope" at the path of the given key.

Interaction
etc()

Disables the interaction check.

from  Interaction
AssertableJson
first(Closure $callback)

Instantiate a new "scope" on the first child element.

Matching
where(string $key, mixed|Closure $expected)

Asserts that the property matches the expected value.

from  Matching
Matching
whereNot(string $key, mixed|Closure $expected)

Asserts that the property does not match the expected value.

from  Matching
Matching
whereAll(array $bindings)

Asserts that all properties match their expected values.

from  Matching
Matching
whereType(string $key, string|array $expected)

Asserts that the property is of the expected type.

from  Matching
Matching
whereAllType(array $bindings)

Asserts that all properties are of their expected types.

from  Matching
$this
whereContains(string $key, mixed $expected)

Asserts that the property contains the expected values.

from  Matching
void
ensureSorted(mixed $value)

Ensures that all properties are sorted the same way, recursively.

from  Matching
never
dd(mixed ...$args)

Dump the given arguments and terminate execution.

from  Dumpable
$this
dump(mixed ...$args)

Dump the given arguments.

from  Dumpable
void
interacted()

Asserts that all properties have been interacted with.

from  Interaction
$this|TWhenReturnType
when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

from  Conditionable
$this|TUnlessReturnType
unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

from  Conditionable
static void
macro(string $name, object|callable $macro)

Register a custom macro.

from  Macroable
static void
mixin(object $mixin, bool $replace = true)

Mix another object into the class.

from  Macroable
static bool
hasMacro(string $name)

Checks if macro is registered.

from  Macroable
static void
flushMacros()

Flush the existing macros.

from  Macroable
static mixed
__callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
mixed
__call(string $method, array $parameters)

Dynamically handle calls to the class.

from  Macroable
tap($callback = null)

Call the given Closure with this instance then return the instance.

from  Tappable
__construct(array $props, string|null $path = null)

Create a new fluent, assertable JSON data instance.

AssertableJson
each(Closure $callback)

Instantiate a new "scope" on each child element.

static AssertableJson
fromArray(array $data)

Create a new instance from an array.

static AssertableJson
fromAssertableJsonString(AssertableJsonString $json)

Create a new instance from an AssertableJsonString.

toArray()

Get the instance as an array.

Details

in Has at line 18
Has count(string|int $key, int|null $length = null)

Assert that the prop is of the expected size.

Parameters

string|int $key
int|null $length

Return Value

Has

in Has at line 50
Has countBetween(int|string $min, int|string $max)

Assert that the prop size is between a given minimum and maximum.

Parameters

int|string $min
int|string $max

Return Value

Has

in Matching at line 231
abstract $this has(string $key, null $value = null, Closure|null $scope = null)

Ensure that the given prop exists.

Parameters

string $key
null $value
Closure|null $scope

Return Value

$this

in Has at line 128
Has hasAll(array|string $key)

Assert that all of the given props exist.

Parameters

array|string $key

Return Value

Has

in Has at line 149
Has hasAny(array|string $key)

Assert that at least one of the given props exists.

Parameters

array|string $key

Return Value

Has

in Has at line 171
Has missingAll(array|string $key)

Assert that none of the given props exist.

Parameters

array|string $key

Return Value

Has

in Has at line 188
Has missing(string $key)

Assert that the given prop does not exist.

Parameters

string $key

Return Value

Has

at line 56
protected string dotPath(string $key = '')

Compose the absolute "dot" path to the given key.

Parameters

string $key

Return Value

string

in Interaction at line 23
protected void interactsWith(string $key)

Marks the property as interacted.

Parameters

string $key

Return Value

void

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

Retrieve a prop within the current scope using "dot" notation.

Parameters

string|null $key

Return Value

mixed

at line 83
protected AssertableJson scope(string $key, Closure $callback)

Instantiate a new "scope" at the path of the given key.

Parameters

string $key
Closure $callback

Return Value

AssertableJson

in Interaction at line 53
Interaction etc()

Disables the interaction check.

Return Value

Interaction

at line 103
AssertableJson first(Closure $callback)

Instantiate a new "scope" on the first child element.

Parameters

Closure $callback

Return Value

AssertableJson

in Matching at line 21
Matching where(string $key, mixed|Closure $expected)

Asserts that the property matches the expected value.

Parameters

string $key
mixed|Closure $expected

Return Value

Matching

in Matching at line 59
Matching whereNot(string $key, mixed|Closure $expected)

Asserts that the property does not match the expected value.

Parameters

string $key
mixed|Closure $expected

Return Value

Matching

in Matching at line 101
Matching whereAll(array $bindings)

Asserts that all properties match their expected values.

Parameters

array $bindings

Return Value

Matching

in Matching at line 117
Matching whereType(string $key, string|array $expected)

Asserts that the property is of the expected type.

Parameters

string $key
string|array $expected

Return Value

Matching

in Matching at line 142
Matching whereAllType(array $bindings)

Asserts that all properties are of their expected types.

Parameters

array $bindings

Return Value

Matching

in Matching at line 158
$this whereContains(string $key, mixed $expected)

Asserts that the property contains the expected values.

Parameters

string $key
mixed $expected

Return Value

$this

in Matching at line 202
protected void ensureSorted(mixed $value)

Ensures that all properties are sorted the same way, recursively.

Parameters

mixed $value

Return Value

void

in Dumpable at line 13
never dd(mixed ...$args)

Dump the given arguments and terminate execution.

Parameters

mixed ...$args

Return Value

never

in Dumpable at line 24
$this dump(mixed ...$args)

Dump the given arguments.

Parameters

mixed ...$args

Return Value

$this

in Interaction at line 37
void interacted()

Asserts that all properties have been interacted with.

Return Value

void

in Conditionable at line 21
$this|TWhenReturnType when($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) truthy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TWhenReturnType

in Conditionable at line 53
$this|TUnlessReturnType unless($value = null, callable|null $callback = null, callable|null $default = null)

Apply the callback if the given "value" is (or resolves to) falsy.

Parameters

$value
callable|null $callback
callable|null $default

Return Value

$this|TUnlessReturnType

in Macroable at line 29
static void macro(string $name, object|callable $macro)

Register a custom macro.

Parameters

string $name
object|callable $macro

Return Value

void

in Macroable at line 43
static void mixin(object $mixin, bool $replace = true)

Mix another object into the class.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

in Macroable at line 62
static bool hasMacro(string $name)

Checks if macro is registered.

Parameters

string $name

Return Value

bool

in Macroable at line 72
static void flushMacros()

Flush the existing macros.

Return Value

void

in Macroable at line 86
static mixed __callStatic(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Macroable at line 112
mixed __call(string $method, array $parameters)

Dynamically handle calls to the class.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

in Tappable at line 13
tap($callback = null)

Call the given Closure with this instance then return the instance.

Parameters

$callback

at line 44
protected __construct(array $props, string|null $path = null)

Create a new fluent, assertable JSON data instance.

Parameters

array $props
string|null $path

at line 127
AssertableJson each(Closure $callback)

Instantiate a new "scope" on each child element.

Parameters

Closure $callback

Return Value

AssertableJson

at line 153
static AssertableJson fromArray(array $data)

Create a new instance from an array.

Parameters

array $data

Return Value

AssertableJson

at line 164
static AssertableJson fromAssertableJsonString(AssertableJsonString $json)

Create a new instance from an AssertableJsonString.

Parameters

AssertableJsonString $json

Return Value

AssertableJson

at line 174
toArray()

Get the instance as an array.