MutateArrayAppendSpec
in package
implements
MutateInSpec
Indicates to append a value to an array at a path in a document.
Interfaces, Classes, Traits and Enums
- MutateInSpec
- MutateInSpec is an interface for providing subdocument mutation operations.
Table of Contents
- $createPath : bool
- $expandMacros : bool
- $isXattr : bool
- $path : string
- $values : array<string|int, mixed>
- __construct() : mixed
- build() : MutateArrayAppendSpec
- createPath() : MutateArrayAppendSpec
- expandMacros() : MutateArrayAppendSpec
- xattr() : MutateArrayAppendSpec
Properties
$createPath
private
bool
$createPath
$expandMacros
private
bool
$expandMacros
$isXattr
private
bool
$isXattr
$path
private
string
$path
$values
private
array<string|int, mixed>
$values
Methods
__construct()
public
__construct(string $path, array<string|int, mixed> $values[, bool $isXattr = false ][, bool $createPath = false ][, bool $expandMacros = false ]) : mixed
Parameters
- $path : string
- $values : array<string|int, mixed>
- $isXattr : bool = false
- $createPath : bool = false
- $expandMacros : bool = false
Tags
Return values
mixed —build()
public
static build(string $path, array<string|int, mixed> $values[, bool $isXattr = false ][, bool $createPath = false ][, bool $expandMacros = false ]) : MutateArrayAppendSpec
Parameters
- $path : string
- $values : array<string|int, mixed>
- $isXattr : bool = false
- $createPath : bool = false
- $expandMacros : bool = false
Tags
Return values
MutateArrayAppendSpec —createPath()
public
createPath(bool $createPath) : MutateArrayAppendSpec
Parameters
- $createPath : bool
Tags
Return values
MutateArrayAppendSpec —expandMacros()
public
expandMacros(bool $expandMacros) : MutateArrayAppendSpec
Parameters
- $expandMacros : bool
Tags
Return values
MutateArrayAppendSpec —xattr()
public
xattr(bool $isXattr) : MutateArrayAppendSpec
Parameters
- $isXattr : bool