class GroupContentController in Group 8

Same name and namespace in other branches

2.0.x src/Entity/Controller/GroupContentController.php \Drupal\group\Entity\Controller\GroupContentController

Returns responses for GroupContent routes.

Hierarchy

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

Expanded class hierarchy of GroupContentController

1 file declares its use of GroupContentController

GroupNodeController.php in modules/gnode/src/Controller/GroupNodeController.php

File

src/Entity/Controller/GroupContentController.php, line 22

Namespace

Drupal\group\Entity\Controller

View source

class GroupContentController extends ControllerBase {

  /**
   * The private store factory.
   *
   * @var \Drupal\Core\TempStore\PrivateTempStoreFactory
   */
  protected $privateTempStoreFactory;

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

  /**
   * The entity form builder.
   *
   * @var \Drupal\Core\Entity\EntityFormBuilderInterface
   */
  protected $entityFormBuilder;

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

  /**
   * Constructs a new GroupContentController.
   *
   * @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(PrivateTempStoreFactory $temp_store_factory, EntityTypeManagerInterface $entity_type_manager, EntityFormBuilderInterface $entity_form_builder, RendererInterface $renderer) {
    $this->privateTempStoreFactory = $temp_store_factory;
    $this->entityTypeManager = $entity_type_manager;
    $this->entityFormBuilder = $entity_form_builder;
    $this->renderer = $renderer;
  }

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

  /**
   * Provides the group content creation overview page.
   *
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group to add the group content to.
   * @param bool $create_mode
   *   (optional) Whether the target entity still needs to be created. Defaults
   *   to FALSE, meaning the target entity is assumed to exist already.
   *
   * @return array|\Symfony\Component\HttpFoundation\RedirectResponse
   *   The group content creation overview page or a redirect to the form for
   *   adding group content if there is only one group content type.
   */
  public function addPage(GroupInterface $group, $create_mode = FALSE) {
    $build = [
      '#theme' => 'entity_add_list',
      '#bundles' => [],
    ];
    $form_route = $this
      ->addPageFormRoute($group, $create_mode);
    $bundle_names = $this
      ->addPageBundles($group, $create_mode);

    // Set the add bundle message if available.
    $add_bundle_message = $this
      ->addPageBundleMessage($group, $create_mode);
    if ($add_bundle_message !== FALSE) {
      $build['#add_bundle_message'] = $add_bundle_message;
    }

    // Filter out the bundles the user doesn't have access to.
    $access_control_handler = $this->entityTypeManager
      ->getAccessControlHandler('group_content');
    foreach ($bundle_names as $plugin_id => $bundle_name) {
      $access = $access_control_handler
        ->createAccess($bundle_name, NULL, [
        'group' => $group,
      ], TRUE);
      if (!$access
        ->isAllowed()) {
        unset($bundle_names[$plugin_id]);
      }
      $this->renderer
        ->addCacheableDependency($build, $access);
    }

    // Redirect if there's only one bundle available.
    if (count($bundle_names) == 1) {
      reset($bundle_names);
      $route_params = [
        'group' => $group
          ->id(),
        'plugin_id' => key($bundle_names),
      ];
      $url = Url::fromRoute($form_route, $route_params, [
        'absolute' => TRUE,
      ]);
      return new RedirectResponse($url
        ->toString());
    }

    // Set the info for all of the remaining bundles.
    foreach ($bundle_names as $plugin_id => $bundle_name) {
      $plugin = $group
        ->getGroupType()
        ->getContentPlugin($plugin_id);
      $label = $plugin
        ->getLabel();
      $build['#bundles'][$bundle_name] = [
        'label' => $label,
        'description' => $plugin
          ->getContentTypeDescription(),
        'add_link' => Link::createFromRoute($label, $form_route, [
          'group' => $group
            ->id(),
          'plugin_id' => $plugin_id,
        ]),
      ];
    }

    // Add the list cache tags for the GroupContentType entity type.
    $bundle_entity_type = $this->entityTypeManager
      ->getDefinition('group_content_type');
    $build['#cache']['tags'] = $bundle_entity_type
      ->getListCacheTags();
    return $build;
  }

  /**
   * Retrieves a list of available bundles for the add page.
   *
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group to add the group content to.
   * @param bool $create_mode
   *   Whether the target entity still needs to be created.
   *
   * @return array
   *   An array of group content type IDs, keyed by the plugin that was used to
   *   generate their respective group content types.
   *
   * @see ::addPage()
   */
  protected function addPageBundles(GroupInterface $group, $create_mode) {
    $bundles = [];

    /** @var \Drupal\group\Entity\Storage\GroupContentTypeStorageInterface $storage */
    $storage = $this->entityTypeManager
      ->getStorage('group_content_type');
    foreach ($storage
      ->loadByGroupType($group
      ->getGroupType()) as $bundle => $group_content_type) {

      // Skip the bundle if we are listing bundles that allow you to create an
      // entity in the group and the bundle's plugin does not support that.
      if ($create_mode && !$group_content_type
        ->getContentPlugin()
        ->definesEntityAccess()) {
        continue;
      }
      $bundles[$group_content_type
        ->getContentPluginId()] = $bundle;
    }
    return $bundles;
  }

  /**
   * Returns the 'add_bundle_message' string for the add page.
   *
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group to add the group content to.
   * @param bool $create_mode
   *   Whether the target entity still needs to be created.
   *
   * @return string|false
   *   The translated string or FALSE if no string should be set.
   *
   * @see ::addPage()
   */
  protected function addPageBundleMessage(GroupInterface $group, $create_mode) {

    // We do not set the 'add_bundle_message' variable because we deny access to
    // the page if no bundle is available. This method exists so that modules
    // that extend this controller may specify a message should they decide to
    // allow access to their page even if it has no bundles.
    return FALSE;
  }

  /**
   * Returns the route name of the form the add page should link to.
   *
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group to add the group content to.
   * @param bool $create_mode
   *   Whether the target entity still needs to be created.
   *
   * @return string
   *   The route name.
   *
   * @see ::addPage()
   */
  protected function addPageFormRoute(GroupInterface $group, $create_mode) {
    return $create_mode ? 'entity.group_content.create_form' : 'entity.group_content.add_form';
  }

  /**
   * Provides the group content submission form.
   *
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group to add the group content to.
   * @param string $plugin_id
   *   The group content enabler to add content with.
   *
   * @return array
   *   A group submission form.
   */
  public function addForm(GroupInterface $group, $plugin_id) {

    /** @var \Drupal\group\Plugin\GroupContentEnablerInterface $plugin */
    $plugin = $group
      ->getGroupType()
      ->getContentPlugin($plugin_id);
    $values = [
      'type' => $plugin
        ->getContentTypeConfigId(),
      'gid' => $group
        ->id(),
    ];
    $group_content = $this
      ->entityTypeManager()
      ->getStorage('group_content')
      ->create($values);
    return $this->entityFormBuilder
      ->getForm($group_content, 'add');
  }

  /**
   * The _title_callback for the entity.group_content.add_form route.
   *
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group to add the group content to.
   * @param string $plugin_id
   *   The group content enabler to add content with.
   *
   * @return string
   *   The page title.
   */
  public function addFormTitle(GroupInterface $group, $plugin_id) {

    /** @var \Drupal\group\Plugin\GroupContentEnablerInterface $plugin */
    $plugin = $group
      ->getGroupType()
      ->getContentPlugin($plugin_id);
    $group_content_type = GroupContentType::load($plugin
      ->getContentTypeConfigId());
    return $this
      ->t('Add @name', [
      '@name' => $group_content_type
        ->label(),
    ]);
  }

  /**
   * The _title_callback for the entity.group_content.edit_form route.
   *
   * Overrides the Drupal\Core\Entity\Controller\EntityController::editTitle().
   *
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match.
   * @param \Drupal\Core\Entity\EntityInterface $_entity
   *   (optional) An entity, passed in directly from the request attributes.
   *
   * @return string|null
   *   The title for the entity edit page, if an entity was found.
   */
  public function editFormTitle(RouteMatchInterface $route_match, EntityInterface $_entity = NULL) {
    if ($entity = $route_match
      ->getParameter('group_content')) {
      return $this
        ->t('Edit %label', [
        '%label' => $entity
          ->label(),
      ]);
    }
  }

  /**
   * The _title_callback for the entity.group_content.collection route.
   *
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group to add the group content to.
   *
   * @return string
   *   The page title.
   *
   * @todo Revisit when 8.2.0 is released, https://www.drupal.org/node/2767853.
   */
  public function collectionTitle(GroupInterface $group) {
    return $this
      ->t('All entities for @group', [
      '@group' => $group
        ->label(),
    ]);
  }

  /**
   * Provides the group content creation form.
   *
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group to add the group content to.
   * @param string $plugin_id
   *   The group content enabler to add content with.
   *
   * @return array
   *   A group content creation form.
   */
  public function createForm(GroupInterface $group, $plugin_id) {

    /** @var \Drupal\group\Plugin\GroupContentEnablerInterface $plugin */
    $plugin = $group
      ->getGroupType()
      ->getContentPlugin($plugin_id);
    $wizard_id = 'group_entity';
    $store = $this->privateTempStoreFactory
      ->get($wizard_id);
    $store_id = $plugin_id . ':' . $group
      ->id();

    // See if the plugin uses a wizard for creating new entities. Also pass this
    // info to the form state.
    $config = $plugin
      ->getConfiguration();
    $extra['group_wizard'] = $config['use_creation_wizard'];
    $extra['group_wizard_id'] = $wizard_id;

    // Pass the group, plugin ID and store ID to the form state as well.
    $extra['group'] = $group;
    $extra['group_content_enabler'] = $plugin_id;
    $extra['store_id'] = $store_id;

    // See if we are on the second step of the form.
    $step2 = $extra['group_wizard'] && $store
      ->get("{$store_id}:step") === 2;

    // Content entity form, potentially as wizard step 1.
    if (!$step2) {

      // Figure out what entity type the plugin is serving.
      $entity_type_id = $plugin
        ->getEntityTypeId();
      $entity_type = $this
        ->entityTypeManager()
        ->getDefinition($entity_type_id);
      $storage = $this
        ->entityTypeManager()
        ->getStorage($entity_type_id);

      // Only create a new entity if we have nothing stored.
      if (!($entity = $store
        ->get("{$store_id}:entity"))) {
        $values = [];
        if (($key = $entity_type
          ->getKey('bundle')) && ($bundle = $plugin
          ->getEntityBundle())) {
          $values[$key] = $bundle;
        }
        $entity = $storage
          ->create($values);
      }

      // Use the add form handler if available.
      $operation = 'default';
      if ($entity_type
        ->getFormClass('add')) {
        $operation = 'add';
      }
    }
    else {

      // Create an empty group content entity.
      $values = [
        'type' => $plugin
          ->getContentTypeConfigId(),
        'gid' => $group
          ->id(),
      ];
      $entity = $this
        ->entityTypeManager()
        ->getStorage('group_content')
        ->create($values);

      // Group content entities have an add form handler.
      $operation = 'add';
    }

    // Return the entity form with the configuration gathered above.
    return $this
      ->entityFormBuilder()
      ->getForm($entity, $operation, $extra);
  }

  /**
   * The _title_callback for the entity.group_content.create_form route.
   *
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group to create the group content in.
   * @param string $plugin_id
   *   The group content enabler to create content with.
   *
   * @return string
   *   The page title.
   */
  public function createFormTitle(GroupInterface $group, $plugin_id) {

    /** @var \Drupal\group\Plugin\GroupContentEnablerInterface $plugin */
    $plugin = $group
      ->getGroupType()
      ->getContentPlugin($plugin_id);
    $group_content_type = GroupContentType::load($plugin
      ->getContentTypeConfigId());
    return $this
      ->t('Add @name', [
      '@name' => $group_content_type
        ->label(),
    ]);
  }

}

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::addPage	public	function	Provides the group content creation overview page.	1
GroupContentController::addPageBundleMessage	protected	function	Returns the 'add_bundle_message' string for the add page.
GroupContentController::addPageBundles	protected	function	Retrieves a list of available bundles for the add page.	1
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::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create	1
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.
GroupContentController::__construct	public	function	Constructs a new GroupContentController.	1
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 GroupContentController in Group 8

Hierarchy

File

Namespace

Members

API Navigation