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

Public Member Functions
	__construct ($identifier)
string	getIdentifier ()
	setIdentifier ($identifier)
	add (BackendLayout $backendLayout)
BackendLayout null	get ($identifier)
array BackendLayout[]	getAll ()

Protected Attributes
string	$identifier
array BackendLayout[]	$backendLayouts = array( )

Detailed Description

Collection of backend layouts.

Definition at line 21 of file BackendLayoutCollection.php.

Constructor & Destructor Documentation

__construct()

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

(

$identifier

)

Parameters

string

$identifier

Definition at line 34 of file BackendLayoutCollection.php.

References 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.

Exceptions

Definition at line 68 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\View\BackendLayout\PageTsBackendLayoutDataProvider\addBackendLayouts().

get()

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

(

$identifier

)

Gets a backend layout by (regular) identifier.

Parameters

string

$identifier

Returns

‪BackendLayout|null

Definition at line 95 of file BackendLayoutCollection.php.

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

getAll()

array BackendLayout [] TYPO3\CMS\Backend\View\BackendLayout\BackendLayoutCollection::getAll

(

)

Gets all backend layouts in this collection.

Returns

‪array|BackendLayout[]

Definition at line 111 of file BackendLayoutCollection.php.

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

getIdentifier()

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

(

)

Returns

‪string

Definition at line 42 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 51 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

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

protected

Definition at line 29 of file BackendLayoutCollection.php.

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

$identifier

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

protected

Definition at line 25 of file BackendLayoutCollection.php.

Referenced by 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().