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 : 35
public getBreadcrumbLocations(int $locationId[, int $rootLocationId = self::ROOT_LOCATION_ID ]) : array<string|int, Location>

Parameters

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

Return values

array<string|int, Location>

publicgetColumns()

Provider.php : 24
public getColumns(int $locationId, int $limit, SortClause $sortClause[, bool $gridView = false ][, int $rootLocationId = self::ROOT_LOCATION_ID ]) : array<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<int, mixed>

publicgetLocationData()

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

Parameters

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

Return values

array<string, mixed>

publicgetLocationGridViewData()

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

Parameters

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

Return values

array<string, mixed>

publicgetLocationPermissionRestrictions()

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

Parameters

Name Type Default value Description
$location Location - -

Return values

array<string, mixed>

publicgetLocations()

Provider.php : 104
public getLocations(array<int, string> $locationIds) : array<string|int, Location, permissions: array{create: array{hasAccess: bool, restrictedContentTypeIds: int[], restrictedLanguageCodes: string[]}, edit: array{hasAccess: bool, restrictedContentTypeIds: int[], restrictedLanguageCodes: string[]}}}>

Parameters

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

Return values

array<string|int, Location, permissions: array{create: array{hasAccess: bool, restrictedContentTypeIds: int[], restrictedLanguageCodes: string[]}, edit: array{hasAccess: bool, restrictedContentTypeIds: int[], restrictedLanguageCodes: string[]}}}>

publicgetSortClause()

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

Parameters

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

Return values

SortClause

publicgetSubitemContents()

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

Parameters

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

Return values

array<string|int, Content>

publicgetSubitemLocations()

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

Parameters

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

Return values

array<string|int, Location>