Documentation

MutateUpsertSpec
in package
implements MutateInSpec

Indicates to replace a value at a path if it doesn't exist, otherwise create the 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
$value  : mixed
__construct()  : mixed
build()  : MutateUpsertSpec
createPath()  : MutateUpsertSpec
expandMacros()  : MutateUpsertSpec
xattr()  : MutateUpsertSpec

Properties

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
since
4.0.0
Return values
mixed

build()

public static build(string $path, mixed $value[, bool $isXattr = false ][, bool $createPath = false ][, bool $expandMacros = false ]) : MutateUpsertSpec
Parameters
$path : string
$value : mixed
$isXattr : bool = false
$createPath : bool = false
$expandMacros : bool = false
Tags
since
4.0.0
Return values
MutateUpsertSpec

        

Search results