MatchParamTrait
Table of Contents
Properties
- $match : array<string|int, mixed>
- Specify fields to match for update.
Methods
- getMatch() : bool
- setMatch() : $this
- getMatchFields() : array<string|int, mixed>
- Options callback for $this->match
- matchExisting() : int
- Find existing record based on $this->match param
Properties
$match
Specify fields to match for update.
protected
array<string|int, mixed>
$match
= []
The API will perform an update if an existing $ENTITY matches all specified fields.
Note: the fields named in this param should be without any options suffix (e.g. my_field not my_field:name).
Any options suffixes in the $records will be resolved by the api prior to matching.
Tags
Methods
getMatch()
public
getMatch() : bool
Return values
boolsetMatch()
public
setMatch(array<string|int, mixed> $match) : $this
Specify fields to match for update.
Parameters
- $match : array<string|int, mixed>
Return values
$thisgetMatchFields()
Options callback for $this->match
protected
getMatchFields() : array<string|int, mixed>
Return values
array<string|int, mixed>matchExisting()
Find existing record based on $this->match param
protected
matchExisting(mixed &$record) : int
Parameters
- $record : mixed
Return values
int —Returns number of existing records (1 or 0)