TYPO3\CMS\Backend\Template\Components\DocHeaderComponent Class Reference

Public Member Functions
	__construct ()
	setMetaInformation (array $metaInformation)
MenuRegistry	getMenuRegistry ()
ButtonBar	getButtonBar ()
bool	isEnabled ()
	enable ()
	disable ()
array	docHeaderContent ()

Protected Attributes
MenuRegistry	$menuRegistry
MetaInformation	$metaInformation
ButtonBar	$buttonBar
bool	$enabled = true

Detailed Description

DocHeader component class

Definition at line 23 of file DocHeaderComponent.php.

Constructor & Destructor Documentation

__construct()

TYPO3\CMS\Backend\Template\Components\DocHeaderComponent::__construct

(

)

Sets up buttonBar and MenuRegistry

Definition at line 50 of file DocHeaderComponent.php.

Member Function Documentation

disable()

TYPO3\CMS\Backend\Template\Components\DocHeaderComponent::disable

(

)

Sets the enabled property to FALSE (disabled).

Definition at line 108 of file DocHeaderComponent.php.

docHeaderContent()

array TYPO3\CMS\Backend\Template\Components\DocHeaderComponent::docHeaderContent

(

)

Returns the abstract content of the docHeader as an array

Returns

‪array

Definition at line 118 of file DocHeaderComponent.php.

References TYPO3\CMS\Backend\Template\Components\DocHeaderComponent\$metaInformation, and TYPO3\CMS\Backend\Template\Components\DocHeaderComponent\isEnabled().

enable()

TYPO3\CMS\Backend\Template\Components\DocHeaderComponent::enable

(

)

Sets the enabled property to TRUE.

Definition at line 100 of file DocHeaderComponent.php.

getButtonBar()

ButtonBar TYPO3\CMS\Backend\Template\Components\DocHeaderComponent::getButtonBar

(

)

Get ButtonBar

Returns

‪ButtonBar

Definition at line 82 of file DocHeaderComponent.php.

References TYPO3\CMS\Backend\Template\Components\DocHeaderComponent\$buttonBar.

Referenced by TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList\getDocHeaderButtons().

getMenuRegistry()

MenuRegistry TYPO3\CMS\Backend\Template\Components\DocHeaderComponent::getMenuRegistry

(

)

Get moduleMenuRegistry

Returns

‪MenuRegistry

Definition at line 72 of file DocHeaderComponent.php.

References TYPO3\CMS\Backend\Template\Components\DocHeaderComponent\$menuRegistry.

Referenced by TYPO3\CMS\Backend\Template\ModuleTemplate\registerModuleMenu().

isEnabled()

bool TYPO3\CMS\Backend\Template\Components\DocHeaderComponent::isEnabled

(

)

Determines whether this components is enabled.

Returns

‪bool

Definition at line 92 of file DocHeaderComponent.php.

References TYPO3\CMS\Backend\Template\Components\DocHeaderComponent\$enabled.

Referenced by TYPO3\CMS\Backend\Template\Components\DocHeaderComponent\docHeaderContent().

setMetaInformation()

TYPO3\CMS\Backend\Template\Components\DocHeaderComponent::setMetaInformation

(

array

$metaInformation

)

Set page information

Parameters

array

$metaInformation

‪Record array

Definition at line 62 of file DocHeaderComponent.php.

References TYPO3\CMS\Backend\Template\Components\DocHeaderComponent\$metaInformation.

Referenced by TYPO3\CMS\IndexedSearch\Controller\AdministrationController\initializeView().

Member Data Documentation

$buttonBar

ButtonBar TYPO3\CMS\Backend\Template\Components\DocHeaderComponent::$buttonBar

protected

Registry Container for Buttons

Definition at line 41 of file DocHeaderComponent.php.

Referenced by TYPO3\CMS\Backend\Template\Components\DocHeaderComponent\getButtonBar().

$enabled

bool TYPO3\CMS\Backend\Template\Components\DocHeaderComponent::$enabled = true

protected

Definition at line 45 of file DocHeaderComponent.php.

Referenced by TYPO3\CMS\Backend\Template\Components\DocHeaderComponent\isEnabled().

$menuRegistry

MenuRegistry TYPO3\CMS\Backend\Template\Components\DocHeaderComponent::$menuRegistry

protected

MenuRegistry Object

Definition at line 29 of file DocHeaderComponent.php.

Referenced by TYPO3\CMS\Backend\Template\Components\DocHeaderComponent\getMenuRegistry().

$metaInformation

MetaInformation TYPO3\CMS\Backend\Template\Components\DocHeaderComponent::$metaInformation

protected

Meta information

Definition at line 35 of file DocHeaderComponent.php.

Referenced by TYPO3\CMS\Backend\Template\Components\DocHeaderComponent\docHeaderContent(), and TYPO3\CMS\Backend\Template\Components\DocHeaderComponent\setMetaInformation().