TYPO3  7.6
Public Member Functions | Protected Member Functions | List of all members
DefaultDataProvider Class Reference
Inheritance diagram for DefaultDataProvider:
DataProviderInterface

Public Member Functions

 addBackendLayouts (DataProviderContext $dataProviderContext, BackendLayoutCollection $backendLayoutCollection)
 
 getBackendLayout ($identifier, $pageId)
 

Protected Member Functions

 createDefaultBackendLayout ()
 
 createBackendLayout (array $data)
 
 getIconPath ($icon)
 
 getLayoutData ($fieldName, array $pageTsConfig, $pageUid)
 
 getStoragePid (array $pageTsConfig)
 
 getPageTSconfigIds (array $pageTsConfig)
 
 getDatabaseConnection ()
 

Detailed Description

Backend layout data provider class

Definition at line 22 of file DefaultDataProvider.php.

Member Function Documentation

addBackendLayouts ( DataProviderContext  $dataProviderContext,
BackendLayoutCollection  $backendLayoutCollection 
)

Adds backend layouts to the given backend layout collection. The default backend layout ('default_default') is not added since it's the default fallback if nothing is specified.

Parameters
DataProviderContext$dataProviderContext
BackendLayoutCollection$backendLayoutCollection
Returns
void

Implements DataProviderInterface.

Definition at line 33 of file DefaultDataProvider.php.

References BackendLayoutCollection\add(), DefaultDataProvider\createBackendLayout(), DataProviderContext\getFieldName(), DefaultDataProvider\getLayoutData(), DataProviderContext\getPageId(), and DataProviderContext\getPageTsConfig().

createBackendLayout ( array  $data)
protected

Creates a new backend layout using the given record data.

Parameters
array$data
Returns
BackendLayout

Definition at line 94 of file DefaultDataProvider.php.

References BackendLayout\create(), and DefaultDataProvider\getIconPath().

Referenced by DefaultDataProvider\addBackendLayouts(), and DefaultDataProvider\getBackendLayout().

createDefaultBackendLayout ( )
protected

Creates a backend layout with the default configuration.

Returns
BackendLayout

Definition at line 79 of file DefaultDataProvider.php.

References BackendLayout\create(), and BackendLayoutView\getDefaultColumnLayout().

Referenced by DefaultDataProvider\getBackendLayout().

getBackendLayout (   $identifier,
  $pageId 
)

Gets a backend layout by (regular) identifier.

Parameters
string$identifier
int$pageId
Returns
NULL|BackendLayout

Implements DataProviderInterface.

Definition at line 54 of file DefaultDataProvider.php.

References BackendUtility\BEenableFields(), DefaultDataProvider\createBackendLayout(), DefaultDataProvider\createDefaultBackendLayout(), BackendUtility\deleteClause(), and DefaultDataProvider\getDatabaseConnection().

getDatabaseConnection ( )
protected
Returns

Definition at line 197 of file DefaultDataProvider.php.

References $GLOBALS.

Referenced by DefaultDataProvider\getBackendLayout(), and DefaultDataProvider\getLayoutData().

getIconPath (   $icon)
protected

Gets and sanitizes the icon path.

Parameters
string$iconName of the icon file
Returns
string

Definition at line 108 of file DefaultDataProvider.php.

References $GLOBALS.

Referenced by DefaultDataProvider\createBackendLayout().

getLayoutData (   $fieldName,
array  $pageTsConfig,
  $pageUid 
)
protected

Get all layouts from the core's default data provider.

Parameters
string$fieldNamethe name of the field the layouts are provided for (either backend_layout or backend_layout_next_level)
array$pageTsConfigPageTSconfig of the given page
int$pageUidthe ID of the page wea re getting the layouts for
Returns
array $layouts A collection of layout data of the registered provider

Definition at line 128 of file DefaultDataProvider.php.

References BackendUtility\BEenableFields(), BackendUtility\deleteClause(), DefaultDataProvider\getDatabaseConnection(), DefaultDataProvider\getPageTSconfigIds(), and DefaultDataProvider\getStoragePid().

Referenced by DefaultDataProvider\addBackendLayouts().

getPageTSconfigIds ( array  $pageTsConfig)
protected

Returns the page TSconfig from TCEFORM.

Parameters
array$pageTsConfig
Returns
array

Definition at line 176 of file DefaultDataProvider.php.

Referenced by DefaultDataProvider\getLayoutData().

getStoragePid ( array  $pageTsConfig)
protected

Returns the storage PID from TCEFORM.

Parameters
array$pageTsConfig
Returns
int

Definition at line 159 of file DefaultDataProvider.php.

Referenced by DefaultDataProvider\getLayoutData().