Drupal 8  8.0.2
HelpController Class Reference
Inheritance diagram for HelpController:

Public Member Functions

 __construct (RouteMatchInterface $route_match)
 
 helpMain ()
 
 helpPage ($name)
 

Static Public Member Functions

static create (ContainerInterface $container)
 

Protected Member Functions

 helpLinksAsList ()
 

Protected Attributes

 $routeMatch
 

Detailed Description

Controller routines for help routes.

Constructor & Destructor Documentation

__construct ( RouteMatchInterface  $route_match)

Creates a new HelpController.

Parameters
\Drupal\Core\Routing\RouteMatchInterface$route_matchThe current route match.

References Drupal\routeMatch().

Here is the call graph for this function:

Member Function Documentation

static create ( ContainerInterface  $container)
static

{}

helpLinksAsList ( )
protected

Provides a formatted list of available help topics.

Returns
string A string containing the formatted list.

References Drupal\l(), and Drupal\moduleHandler().

Referenced by HelpController\helpMain().

Here is the call graph for this function:

Here is the caller graph for this function:

helpMain ( )

Prints a page listing a glossary of Drupal terminology.

Returns
string An HTML string representing the contents of help page.

References HelpController\helpLinksAsList(), and t().

Here is the call graph for this function:

helpPage (   $name)

Prints a page listing general help for a module.

Parameters
string$nameA module name to display a help page for.
Returns
array A render array as expected by drupal_render().
Exceptions
\Symfony\Component\HttpKernel\Exception\NotFoundHttpException

References Drupal\moduleHandler(), Drupal\routeMatch(), and t().

Here is the call graph for this function:


The documentation for this class was generated from the following file: