You are here

Home » API reference » Total Control Admin Dashboard 8.2 » AdministerMenus.php

class AdministerMenus in Total Control Admin Dashboard 8.2

Same name and namespace in other branches
  1. 3.0.x src/Plugin/Block/AdministerMenus.php \Drupal\total_control\Plugin\Block\AdministerMenus

Provides a 'Administer Menus'.

Plugin annotation


@Block(
id = "administer_menus",
admin_label = @Translation("Administer Menus"),
category = @Translation("Dashboard")
)

Hierarchy

Expanded class hierarchy of AdministerMenus

File

src/Plugin/Block/AdministerMenus.php, line 27

Namespace

Drupal\total_control\Plugin\Block
View source 
class AdministerMenus extends BlockBase implements BlockPluginInterface, ContainerFactoryPluginInterface {

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * The renderer service.
   *
   * @var Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * The redirect destination service.
   *
   * @var \Drupal\Core\Routing\RedirectDestinationInterface
   */
  protected $redirectDestination;

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * Creates an AdministerMenus block instance.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
   * @param Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   * @param \Drupal\Core\Routing\RedirectDestinationInterface $redirect_destination
   *   The redirect destination service.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ModuleHandlerInterface $module_handler, RendererInterface $renderer, RedirectDestinationInterface $redirect_destination, AccountInterface $current_user) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->moduleHandler = $module_handler;
    $this->renderer = $renderer;
    $this->redirectDestination = $redirect_destination;
    $this->currentUser = $current_user;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('module_handler'), $container
      ->get('renderer'), $container
      ->get('redirect.destination'), $container
      ->get('current_user'));
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    if (!$this->moduleHandler
      ->moduleExists('menu_ui')) {
      $you_have_to_enable_text = $this
        ->t('You have to enable');
      $menu_ui_text = $this
        ->t('Menu UI');
      $to_see_this_block_text = $this
        ->t('module to see this block.');
      $markup_data = $you_have_to_enable_text . ' <strong>' . $menu_ui_text . '</strong> ' . $to_see_this_block_text;
      return [
        '#type' => 'markup',
        '#markup' => $markup_data,
      ];
    }
    $menus = menu_ui_get_menus();

    // Support the custom permissions from the "menu_admin_per_menu" module.
    if (\Drupal::moduleHandler()
      ->moduleExists('menu_admin_per_menu')) {
      if (!\Drupal::currentUser()
        ->hasPermission('administer menu')) {

        /** @var \Drupal\menu_admin_per_menu\MenuAdminPerMenuAccessInterface $allowedMenusService */
        $allowedMenusService = \Drupal::service('menu_admin_per_menu.allowed_menus');
        $allowed_menus = $allowedMenusService
          ->getPerMenuPermissions(\Drupal::currentUser());
        foreach ($menus as $id => $label) {
          if (!in_array($id, $allowed_menus)) {
            unset($menus[$id]);
          }
        }
      }
    }
    $config = $this
      ->getConfiguration();
    $header = [
      [
        'data' => $this
          ->t('Menu'),
      ],
      [
        'data' => $this
          ->t('Operations'),
        'colspan' => 2,
      ],
    ];
    $destination = $this->redirectDestination
      ->getAsArray();
    $options = [
      $destination,
    ];
    foreach ($menus as $menu_name => $menu) {
      $is_new = !array_key_exists($menu_name, $config['total_control_admin_menus']);
      if ($is_new || array_key_exists($menu_name, $config['total_control_admin_menus'])) {
        if ($is_new || $config['total_control_admin_menus'][$menu_name] === $menu_name) {
          $rows[] = [
            'data' => [
              $menu,
              Link::fromTextAndUrl($this
                ->t('Configure'), new Url('entity.menu.edit_form', [
                'menu' => $menu_name,
                'options' => $options,
              ]))
                ->toString(),
              Link::fromTextAndUrl($this
                ->t('Add new link'), new Url('entity.menu.add_link_form', [
                'menu' => $menu_name,
                'options' => $options,
              ]))
                ->toString(),
            ],
          ];
        }
      }
    }

    // Build a link to the menu admin UI.
    $link = NULL;
    if ($this->currentUser
      ->hasPermission('administer menu')) {
      $link = Link::fromTextAndUrl($this
        ->t('Menu administration'), new Url('entity.menu.collection'));
    }
    if (empty($rows)) {
      $rows[] = [
        [
          'data' => $this
            ->t('There are no menus to display.'),
          'colspan' => 3,
        ],
      ];
    }
    $body_data = [
      '#theme' => 'table',
      '#header' => $header,
      '#rows' => $rows,
    ];
    $markup_data = $this->renderer
      ->render($body_data);
    if ($link instanceof RenderableInterface) {
      $markup_data .= $link
        ->toString();
    }
    return [
      '#type' => 'markup',
      '#markup' => $markup_data,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function blockForm($form, FormStateInterface $form_state) {
    $form = parent::blockForm($form, $form_state);
    $config = $this
      ->getConfiguration();
    $menus = menu_ui_get_menus();
    $form['total_control_admin_menus'] = [
      '#type' => 'checkboxes',
      '#title' => $this
        ->t('Show links for the following menus on the dashboard'),
      '#options' => $menus,
      '#default_value' => $config['total_control_admin_menus'],
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function blockSubmit($form, FormStateInterface $form_state) {
    parent::blockSubmit($form, $form_state);
    $values = $form_state
      ->getValues();
    $this->configuration['total_control_admin_menus'] = $values['total_control_admin_menus'];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AdministerMenus::$currentUser protected property The current user.
AdministerMenus::$moduleHandler protected property The module handler service.
AdministerMenus::$redirectDestination protected property The redirect destination service.
AdministerMenus::$renderer protected property The renderer service.
AdministerMenus::blockForm public function Returns the configuration form elements specific to this block plugin. Overrides BlockPluginTrait::blockForm
AdministerMenus::blockSubmit public function Adds block type-specific submission handling for the block form. Overrides BlockPluginTrait::blockSubmit
AdministerMenus::build public function Builds and returns the renderable array for this block plugin. Overrides BlockPluginInterface::build
AdministerMenus::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
AdministerMenus::__construct public function Creates an AdministerMenus block instance. Overrides BlockPluginTrait::__construct
BlockPluginInterface::BLOCK_LABEL_VISIBLE constant Indicates the block label (title) should be displayed to end users.
BlockPluginTrait::$transliteration protected property The transliteration service.
BlockPluginTrait::access public function
BlockPluginTrait::baseConfigurationDefaults protected function Returns generic default configuration for block plugins.
BlockPluginTrait::blockAccess protected function Indicates whether the block should be shown. 16
BlockPluginTrait::blockValidate public function 3
BlockPluginTrait::buildConfigurationForm public function Creates a generic configuration form for all block types. Individual block plugins can add elements to this form by overriding BlockBase::blockForm(). Most block plugins should not override this method unless they need to alter the generic form elements. 2
BlockPluginTrait::calculateDependencies public function
BlockPluginTrait::defaultConfiguration public function 19
BlockPluginTrait::getConfiguration public function 1
BlockPluginTrait::getMachineNameSuggestion public function 1
BlockPluginTrait::getPreviewFallbackString public function 3
BlockPluginTrait::label public function
BlockPluginTrait::setConfiguration public function
BlockPluginTrait::setConfigurationValue public function
BlockPluginTrait::setTransliteration public function Sets the transliteration service.
BlockPluginTrait::submitConfigurationForm public function Most block plugins should not override this method. To add submission handling for a specific block type, override BlockBase::blockSubmit().
BlockPluginTrait::transliteration protected function Wraps the transliteration service.
BlockPluginTrait::validateConfigurationForm public function Most block plugins should not override this method. To add validation for a specific block type, override BlockBase::blockValidate(). 1
ContextAwarePluginAssignmentTrait::addContextAssignmentElement protected function Builds a form element for assigning a context to a given slot.
ContextAwarePluginAssignmentTrait::contextHandler protected function Wraps the context handler.
ContextAwarePluginBase::$context protected property The data objects representing the context of this plugin.
ContextAwarePluginBase::$contexts Deprecated private property Data objects representing the contexts passed in the plugin configuration.
ContextAwarePluginBase::createContextFromConfiguration protected function Overrides ContextAwarePluginBase::createContextFromConfiguration
ContextAwarePluginBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts 9
ContextAwarePluginBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge 7
ContextAwarePluginBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags 4
ContextAwarePluginBase::getContext public function This code is identical to the Component in order to pick up a different Context class. Overrides ContextAwarePluginBase::getContext
ContextAwarePluginBase::getContextDefinition public function Overrides ContextAwarePluginBase::getContextDefinition
ContextAwarePluginBase::getContextDefinitions public function Overrides ContextAwarePluginBase::getContextDefinitions
ContextAwarePluginBase::getContextMapping public function Gets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::getContextMapping
ContextAwarePluginBase::getContexts public function Gets the defined contexts. Overrides ContextAwarePluginInterface::getContexts
ContextAwarePluginBase::getContextValue public function Gets the value for a defined context. Overrides ContextAwarePluginInterface::getContextValue
ContextAwarePluginBase::getContextValues public function Gets the values for all defined contexts. Overrides ContextAwarePluginInterface::getContextValues
ContextAwarePluginBase::setContext public function Set a context on this plugin. Overrides ContextAwarePluginBase::setContext
ContextAwarePluginBase::setContextMapping public function Sets a mapping of the expected assignment names to their context names. Overrides ContextAwarePluginInterface::setContextMapping
ContextAwarePluginBase::setContextValue public function Sets the value for a defined context. Overrides ContextAwarePluginBase::setContextValue
ContextAwarePluginBase::validateContexts public function Validates the set values for the defined contexts. Overrides ContextAwarePluginInterface::validateContexts
ContextAwarePluginBase::__get public function Implements magic __get() method.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginWithFormsTrait::getFormClass public function
PluginWithFormsTrait::hasFormClass public function
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.
TypedDataTrait::$typedDataManager protected property The typed data manager used for creating the data types.
TypedDataTrait::getTypedDataManager public function Gets the typed data manager. 2
TypedDataTrait::setTypedDataManager public function Sets the typed data manager. 2