TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection Class Reference

Public Member Functions
	__construct ($identifier)
	getIdentifier ()
	setIdentifier ($identifier)
	add (BackendLayout $backendLayout)
	get ($identifier)
	getAll ()

Protected Attributes
	$identifier
	$backendLayouts = []

Detailed Description

Collection of backend layouts.

Definition at line 20 of file BackendLayoutCollection.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection::__construct

(

$identifier

)

Parameters

string

$identifier

Definition at line 35 of file BackendLayoutCollection.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection\$identifier, and TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection\setIdentifier().

Member Function Documentation

add()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection::add

(

BackendLayout

$backendLayout

)

Adds a backend layout to this collection.

Parameters

BackendLayout

$backendLayout

Exceptions

Definition at line 70 of file BackendLayoutCollection.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection\$identifier, and TYPO3\CMS\Backend\View\BackendLayout\BackendLayout\getIdentifier().

Referenced by TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider\addBackendLayouts(), and TYPO3\CMS\Backend\Provider\PageTsBackendLayoutDataProvider\addBackendLayouts().

get()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection::get

(

$identifier

)

Gets a backend layout by (regular) identifier.

Parameters

string

$identifier

Returns

NULL|BackendLayout

Definition at line 97 of file BackendLayoutCollection.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection\$identifier.

getAll()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection::getAll

(

)

Gets all backend layouts in this collection.

Returns

array|BackendLayout[]

Definition at line 113 of file BackendLayoutCollection.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection\$backendLayouts.

getIdentifier()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection::getIdentifier

(

)

Returns

string

Definition at line 43 of file BackendLayoutCollection.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection\$identifier.

setIdentifier()

TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection::setIdentifier

(

$identifier

)

Parameters

string

$identifier

Exceptions

Definition at line 52 of file BackendLayoutCollection.php.

References TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection\$identifier.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection\__construct().

Member Data Documentation

$backendLayouts

TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection::$backendLayouts = []

protected

Definition at line 30 of file BackendLayoutCollection.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection\getAll().

$identifier

TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection::$identifier

protected

Definition at line 25 of file BackendLayoutCollection.php.

Referenced by TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection\__construct(), TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection\add(), TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection\get(), TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection\getIdentifier(), and TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection\setIdentifier().