TYPO3CMS  8
 All Classes Namespaces Files Functions Variables Pages
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 ( )

Sets up buttonBar and MenuRegistry

Definition at line 53 of file DocHeaderComponent.php.

References GeneralUtility\makeInstance().

Member Function Documentation

disable ( )

Sets the enabled property to FALSE (disabled).

Definition at line 113 of file DocHeaderComponent.php.

docHeaderContent ( )

Returns the abstract content of the docHeader as an array

Returns
array

Definition at line 123 of file DocHeaderComponent.php.

References DocHeaderComponent\$metaInformation, and DocHeaderComponent\isEnabled().

enable ( )

Sets the enabled property to TRUE.

Definition at line 105 of file DocHeaderComponent.php.

getButtonBar ( )

Get ButtonBar

Returns
ButtonBar

Definition at line 87 of file DocHeaderComponent.php.

References DocHeaderComponent\$buttonBar.

getMenuRegistry ( )

Get moduleMenuRegistry

Returns
MenuRegistry

Definition at line 77 of file DocHeaderComponent.php.

References DocHeaderComponent\$menuRegistry.

isEnabled ( )

Determines whether this components is enabled.

Returns
bool

Definition at line 97 of file DocHeaderComponent.php.

References DocHeaderComponent\$enabled.

Referenced by DocHeaderComponent\docHeaderContent().

setMetaInformation ( array  $metaInformation)

Set page information

Parameters
array$metaInformationRecord array
Returns
void

Definition at line 67 of file DocHeaderComponent.php.

Member Data Documentation

$buttonBar
protected

Definition at line 43 of file DocHeaderComponent.php.

Referenced by DocHeaderComponent\getButtonBar().

$enabled = true
protected

Definition at line 48 of file DocHeaderComponent.php.

Referenced by DocHeaderComponent\isEnabled().

$menuRegistry
protected

Definition at line 29 of file DocHeaderComponent.php.

Referenced by DocHeaderComponent\getMenuRegistry().

$metaInformation
protected

Definition at line 36 of file DocHeaderComponent.php.

Referenced by DocHeaderComponent\docHeaderContent().