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

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

Protected Attributes
	$menuRegistry
	$metaInformation
	$buttonBar
	$enabled = true

Detailed Description

DocHeader component class

Definition at line 22 of file DocHeaderComponent.php.

Constructor & Destructor Documentation

__construct()

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

(

)

Sets up buttonBar and MenuRegistry

Definition at line 53 of file DocHeaderComponent.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

Member Function Documentation

disable()

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

(

)

Sets the enabled property to FALSE (disabled).

Definition at line 113 of file DocHeaderComponent.php.

docHeaderContent()

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

(

)

Returns the abstract content of the docHeader as an array

Returns

array

Definition at line 123 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 105 of file DocHeaderComponent.php.

getButtonBar()

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

(

)

Get ButtonBar

Returns

ButtonBar

Definition at line 87 of file DocHeaderComponent.php.

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

getMenuRegistry()

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

(

)

Get moduleMenuRegistry

Returns

MenuRegistry

Definition at line 77 of file DocHeaderComponent.php.

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

isEnabled()

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

(

)

Determines whether this components is enabled.

Returns

bool

Definition at line 97 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

Returns

void

Definition at line 67 of file DocHeaderComponent.php.

Member Data Documentation

$buttonBar

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

protected

Definition at line 43 of file DocHeaderComponent.php.

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

$enabled

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

protected

Definition at line 48 of file DocHeaderComponent.php.

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

$menuRegistry

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

protected

Definition at line 29 of file DocHeaderComponent.php.

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

$metaInformation

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

protected

Definition at line 36 of file DocHeaderComponent.php.

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