Meta
in package
Search Metadata utilities
Table of Contents
Constants
- MAX_COLUMN_LENGTH = 58
- 64 characters is the max for some versions of SQL, minus the length of "index_" = 58.
Methods
- createSqlName() : array<string|int, mixed>
- Compute the SQL name of a column (for a "DB Entity").
- formatFieldSpec() : array<string|int, mixed>
- getCalcFields() : array<string|int, mixed>
- Get calculated fields used by a saved search
- getInputTypeFromDataType() : string|null
Constants
MAX_COLUMN_LENGTH
64 characters is the max for some versions of SQL, minus the length of "index_" = 58.
public
mixed
MAX_COLUMN_LENGTH
= 58
Methods
createSqlName()
Compute the SQL name of a column (for a "DB Entity").
public
static createSqlName(string $key[, string|null $sqlName = null ]) : array<string|int, mixed>
Parameters
- $key : string
-
Logical name of a field in a search-display. Identifies the ORIGIN of the data. Ex: 'email_primary.email'
- $sqlName : string|null = null
-
If available, the custom-name requested by the site-builder. Ex: 'the_preferred_email'
Tags
Return values
array<string|int, mixed> —Tuple: [0 => string $name, 1 => string $suffix]
formatFieldSpec()
public
static formatFieldSpec(array<string|int, mixed> $column, SqlExpression, dataType: string} $expr) : array<string|int, mixed>
Parameters
- $column : array<string|int, mixed>
- $expr : SqlExpression, dataType: string}
Return values
array<string|int, mixed>getCalcFields()
Get calculated fields used by a saved search
public
static getCalcFields(string $apiEntity, array<string|int, mixed> $apiParams) : array<string|int, mixed>
Parameters
- $apiEntity : string
- $apiParams : array<string|int, mixed>
Return values
array<string|int, mixed>getInputTypeFromDataType()
private
static getInputTypeFromDataType(string $dataType) : string|null
Parameters
- $dataType : string