DocHeaderComponent
DocHeader component class
Table of Contents
Properties
- $buttonBar : ButtonBar
- Registry Container for Buttons
- $enabled : bool
- $menuRegistry : MenuRegistry
- MenuRegistry Object
- $metaInformation : MetaInformation
- Meta information
Methods
- __construct() : mixed
- Sets up buttonBar and MenuRegistry
- disable() : mixed
- Sets the enabled property to FALSE (disabled).
- docHeaderContent() : array<string|int, mixed>
- Returns the abstract content of the docHeader as an array
- enable() : mixed
- Sets the enabled property to TRUE.
- getButtonBar() : ButtonBar
- Get ButtonBar
- getMenuRegistry() : MenuRegistry
- Get moduleMenuRegistry
- isEnabled() : bool
- Determines whether this components is enabled.
- setMetaInformation() : mixed
- Set page information
- setMetaInformationForResource() : void
Properties
$buttonBar
Registry Container for Buttons
protected
ButtonBar
$buttonBar
$enabled
protected
bool
$enabled
= true
$menuRegistry
MenuRegistry Object
protected
MenuRegistry
$menuRegistry
$metaInformation
Meta information
protected
MetaInformation
$metaInformation
Methods
__construct()
Sets up buttonBar and MenuRegistry
public
__construct() : mixed
disable()
Sets the enabled property to FALSE (disabled).
public
disable() : mixed
docHeaderContent()
Returns the abstract content of the docHeader as an array
public
docHeaderContent() : array<string|int, mixed>
Return values
array<string|int, mixed>enable()
Sets the enabled property to TRUE.
public
enable() : mixed
getButtonBar()
Get ButtonBar
public
getButtonBar() : ButtonBar
Return values
ButtonBargetMenuRegistry()
Get moduleMenuRegistry
public
getMenuRegistry() : MenuRegistry
Return values
MenuRegistryisEnabled()
Determines whether this components is enabled.
public
isEnabled() : bool
Return values
boolsetMetaInformation()
Set page information
public
setMetaInformation(array<string|int, mixed> $metaInformation) : mixed
Parameters
- $metaInformation : array<string|int, mixed>
-
Record array
setMetaInformationForResource()
public
setMetaInformationForResource(ResourceInterface $resource) : void
Parameters
- $resource : ResourceInterface