class ModalHelpController in Modal 4.1.x
Same name and namespace in other branches
- 8.3 src/Controller/ModalHelpController.php \Drupal\modal_page\Controller\ModalHelpController
- 8.2 src/Controller/ModalHelpController.php \Drupal\modal_page\Controller\ModalHelpController
- 5.0.x src/Controller/ModalHelpController.php \Drupal\modal_page\Controller\ModalHelpController
- 4.0.x src/Controller/ModalHelpController.php \Drupal\modal_page\Controller\ModalHelpController
Controller routines for help routes.
Hierarchy
- class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
- class \Drupal\modal_page\Controller\ModalHelpController
Expanded class hierarchy of ModalHelpController
File
- src/
Controller/ ModalHelpController.php, line 14
Namespace
Drupal\modal_page\ControllerView source
class ModalHelpController extends ControllerBase {
/**
* The current route match.
*
* @var \Drupal\Core\Routing\RouteMatchInterface
*/
protected $routeMatch;
/**
* The extension list module.
*
* @var \Drupal\Core\Extension\ExtensionList
*/
protected $extensionListModule;
/**
* The config factory.
*
* @var \Drupal\Core\Config\ConfigFactoryInterface
*/
protected $configFactory;
/**
* Creates a new HelpController.
*/
public function __construct(RouteMatchInterface $route_match, ExtensionList $extension_list_module, ConfigFactoryInterface $config_factory) {
$this->routeMatch = $route_match;
$this->extensionListModule = $extension_list_module;
$this->configFactory = $config_factory;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('current_route_match'), $container
->get('extension.list.module'), $container
->get('config.factory'));
}
/**
* {@inheritdoc}
*/
public function index() {
$build = [];
$projectMachineName = 'modal_page';
$projectName = $this
->moduleHandler()
->getName($projectMachineName);
$build['#title'] = 'Modal Page Help';
$helperMarkup = $this
->moduleHandler()
->invoke($projectMachineName, 'help', [
"help.page.{$projectMachineName}",
$this->routeMatch,
]);
if (!is_array($helperMarkup)) {
$helperMarkup = [
'#markup' => $helperMarkup,
];
}
$build['top'] = $helperMarkup;
// Only print list of administration pages if the project in question has
// any such pages associated with it.
$adminTasks = system_get_module_admin_tasks($projectMachineName, $this->extensionListModule
->getExtensionInfo($projectMachineName));
if (empty($adminTasks)) {
return $build;
}
$links = [];
foreach ($adminTasks as $adminTask) {
$link['url'] = $adminTask['url'];
$link['title'] = $adminTask['title'];
if ($link['url']
->getRouteName() === 'modal_page.settings') {
$link['title'] = 'Modal Settings';
}
$links[] = $link;
}
$build['links'] = [
'#theme' => 'links__help',
'#heading' => [
'level' => 'h3',
'text' => $this
->t('@project_name administration pages', [
'@project_name' => $projectName,
]),
],
'#links' => $links,
];
return $build;
}
/**
* {@inheritdoc}
*/
public function enableBootstrapAutomatically() {
$settings = $this->configFactory
->getEditable('modal_page.settings');
$verifyLoadBootstrapAutomatically = $settings
->get('verify_load_bootstrap_automatically');
if (empty($verifyLoadBootstrapAutomatically)) {
echo FALSE;
exit;
}
$settings
->set('load_bootstrap', TRUE);
$settings
->save();
echo TRUE;
exit;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ControllerBase:: |
protected | property | The current user service. | 1 |
ControllerBase:: |
protected | property | The entity form builder. | |
ControllerBase:: |
protected | property | The entity type manager. | |
ControllerBase:: |
protected | property | The form builder. | 2 |
ControllerBase:: |
protected | property | The key-value storage. | 1 |
ControllerBase:: |
protected | property | The language manager. | 1 |
ControllerBase:: |
protected | property | The module handler. | 2 |
ControllerBase:: |
protected | property | The state service. | |
ControllerBase:: |
protected | function | Returns the requested cache bin. | |
ControllerBase:: |
protected | function | Retrieves a configuration object. | |
ControllerBase:: |
private | function | Returns the service container. | |
ControllerBase:: |
protected | function | Returns the current user. | 1 |
ControllerBase:: |
protected | function | Retrieves the entity form builder. | |
ControllerBase:: |
protected | function | Retrieves the entity type manager. | |
ControllerBase:: |
protected | function | Returns the form builder service. | 2 |
ControllerBase:: |
protected | function | Returns a key/value storage collection. | 1 |
ControllerBase:: |
protected | function | Returns the language manager service. | 1 |
ControllerBase:: |
protected | function | Returns the module handler. | 2 |
ControllerBase:: |
protected | function | Returns a redirect response object for the specified route. | |
ControllerBase:: |
protected | function | Returns the state storage service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
ModalHelpController:: |
protected | property |
The config factory. Overrides ControllerBase:: |
|
ModalHelpController:: |
protected | property | The extension list module. | |
ModalHelpController:: |
protected | property | The current route match. | |
ModalHelpController:: |
public static | function |
Instantiates a new instance of this class. Overrides ControllerBase:: |
|
ModalHelpController:: |
public | function | ||
ModalHelpController:: |
public | function | ||
ModalHelpController:: |
public | function | Creates a new HelpController. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |