1. class
  2. XELOS
  3. \
  4. Modules
  5. \
  6. Pages
  7. \
  8. Hook
  9. \
  10. Base
  11. \
  12. CollectionOptionHelper

CollectionOptionHelper

class CollectionOptionHelper

Generic Collection Options in pages when working with Collections

Constants

private TOKEN_DOMAIN

private SORT_BY_POPULARITY

Methods

static array
addCollectionOptionsFDL(Collection $collection, OptionList|null $customOrderOptionList = null, bool $includeGeoData = false)

Generate FDL for collection

static void
applyCollectionOptions(Collection $collection, array $portletConfig)

Apply scopes / options previously set. Function is NOT doing permission checks/scopes

static array|null
getCollectionOrderByFDL(Collection $collection, OptionList|null $customOrderOptionList = null)

Ordering Option Field

static string
getPrefixedConfigName(Collection $collection, string|null $configName = null)

Get internal config name used by CollectioOptionHelper

Details

at line 36
static array addCollectionOptionsFDL(Collection $collection, OptionList|null $customOrderOptionList = null, bool $includeGeoData = false)

Generate FDL for collection

Parameters

Collection $collection
OptionList|null $customOrderOptionList
bool $includeGeoData

Return Value

array

Exceptions

ModuleException

at line 161
static void applyCollectionOptions(Collection $collection, array $portletConfig)

Apply scopes / options previously set. Function is NOT doing permission checks/scopes

Parameters

Collection $collection
array $portletConfig

Return Value

void

at line 235
static array|null getCollectionOrderByFDL(Collection $collection, OptionList|null $customOrderOptionList = null)

Ordering Option Field

Parameters

Collection $collection
OptionList|null $customOrderOptionList

Return Value

array|null

at line 320
static string getPrefixedConfigName(Collection $collection, string|null $configName = null)

Get internal config name used by CollectioOptionHelper

Parameters

Collection $collection
string|null $configName

Return Value

string