class PmDashboardController in Drupal PM (Project Management) 4.x

Dashboard Controller.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\pm\Controller\PmDashboardController

File

src/Controller/PmDashboardController.php, line 12

Namespace

Drupal\pm\Controller

class PmDashboardController extends ControllerBase {

  /**
   * Drupal\Core\Entity\EntityTypeManagerInterface definition.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Drupal\Core\Extension\ModuleHandlerInterface definition.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * Drupal\Core\Logger\LoggerChannelInterface definition.
   *
   * @var \Drupal\Core\Logger\LoggerChannelInterface
   */
  protected $loggerChannelDefault;

  /**
   * Drupal\pm\PmDashboardItemsManager definition.
   *
   * @var \Drupal\pm\PmDashboardItemsManager
   */
  protected $dashboardItemsManager;

  /**
   * Drupal\Core\Path\PathValidator definition.
   *
   * @var \Drupal\Core\Path\PathValidator
   */
  protected $pathValidator;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    $instance = parent::create($container);
    $instance->entityTypeManager = $container
      ->get('entity_type.manager');
    $instance->moduleHandler = $container
      ->get('module_handler');
    $instance->loggerChannelDefault = $container
      ->get('logger.channel.default');
    $instance->dashboardItemsManager = $container
      ->get('plugin.manager.pm_dashboard_items');
    $instance->pathValidator = $container
      ->get('path.validator');
    return $instance;
  }

  /**
   * Dashboard.
   *
   * @return string
   *   Return Hello string.
   */
  public function dashboard() {
    return [
      'dashboard' => [
        '#theme' => 'pm_dashboard',
        '#items' => $this
          ->getDashboardLinks(),
      ],
      '#cache' => [
        'max-age' => 0,
      ],
    ];
  }

  /**
   * Get links for dashboard.
   */
  protected function getDashboardLinks() {
    $items = $this->dashboardItemsManager
      ->getDefinitions();
    $output = [];
    foreach ($items as $item) {
      if ($this->pathValidator
        ->isValid($item['link']['path'])) {
        $item['link']['url'] = Url::fromUri('internal:' . $item['link']['path']);
        $group_label = $item['group'] ?? '';
        $output[$group_label]['label'] = $group_label;
        $output[$group_label]['items'][] = $item;
      }
    }
    ksort($output);
    return $output;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
ControllerBase::$entityFormBuilder	protected	property	The entity form builder.
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::$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.
PmDashboardController::$dashboardItemsManager	protected	property	Drupal\pm\PmDashboardItemsManager definition.
PmDashboardController::$entityTypeManager	protected	property	Drupal\Core\Entity\EntityTypeManagerInterface definition. Overrides ControllerBase::$entityTypeManager
PmDashboardController::$loggerChannelDefault	protected	property	Drupal\Core\Logger\LoggerChannelInterface definition.
PmDashboardController::$moduleHandler	protected	property	Drupal\Core\Extension\ModuleHandlerInterface definition. Overrides ControllerBase::$moduleHandler
PmDashboardController::$pathValidator	protected	property	Drupal\Core\Path\PathValidator definition.
PmDashboardController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
PmDashboardController::dashboard	public	function	Dashboard.
PmDashboardController::getDashboardLinks	protected	function	Get links for dashboard.
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.