ILMSController
extends ControllerBase
in package
Returns responses for the Integrated Library Management System core module.
Table of Contents
Properties
- $menuActiveTrail : MenuActiveTrailInterface
- The active menu trail interface.
- $menuTree : MenuLinkTreeInterface
- The menu link tree interface.
Methods
- __construct() : mixed
- Constructs an ILMS Controller object.
- create() : mixed
- {@inheritdoc}
- overview() : array<string|int, mixed>
- Builds the admin dashboard page.
- systemAdminMenuBlockPage() : mixed
- Generates block content that should appear on the overview page.
- buildOverview() : array<string|int, mixed>
- Actually builds the overview page.
- getAdminBlock() : array<string|int, mixed>
- Gets admin blocks for display on the overview page.
- getBlockContents() : array<string|int, mixed>
- Get menu block contents for display on the overview page.
Properties
$menuActiveTrail
The active menu trail interface.
protected
MenuActiveTrailInterface
$menuActiveTrail
$menuTree
The menu link tree interface.
protected
MenuLinkTreeInterface
$menuTree
Methods
__construct()
Constructs an ILMS Controller object.
public
__construct(MenuLinkTreeInterface $menu_tree, MenuActiveTrailInterface $menu_active_trail) : mixed
Parameters
- $menu_tree : MenuLinkTreeInterface
- $menu_active_trail : MenuActiveTrailInterface
create()
{@inheritdoc}
public
static create(ContainerInterface $container) : mixed
Parameters
- $container : ContainerInterface
overview()
Builds the admin dashboard page.
public
overview(array<string|int, mixed> $link_id) : array<string|int, mixed>
This method generates the overview page for each section of the ILMS.
Parameters
- $link_id : array<string|int, mixed>
-
The link id to begin traversing through. This link id should match a link id in one of the *.routing.yml files.
Return values
array<string|int, mixed> —The menu tree object.
systemAdminMenuBlockPage()
Generates block content that should appear on the overview page.
public
systemAdminMenuBlockPage() : mixed
buildOverview()
Actually builds the overview page.
protected
buildOverview(array<string|int, mixed> $tree) : array<string|int, mixed>
Parameters
- $tree : array<string|int, mixed>
-
The menu link tree object to build.
Return values
array<string|int, mixed> —The render array of items to appear on the overview page.
getAdminBlock()
Gets admin blocks for display on the overview page.
protected
getAdminBlock(MenuLinkInterface $instance) : array<string|int, mixed>
Parameters
- $instance : MenuLinkInterface
Return values
array<string|int, mixed> —An array of admin blocks to render on the overview page.
getBlockContents()
Get menu block contents for display on the overview page.
protected
getBlockContents() : array<string|int, mixed>
Return values
array<string|int, mixed> —The render array of items to return.