LabelCapability
final readonly class \
- Implements
- SchemaCapabilityInterface
Contains all information of compiling the label information of a schema.
Table of Contents
Interfaces
- SchemaCapabilityInterface
- A semantic interface for any kind of capability.
Methods
- __construct() : mixed
- alwaysRenderAdditionalFields() : bool
- getAdditionalFieldNames() : string[]
- getAllLabelFieldNames() : array
- getConfiguration() : array
- getLabelFieldNamesOfAllRecordTypes() : string[]
- Returns the label fields of this schema, together with the label fields defined by any of its record types. Use this to determine the fields to select for record title rendering, when the record type is not known yet.
- getPrimaryFieldName() : string|null
- hasPrimaryField() : bool
Methods
__construct()
public
__construct(string|null $primaryFieldName, array $additionalFieldNames, bool $alwaysRenderAdditionalFields, array $configuration[, array $labelFieldNamesOfAllRecordTypes = [] ]) : mixed
Parameters
- $primaryFieldName : string|null
- $additionalFieldNames : array
- $alwaysRenderAdditionalFields : bool
- $configuration : array
- $labelFieldNamesOfAllRecordTypes : array = []
alwaysRenderAdditionalFields()
public
alwaysRenderAdditionalFields() : bool
Return values
boolgetAdditionalFieldNames()
public
getAdditionalFieldNames() : string[]
Return values
string[]getAllLabelFieldNames()
public
getAllLabelFieldNames() : array
Return values
arraygetConfiguration()
public
getConfiguration() : array
Return values
arraygetLabelFieldNamesOfAllRecordTypes()
Returns the label fields of this schema, together with the label fields defined by any of its record types. Use this to determine the fields to select for record title rendering, when the record type is not known yet.
public
getLabelFieldNamesOfAllRecordTypes() : string[]
Return values
string[]getPrimaryFieldName()
public
getPrimaryFieldName() : string|null
Return values
string|nullhasPrimaryField()
public
hasPrimaryField() : bool