EntityMetadataBase
in package
implements
EntityMetadataInterface
AbstractYes
Table of Contents
Interfaces
Properties
- $entityName : string
Methods
- __construct() : mixed
- getCustomFields() : array<string|int, array<string|int, mixed>>
- Retrieves the custom fields associated with the entity, in the same format as returned by `getFields()`
- getOptions() : array<string|int, mixed>|null
- getEntity() : array{name: string, table: string, class: string, module: string, getInfo: callable, getPaths: callable, getIndices: callable, getFields: callable, metaProvider: callable, storageProvider: callable}
- addOptionConditionsFromACL() : void
- addOptionConditionsFromProvider() : mixed
- addOptionGroupParams() : mixed
- formatOptionValues() : array<string|int, mixed>
- getSqlOptions() : array<string|int, mixed>
Properties
$entityName
protected
string
$entityName
Methods
__construct()
public
__construct(string $entityName) : mixed
Parameters
- $entityName : string
getCustomFields()
Retrieves the custom fields associated with the entity, in the same format as returned by `getFields()`
public
getCustomFields([array<string|int, mixed> $customGroupFilters = [] ]) : array<string|int, array<string|int, mixed>>
Parameters
- $customGroupFilters : array<string|int, mixed> = []
-
Optional. Additional filters to apply when retrieving custom groups. Defaults to an empty array.
Return values
array<string|int, array<string|int, mixed>> —The array keys are formatted as "customGroup.fieldName", and the array values are associative arrays containing the field details.
getOptions()
public
getOptions(string $fieldName[, array<string|int, mixed> $values = [] ][, bool $includeDisabled = false ][, bool $checkPermissions = false ][, int|null $userId = null ][, bool $isView = false ]) : array<string|int, mixed>|null
Parameters
- $fieldName : string
- $values : array<string|int, mixed> = []
- $includeDisabled : bool = false
- $checkPermissions : bool = false
- $userId : int|null = null
- $isView : bool = false
Return values
array<string|int, mixed>|nullgetEntity()
protected
getEntity() : array{name: string, table: string, class: string, module: string, getInfo: callable, getPaths: callable, getIndices: callable, getFields: callable, metaProvider: callable, storageProvider: callable}
Return values
array{name: string, table: string, class: string, module: string, getInfo: callable, getPaths: callable, getIndices: callable, getFields: callable, metaProvider: callable, storageProvider: callable}addOptionConditionsFromACL()
private
addOptionConditionsFromACL(array<string|int, mixed> &$field, int|null $userId) : void
Parameters
- $field : array<string|int, mixed>
- $userId : int|null
addOptionConditionsFromProvider()
private
addOptionConditionsFromProvider(string $fieldName, array<string|int, mixed> &$field, array<string|int, mixed> $hookParams) : mixed
Parameters
- $fieldName : string
- $field : array<string|int, mixed>
- $hookParams : array<string|int, mixed>
addOptionGroupParams()
private
addOptionGroupParams(array<string|int, mixed> &$field) : mixed
Parameters
- $field : array<string|int, mixed>
formatOptionValues()
private
formatOptionValues(array<string|int, mixed> $optionValues) : array<string|int, mixed>
Parameters
- $optionValues : array<string|int, mixed>
Return values
array<string|int, mixed>getSqlOptions()
private
getSqlOptions(array<string|int, mixed> $field[, bool $includeDisabled = false ]) : array<string|int, mixed>
Parameters
- $field : array<string|int, mixed>
- $includeDisabled : bool = false