class GroupMenuController in Group Menu 8

Returns responses for 'group_menu' GroupContent routes.

Hierarchy

class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\group\Entity\Controller\GroupContentController
  - class \Drupal\groupmenu\Controller\GroupMenuController

Expanded class hierarchy of GroupMenuController

File

src/Controller/GroupMenuController.php, line 17

Namespace

Drupal\groupmenu\Controller

View source

class GroupMenuController extends GroupContentController {

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

  /**
   * Constructs a new GroupMenuController.
   *
   * @param \Drupal\group\Plugin\GroupContentEnablerManagerInterface $plugin_manager
   *   The group content plugin manager.
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
   *   The private store factory.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\Core\Entity\EntityFormBuilderInterface $entity_form_builder
   *   The entity form builder.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer.
   */
  public function __construct(GroupContentEnablerManagerInterface $plugin_manager, PrivateTempStoreFactory $temp_store_factory, EntityTypeManagerInterface $entity_type_manager, EntityFormBuilderInterface $entity_form_builder, RendererInterface $renderer) {
    parent::__construct($temp_store_factory, $entity_type_manager, $entity_form_builder, $renderer);
    $this->pluginManager = $plugin_manager;
  }

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

  /**
   * Provides the group menu overview page.
   *
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group to show the group menu content for.
   *
   * @return array
   *   A render array as expected by drupal_render().
   */
  public function groupContentOverview(GroupInterface $group) {
    $class = '\\Drupal\\groupmenu\\GroupMenuContentListBuilder';
    $definition = $this
      ->entityTypeManager()
      ->getDefinition('group_content');
    return $this
      ->entityTypeManager()
      ->createHandlerInstance($class, $definition)
      ->render();
  }

  /**
   * Provides the group menu overview page title.
   *
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group to show the group menu content for.
   *
   * @return string
   *   The page title for the group menu overview page.
   */
  public function groupContentOverviewTitle(GroupInterface $group) {
    return $this
      ->t("%label menus", [
      '%label' => $group
        ->label(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function addPage(GroupInterface $group, $create_mode = FALSE) {
    $build = parent::addPage($group, $create_mode);

    // Do not interfere with redirects.
    if (!is_array($build)) {
      return $build;
    }

    // Retrieve all of the responsible group content types, keyed by plugin ID.
    foreach ($this
      ->addPageBundles($group, $create_mode) as $plugin_id => $bundle_name) {

      /** @var \Drupal\group\Entity\GroupContentTypeInterface $group_content_type */
      if (!empty($build['#bundles'][$bundle_name])) {
        $build['#bundles'][$bundle_name]['label'] = $this
          ->t('Menu');
        $build['#bundles'][$bundle_name]['description'] = $this
          ->t('Create a menu for the group.');
      }
    }
    return $build;
  }

  /**
   * {@inheritdoc}
   */
  protected function addPageBundles(GroupInterface $group, $create_mode) {
    $bundles = [];

    // Retrieve all group_node plugins for the group's type.
    $plugin_ids = $this->pluginManager
      ->getInstalledIds($group
      ->getGroupType());
    foreach ($plugin_ids as $key => $plugin_id) {
      if (strpos($plugin_id, 'group_menu:') !== 0) {
        unset($plugin_ids[$key]);
      }
    }

    // Retrieve all of the responsible group content types, keyed by plugin ID.
    $storage = $this->entityTypeManager
      ->getStorage('group_content_type');
    $properties = [
      'group_type' => $group
        ->bundle(),
      'content_plugin' => $plugin_ids,
    ];
    foreach ($storage
      ->loadByProperties($properties) as $bundle => $group_content_type) {

      /** @var \Drupal\group\Entity\GroupContentTypeInterface $group_content_type */
      $bundles[$group_content_type
        ->getContentPluginId()] = $bundle;
    }
    return $bundles;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ControllerBase::$configFactory	protected	property	The configuration factory.
ControllerBase::$currentUser	protected	property	The current user service.	1
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::$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::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.
GroupContentController::$entityFormBuilder	protected	property	The entity form builder. Overrides ControllerBase::$entityFormBuilder
GroupContentController::$entityTypeManager	protected	property	The entity type manager. Overrides ControllerBase::$entityTypeManager
GroupContentController::$privateTempStoreFactory	protected	property	The private store factory.
GroupContentController::$renderer	protected	property	The renderer.
GroupContentController::addForm	public	function	Provides the group content submission form.
GroupContentController::addFormTitle	public	function	The _title_callback for the entity.group_content.add_form route.
GroupContentController::addPageBundleMessage	protected	function	Returns the 'add_bundle_message' string for the add page.
GroupContentController::addPageFormRoute	protected	function	Returns the route name of the form the add page should link to.
GroupContentController::collectionTitle	public	function	The _title_callback for the entity.group_content.collection route.
GroupContentController::createForm	public	function	Provides the group content creation form.
GroupContentController::createFormTitle	public	function	The _title_callback for the entity.group_content.create_form route.
GroupContentController::editFormTitle	public	function	The _title_callback for the entity.group_content.edit_form route.
GroupMenuController::$pluginManager	protected	property	The group content plugin manager.
GroupMenuController::addPage	public	function	Provides the group content creation overview page. Overrides GroupContentController::addPage
GroupMenuController::addPageBundles	protected	function	Retrieves a list of available bundles for the add page. Overrides GroupContentController::addPageBundles
GroupMenuController::create	public static	function	Instantiates a new instance of this class. Overrides GroupContentController::create
GroupMenuController::groupContentOverview	public	function	Provides the group menu overview page.
GroupMenuController::groupContentOverviewTitle	public	function	Provides the group menu overview page title.
GroupMenuController::__construct	public	function	Constructs a new GroupMenuController. Overrides GroupContentController::__construct
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.

You are here

class GroupMenuController in Group Menu 8

Hierarchy

File

Namespace

Members

API Navigation