RecordTrait
Record trait that implements common interface methods.
Tags
Table of Contents
- $labels : array<string|int, mixed>
- Labels for the record
- $searchBackendIdentifier : string
- Used for identifying the search backend used to find the record
- $sourceIdentifier : string
- Used for identifying record source backend
- addLabel() : void
- Add a label for the record
- getLabels() : array<string|int, mixed>
- Return all labels for the record
- getSearchBackendIdentifier() : string
- Return the search backend identifier used to find the record.
- getSourceIdentifier() : string
- Return the source backend identifier.
- setLabels() : void
- Set the labels for the record
- setSourceIdentifier() : void
- Set the record source backend identifier.
- setSourceIdentifiers() : void
- Set the source backend identifiers.
Properties
$labels
Labels for the record
protected
array<string|int, mixed>
$labels
= []
$searchBackendIdentifier
Used for identifying the search backend used to find the record
protected
string
$searchBackendIdentifier
= ''
$sourceIdentifier
Used for identifying record source backend
protected
string
$sourceIdentifier
= ''
Methods
addLabel()
Add a label for the record
public
addLabel(string $label, string $class) : void
Parameters
- $label : string
-
Label, may be a translation key
- $class : string
-
Label class
Return values
void —getLabels()
Return all labels for the record
public
getLabels() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array of associative arrays with keys 'label' and 'class'
getSearchBackendIdentifier()
Return the search backend identifier used to find the record.
public
getSearchBackendIdentifier() : string
Return values
string —getSourceIdentifier()
Return the source backend identifier.
public
getSourceIdentifier() : string
Return values
string —setLabels()
Set the labels for the record
public
setLabels(array<string|int, mixed> $labels) : void
Parameters
- $labels : array<string|int, mixed>
-
An array of associative arrays with keys 'label' and 'class'
Return values
void —setSourceIdentifier()
Set the record source backend identifier.
public
setSourceIdentifier(string $identifier) : void
Parameters
- $identifier : string
-
Record source identifier
Tags
Return values
void —setSourceIdentifiers()
Set the source backend identifiers.
public
setSourceIdentifiers(string $recordSourceId[, string $searchBackendId = '' ]) : void
Parameters
- $recordSourceId : string
-
Record source identifier
- $searchBackendId : string = ''
-
Search backend identifier (if different from $recordSourceId)