class ModalHelpController in Modal 4.0.x

Controller routines for help routes.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\modal_page\Controller\ModalHelpController

File

src/Controller/ModalHelpController.php, line 14

Namespace

Drupal\modal_page\Controller

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::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityTypeManager	protected	property	The entity type manager.
ControllerBase::$formBuilder	protected	property	The form builder.	2
ControllerBase::$keyValue	protected	property	The key-value storage.	1
ControllerBase::$languageManager	protected	property	The language manager.	1
ControllerBase::$moduleHandler	protected	property	The module handler.	2
ControllerBase::$stateService	protected	property	The state service.
ControllerBase::cache	protected	function	Returns the requested cache bin.
ControllerBase::config	protected	function	Retrieves a configuration object.
ControllerBase::container	private	function	Returns the service container.
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityTypeManager	protected	function	Retrieves the entity type manager.
ControllerBase::formBuilder	protected	function	Returns the form builder service.	2
ControllerBase::keyValue	protected	function	Returns a key/value storage collection.	1
ControllerBase::languageManager	protected	function	Returns the language manager service.	1
ControllerBase::moduleHandler	protected	function	Returns the module handler.	2
ControllerBase::redirect	protected	function	Returns a redirect response object for the specified route.
ControllerBase::state	protected	function	Returns the state storage service.
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
ModalHelpController::$configFactory	protected	property	The config factory. Overrides ControllerBase::$configFactory
ModalHelpController::$extensionListModule	protected	property	The extension list module.
ModalHelpController::$routeMatch	protected	property	The current route match.
ModalHelpController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
ModalHelpController::enableBootstrapAutomatically	public	function
ModalHelpController::index	public	function
ModalHelpController::__construct	public	function	Creates a new HelpController.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.