RecordSimilarityParameters
extends RosetteParamsSetBase
in package
Class RecordSimilarityParameters.
Table of Contents
Properties
- $comparisonMethod : RecordSimilarityComparisonMethod
- $fields : array<string|int, mixed>
- $properties : array<string|int, mixed>
- $records : array<string|int, mixed>
Methods
- __construct() : mixed
- constructor
- get() : mixed
- Gets a property value based on the property name.
- getMultiPartContent() : string
- Provides default multiPart call for child classes that don't implement it
- serialize() : string
- Serialize into a json string.
- set() : mixed
- Sets a property based on the name.
- validate() : mixed
- Validates parameters.
Properties
$comparisonMethod
public
RecordSimilarityComparisonMethod
$comparisonMethod
$fields
public
array<string|int, mixed>
$fields
$properties
public
array<string|int, mixed>
$properties
$records
public
array<string|int, mixed>
$records
Methods
__construct()
constructor
public
__construct(array<string|int, mixed> $fields, array<string|int, mixed> $properties, array<string|int, mixed> $records[, RecordSimilarityComparisonMethod $comparisonMethod = RecordSimilarityComparisonMethod::ONE_TO_ONE ]) : mixed
Parameters
- $fields : array<string|int, mixed>
-
- the fields of the records to compare
- $properties : array<string|int, mixed>
-
- the properties of the comparison
- $records : array<string|int, mixed>
-
- the records to compare
- $comparisonMethod : RecordSimilarityComparisonMethod = RecordSimilarityComparisonMethod::ONE_TO_ONE
-
- the comparison method to use
get()
Gets a property value based on the property name.
public
get(string $propertyName) : mixed
Parameters
- $propertyName : string
-
the name of the property
Tags
Return values
mixed —property value
getMultiPartContent()
Provides default multiPart call for child classes that don't implement it
public
getMultiPartContent() : string
Return values
stringserialize()
Serialize into a json string.
public
serialize(mixed $options) : string
Parameters
- $options : mixed
-
associative array of options
Return values
stringset()
Sets a property based on the name.
public
set(string $propertyName, mixed $value) : mixed
Parameters
- $propertyName : string
-
the name of the property
- $value : mixed
-
the value to set
validate()
Validates parameters.
public
validate() : mixed