You are here

Home » API reference » Group 8 » GroupTypeController.php

class GroupTypeController in Group 8

Same name and namespace in other branches
  1. 2.0.x src/Entity/Controller/GroupTypeController.php \Drupal\group\Entity\Controller\GroupTypeController

Provides the user permissions administration form for a specific group type.

Hierarchy

Expanded class hierarchy of GroupTypeController

File

src/Entity/Controller/GroupTypeController.php, line 18

Namespace

Drupal\group\Entity\Controller
View source 
class GroupTypeController extends ControllerBase {

  /**
   * The group type to use in this controller.
   *
   * @var \Drupal\group\Entity\GroupTypeInterface
   */
  protected $groupType;

  /**
   * The group content plugin manager.
   *
   * @var \Drupal\group\Plugin\GroupContentEnablerManagerInterface
   */
  protected $pluginManager;

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

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a new GroupTypeController.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\group\Plugin\GroupContentEnablerManagerInterface $plugin_manager
   *   The group content plugin manager.
   */
  public function __construct(ModuleHandlerInterface $module_handler, EntityTypeManagerInterface $entity_type_manager, GroupContentEnablerManagerInterface $plugin_manager) {
    $this->moduleHandler = $module_handler;
    $this->entityTypeManager = $entity_type_manager;
    $this->pluginManager = $plugin_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('module_handler'), $container
      ->get('entity_type.manager'), $container
      ->get('plugin.manager.group_content_enabler'));
  }

  /**
   * Builds an admin interface to manage the group type's group content plugins.
   *
   * @param \Drupal\group\Entity\GroupTypeInterface $group_type
   *   The group type to build an interface for.
   *
   * @return array
   *   The render array for the page.
   */
  public function content(GroupTypeInterface $group_type) {
    $this->groupType = $group_type;
    $rows['installed'] = $rows['available'] = [];
    $installed_ids = $this->pluginManager
      ->getInstalledIds($group_type);
    foreach ($this->pluginManager
      ->getAll() as $plugin_id => $plugin) {
      $is_installed = FALSE;

      // If the plugin is installed on the group type, use that one instead of
      // an 'empty' version so that we may use methods on it which expect to
      // have a group type configured.
      if (in_array($plugin_id, $installed_ids)) {
        $plugin = $this->groupType
          ->getContentPlugin($plugin_id);
        $is_installed = TRUE;
      }
      $status = $is_installed ? 'installed' : 'available';
      $rows[$status][$plugin_id] = $this
        ->buildRow($plugin, $is_installed);
    }
    $page['information'] = [
      '#type' => 'fieldset',
      '#title' => $this
        ->t('Information about content plugins'),
    ];
    $page['information']['intro']['#markup'] = $this
      ->t('<p>In order to be able to add entities as content to groups of this group type, a so-called content plugin needs to be installed. This plugin informs the Group module on how the entity type can be added to a group, what rules apply and whether it should control access over said entity type. When a plugin is installed, you should check out its configuration form to see what options are available to further customize the plugin behavior.</p>');
    $page['information']['fields']['#markup'] = $this
      ->t('<p>Should you choose to show the relationship entities that track which entity belongs to which group or should the module that provided the module enforce this, you can control which fields are available on that relation entity and how they are presented in the front-end.</p>');
    $page['information']['install_types'] = [
      '#theme' => 'item_list',
      '#items' => [
        $this
          ->t('<strong>Manual</strong> content plugins can be (un)installed freely by the user'),
        $this
          ->t('<strong>Code-only</strong> content plugins can only be (un)installed through code, this is often done when certain conditions are met in the module that provided the plugin'),
        $this
          ->t('<strong>Enforced</strong> content plugins are always enabled and cannot be uninstalled'),
      ],
      '#prefix' => $this
        ->t('<p>The following installation types are available:</p>'),
    ];
    $page['system_compact_link'] = [
      '#id' => FALSE,
      '#type' => 'system_compact_link',
    ];
    $page['content'] = [
      '#type' => 'table',
      '#header' => [
        'info' => $this
          ->t('Plugin information'),
        'provider' => $this
          ->t('Provided by'),
        'entity_type_id' => $this
          ->t('Applies to'),
        'status' => $this
          ->t('Status'),
        'install_type' => $this
          ->t('Installation type'),
        'operations' => $this
          ->t('Operations'),
      ],
    ];
    $page['content'] += $rows['installed'];
    $page['content'] += $rows['available'];
    return $page;
  }

  /**
   * Builds a row for a content enabler plugin.
   *
   * @param \Drupal\group\Plugin\GroupContentEnablerInterface $plugin
   *   The content enabler plugin to build operation links for.
   * @param bool $is_installed
   *   Whether the plugin is installed.
   *
   * @return array
   *   A render array to use as a table row.
   */
  public function buildRow(GroupContentEnablerInterface $plugin, $is_installed) {
    $status = $is_installed ? $this
      ->t('Installed') : $this
      ->t('Available');
    $install_type = $this
      ->t('Manual');
    if ($plugin
      ->isEnforced()) {
      $install_type = $this
        ->t('Enforced');
    }
    elseif ($plugin
      ->isCodeOnly()) {
      $install_type = $this
        ->t('Code-only');
    }
    $row = [
      'info' => [
        '#type' => 'inline_template',
        '#template' => '<div class="description"><span class="label">{{ label }}</span>{% if description %}<br/>{{ description }}{% endif %}</div>',
        '#context' => [
          'label' => $plugin
            ->getLabel(),
        ],
      ],
      'provider' => [
        '#markup' => $this->moduleHandler
          ->getName($plugin
          ->getProvider()),
      ],
      'entity_type_id' => [
        '#markup' => $this->entityTypeManager
          ->getDefinition($plugin
          ->getEntityTypeId())
          ->getLabel(),
      ],
      'status' => [
        '#markup' => $status,
      ],
      'install_type' => [
        '#markup' => $install_type,
      ],
      'operations' => $this
        ->buildOperations($plugin, $is_installed),
    ];

    // Show the content enabler description if toggled on.
    if (!system_admin_compact_mode()) {
      $row['info']['#context']['description'] = $plugin
        ->getDescription();
    }
    return $row;
  }

  /**
   * Provides an array of information to build a list of operation links.
   *
   * @param \Drupal\group\Plugin\GroupContentEnablerInterface $plugin
   *   The content enabler plugin to build operation links for.
   * @param bool $is_installed
   *   Whether the plugin is installed.
   *
   * @return array
   *   An associative array of operation links for the group type's content
   *   plugin, keyed by operation name, containing the following key-value pairs:
   *   - title: The localized title of the operation.
   *   - url: An instance of \Drupal\Core\Url for the operation URL.
   *   - weight: The weight of this operation.
   */
  public function getOperations($plugin, $is_installed) {
    return $plugin
      ->getOperations() + $this
      ->getDefaultOperations($plugin, $is_installed);
  }

  /**
   * Gets the group type's content plugin's default operation links.
   *
   * @param \Drupal\group\Plugin\GroupContentEnablerInterface $plugin
   *   The content enabler plugin to build operation links for.
   * @param bool $is_installed
   *   Whether the plugin is installed.
   *
   * @return array
   *   The array structure is identical to the return value of
   *   self::getOperations().
   */
  protected function getDefaultOperations($plugin, $is_installed) {
    $operations = [];
    $plugin_id = $plugin
      ->getPluginId();
    $ui_allowed = !$plugin
      ->isEnforced() && !$plugin
      ->isCodeOnly();
    if ($is_installed) {

      /** @var \Drupal\group\Entity\GroupContentTypeInterface $group_content_type */
      $group_content_type_id = $plugin
        ->getContentTypeConfigId();
      $group_content_type = GroupContentType::load($group_content_type_id);
      $route_params = [
        'group_content_type' => $group_content_type_id,
      ];
      $operations['configure'] = [
        'title' => $this
          ->t('Configure'),
        'url' => new Url('entity.group_content_type.edit_form', $route_params),
      ];
      if ($ui_allowed) {
        $operations['uninstall'] = [
          'title' => $this
            ->t('Uninstall'),
          'weight' => 99,
          'url' => new Url('entity.group_content_type.delete_form', $route_params),
        ];
      }
      if ($this->moduleHandler
        ->moduleExists('field_ui')) {
        $operations += field_ui_entity_operation($group_content_type);
      }
    }
    elseif ($ui_allowed) {
      $operations['install'] = [
        'title' => $this
          ->t('Install'),
        'url' => new Url('entity.group_content_type.add_form', [
          'group_type' => $this->groupType
            ->id(),
          'plugin_id' => $plugin_id,
        ]),
      ];
    }
    return $operations;
  }

  /**
   * Builds operation links for the group type's content plugins.
   *
   * @param \Drupal\group\Plugin\GroupContentEnablerInterface $plugin
   *   The content enabler plugin to build operation links for.
   * @param bool $is_installed
   *   Whether the plugin is installed.
   *
   * @return array
   *   A render array of operation links.
   */
  public function buildOperations($plugin, $is_installed) {
    $build = [
      '#type' => 'operations',
      '#links' => $this
        ->getOperations($plugin, $is_installed),
    ];
    uasort($build['#links'], '\\Drupal\\Component\\Utility\\SortArray::sortByWeightElement');
    return $build;
  }

}

Members

Namesort descending 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::$entityManager protected property The entity 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::$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::entityManager Deprecated protected function Retrieves the entity manager service.
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. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
GroupTypeController::$entityTypeManager protected property The entity type manager. Overrides ControllerBase::$entityTypeManager
GroupTypeController::$groupType protected property The group type to use in this controller.
GroupTypeController::$moduleHandler protected property The module manager. Overrides ControllerBase::$moduleHandler
GroupTypeController::$pluginManager protected property The group content plugin manager.
GroupTypeController::buildOperations public function Builds operation links for the group type's content plugins.
GroupTypeController::buildRow public function Builds a row for a content enabler plugin.
GroupTypeController::content public function Builds an admin interface to manage the group type's group content plugins.
GroupTypeController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
GroupTypeController::getDefaultOperations protected function Gets the group type's content plugin's default operation links.
GroupTypeController::getOperations public function Provides an array of information to build a list of operation links.
GroupTypeController::__construct public function Constructs a new GroupTypeController.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator 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. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
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. 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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.