Documentation

SqlEntityMetadata extends EntityMetadataBase
in package

Table of Contents

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()`
getField()  : array<string|int, mixed>|null
getFields()  : array<string|int, mixed>
getOptions()  : array<string|int, mixed>|null
getProperty()  : mixed
getEntity()  : array{name: string, table: string, class: string, module: string, getInfo: callable, getPaths: callable, getIndices: callable, getFields: callable, metaProvider: callable, storageProvider: callable}
formatOptionValues()  : array<string|int, mixed>
getConditionFromProvider()  : mixed
getOptionGroupParams()  : mixed
getSqlOptions()  : array<string|int, mixed>

Properties

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.

getField()

public getField(string $fieldName) : array<string|int, mixed>|null
Parameters
$fieldName : string
Return values
array<string|int, mixed>|null

getFields()

public getFields() : array<string|int, mixed>
Return values
array<string|int, mixed>

getOptions()

public getOptions(string $fieldName[, array<string|int, mixed> $values = [] ][, bool $includeDisabled = FALSE ][, bool $checkPermissions = FALSE ][, int|null $userId = NULL ]) : array<string|int, mixed>|null
Parameters
$fieldName : string
$values : array<string|int, mixed> = []
$includeDisabled : bool = FALSE
$checkPermissions : bool = FALSE
$userId : int|null = NULL
Return values
array<string|int, mixed>|null

getProperty()

public getProperty(string $propertyName) : mixed
Parameters
$propertyName : string

getEntity()

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}

formatOptionValues()

private formatOptionValues(array<string|int, mixed> $optionValues) : array<string|int, mixed>
Parameters
$optionValues : array<string|int, mixed>
Return values
array<string|int, mixed>

getConditionFromProvider()

private getConditionFromProvider(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>

getOptionGroupParams()

private getOptionGroupParams(array<string|int, mixed> &$field) : mixed
Parameters
$field : 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
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results