Documentation

JsonPointer
in package

Tags
author

Joost Nijhuis jnijhuis81@gmail.com

Table of Contents

$filename  : string
$fromDefault  : bool
$propertyPaths  : array<string|int, string>
__construct()  : mixed
__toString()  : string
fromDefault()  : bool
Check whether the value at this path was set from a schema default
getFilename()  : string
getPropertyPathAsString()  : string
getPropertyPaths()  : array<string|int, string>
setFromDefault()  : mixed
Mark the value at this path as being set from a schema default
withPropertyPaths()  : JsonPointer
decodePath()  : string
decodePropertyPaths()  : array<string|int, string>
encodePath()  : string
encodePropertyPaths()  : array<string|int, mixed>

Properties

$fromDefault

private bool $fromDefault = false

Whether the value at this path was set from a schema default

$propertyPaths

private array<string|int, string> $propertyPaths = array()

Methods

__construct()

public __construct(string $value) : mixed
Parameters
$value : string
Tags
throws
InvalidArgumentException

when $value is not a string

Return values
mixed —

__toString()

public __toString() : string
Return values
string —

fromDefault()

Check whether the value at this path was set from a schema default

public fromDefault() : bool
Return values
bool —

getFilename()

public getFilename() : string
Return values
string —

getPropertyPathAsString()

public getPropertyPathAsString() : string
Return values
string —

getPropertyPaths()

public getPropertyPaths() : array<string|int, string>
Return values
array<string|int, string> —

setFromDefault()

Mark the value at this path as being set from a schema default

public setFromDefault() : mixed
Return values
mixed —

withPropertyPaths()

public withPropertyPaths(array<string|int, mixed> $propertyPaths) : JsonPointer
Parameters
$propertyPaths : array<string|int, mixed>
Return values
JsonPointer —

decodePath()

private decodePath(string $path) : string
Parameters
$path : string
Return values
string —

decodePropertyPaths()

private decodePropertyPaths(string $propertyPathString) : array<string|int, string>
Parameters
$propertyPathString : string
Return values
array<string|int, string> —

encodePath()

private encodePath(string $path) : string
Parameters
$path : string
Return values
string —

encodePropertyPaths()

private encodePropertyPaths() : array<string|int, mixed>
Return values
array<string|int, mixed> —

Search results