AdditionalFieldsRepository
in
Interface AdditionalFieldsRepository
Table of Contents
- createAdditionalField() : FieldIds
- Creates and stores a new additional field.
- deleteAdditionalFields() : void
- Deletes one or more existing additional fields.
- getAdditionalFieldById() : AdditionalField
- Returns a specific additional field based on the given ID.
- getAllAdditionalFields() : AdditionalFields
- Returns a collection of all additional fields.
- storeAdditionalFields() : void
- Stores one or more existing additional fields.
Methods
createAdditionalField()
Creates and stores a new additional field.
public
createAdditionalField(array<string|int, mixed> $names) : FieldIds
Parameters
- $names : array<string|int, mixed>
Tags
Return values
FieldIds —deleteAdditionalFields()
Deletes one or more existing additional fields.
public
deleteAdditionalFields(FieldIds $additionalFieldIds) : void
Parameters
- $additionalFieldIds : FieldIds
Tags
Return values
void —getAdditionalFieldById()
Returns a specific additional field based on the given ID.
public
getAdditionalFieldById(FieldId $fieldId) : AdditionalField
Parameters
- $fieldId : FieldId
Tags
Return values
AdditionalField —getAllAdditionalFields()
Returns a collection of all additional fields.
public
getAllAdditionalFields([int|null $page = null ][, int|null $perPage = null ][, string|null $searchTerm = null ][, string|null $sortBy = null ]) : AdditionalFields
Parameters
- $page : int|null = null
- $perPage : int|null = null
- $searchTerm : string|null = null
- $sortBy : string|null = null
Return values
AdditionalFields —storeAdditionalFields()
Stores one or more existing additional fields.
public
storeAdditionalFields(AdditionalField ...$fields) : void
Parameters
- $fields : AdditionalField