MutateReplaceSpec
in package
implements
MutateInSpec
Indicates to replace a value at a path if it doesn't exist 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
- $value : mixed
- __construct() : mixed
- build() : MutateReplaceSpec
- createPath() : MutateReplaceSpec
- expandMacros() : MutateReplaceSpec
- xattr() : MutateReplaceSpec
Properties
$createPath
private
bool
$createPath
$expandMacros
private
bool
$expandMacros
$isXattr
private
bool
$isXattr
$path
private
string
$path
$value
private
mixed
$value
Methods
__construct()
public
__construct(string $path, mixed $value[, bool $isXattr = false ][, bool $createPath = false ][, bool $expandMacros = false ]) : mixed
Parameters
- $path : string
- $value : mixed
- $isXattr : bool = false
- $createPath : bool = false
- $expandMacros : bool = false
Tags
Return values
mixed —build()
public
static build(string $path, mixed $value[, bool $isXattr = false ][, bool $createPath = false ][, bool $expandMacros = false ]) : MutateReplaceSpec
Parameters
- $path : string
- $value : mixed
- $isXattr : bool = false
- $createPath : bool = false
- $expandMacros : bool = false
Tags
Return values
MutateReplaceSpec —createPath()
public
createPath(bool $createPath) : MutateReplaceSpec
Parameters
- $createPath : bool
Tags
Return values
MutateReplaceSpec —expandMacros()
public
expandMacros(bool $expandMacros) : MutateReplaceSpec
Parameters
- $expandMacros : bool
Tags
Return values
MutateReplaceSpec —xattr()
public
xattr(bool $isXattr) : MutateReplaceSpec
Parameters
- $isXattr : bool