Copied!

Provider

Provider.php : 14
Interface

Constants

publicROOT_LOCATION_ID

Provider.php : 16 
public mixed ROOT_LOCATION_ID = 1

publicSORT_CLAUSE_CONTENT_NAME

Provider.php : 19 
public mixed SORT_CLAUSE_CONTENT_NAME = 'ContentName'

publicSORT_CLAUSE_DATE_PUBLISHED

Provider.php : 18 
public mixed SORT_CLAUSE_DATE_PUBLISHED = 'DatePublished'

Methods

publicgetBreadcrumbLocations()

Provider.php : 29 
public getBreadcrumbLocations(int $locationId[, int $rootLocationId = self::ROOT_LOCATION_ID ]) : array<string|int, mixed>

Parameters

Name Type Default value Description
$locationId int - -
$rootLocationId int Provider::ROOT_LOCATION_ID -

Return values

array<string|int, mixed>

publicgetColumns()

Provider.php : 21 
public getColumns(int $locationId, int $limit, SortClause $sortClause[, bool $gridView = false ][, int $rootLocationId = self::ROOT_LOCATION_ID ]) : array<string|int, mixed>

Parameters

Name Type Default value Description
$locationId int - -
$limit int - -
$sortClause SortClause - -
$gridView bool false -
$rootLocationId int Provider::ROOT_LOCATION_ID -

Return values

array<string|int, mixed>

publicgetLocationData()

Provider.php : 50 
public getLocationData(int $locationId, int $offset, int $limit, SortClause $sortClause) : array<string|int, mixed>

Parameters

Name Type Default value Description
$locationId int - -
$offset int - -
$limit int - -
$sortClause SortClause - -

Return values

array<string|int, mixed>

publicgetLocationGridViewData()

Provider.php : 57 
public getLocationGridViewData(int $locationId, int $offset, int $limit, SortClause $sortClause) : array<string|int, mixed>

Parameters

Name Type Default value Description
$locationId int - -
$offset int - -
$limit int - -
$sortClause SortClause - -

Return values

array<string|int, mixed>

publicgetLocationPermissionRestrictions()

Provider.php : 34 
public getLocationPermissionRestrictions(Location $location) : array<string|int, mixed>

Parameters

Name Type Default value Description
$location Location - -

Return values

array<string|int, mixed>

publicgetLocations()

Provider.php : 64 
public getLocations(array<string|int, mixed> $locationIds) : array<string|int, mixed>

Parameters

Name Type Default value Description
$locationIds array<string|int, mixed> - -

Return values

array<string|int, mixed>

publicgetRestFormat()

Provider.php : 69 
public getRestFormat(mixed $valueObject) : array<string|int, mixed>

Parameters

Name Type Default value Description
$valueObject mixed - -

Return values

array<string|int, mixed>

Tags
Deprecated
4.6.0

Will be removed in 5.0.

publicgetSortClause()

Provider.php : 71 
public getSortClause(string $sortClauseName, string $sortOrder) : SortClause

Parameters

Name Type Default value Description
$sortClauseName string - -
$sortOrder string - -

Return values

SortClause

publicgetSubitemContents()

Provider.php : 36 
public getSubitemContents(int $locationId, int $offset, int $limit, SortClause $sortClause) : array<string|int, mixed>

Parameters

Name Type Default value Description
$locationId int - -
$offset int - -
$limit int - -
$sortClause SortClause - -

Return values

array<string|int, mixed>

publicgetSubitemLocations()

Provider.php : 43 
public getSubitemLocations(int $locationId, int $offset, int $limit, SortClause $sortClause) : array<string|int, mixed>

Parameters

Name Type Default value Description
$locationId int - -
$offset int - -
$limit int - -
$sortClause SortClause - -

Return values

array<string|int, mixed>