class SocialGroupController in Open Social 10.1.x

Returns responses for Social Group routes.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\social_group\Controller\SocialGroupController uses ViewsBulkOperationsFormTrait

1 file declares its use of SocialGroupController

social_group.module in modules/social_features/social_group/social_group.module

The Social group module.

File

modules/social_features/social_group/src/Controller/SocialGroupController.php, line 22

Namespace

Drupal\social_group\Controller

class SocialGroupController extends ControllerBase {
  use ViewsBulkOperationsFormTrait;

  /**
   * The tempstore service.
   *
   * @var \Drupal\Core\TempStore\PrivateTempStoreFactory
   */
  protected $tempStoreFactory;

  /**
   * Views Bulk Operations action processor.
   *
   * @var \Drupal\views_bulk_operations\Service\ViewsBulkOperationsActionProcessorInterface
   */
  protected $actionProcessor;

  /**
   * The request.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * SocialGroupController constructor.
   *
   * @param \Symfony\Component\HttpFoundation\RequestStack $requestStack
   *   The request stack.
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $tempStoreFactory
   *   Private temporary storage factory.
   * @param \Drupal\views_bulk_operations\Service\ViewsBulkOperationsActionProcessorInterface $actionProcessor
   *   Views Bulk Operations action processor.
   */
  public function __construct(RequestStack $requestStack, PrivateTempStoreFactory $tempStoreFactory, ViewsBulkOperationsActionProcessorInterface $actionProcessor) {
    $this->requestStack = $requestStack;
    $this->tempStoreFactory = $tempStoreFactory;
    $this->actionProcessor = $actionProcessor;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('request_stack'), $container
      ->get('tempstore.private'), $container
      ->get('views_bulk_operations.processor'));
  }

  /**
   * The _title_callback for the view.group_members.page_group_members route.
   *
   * @param object $group
   *   The group ID.
   *
   * @return string
   *   The page title.
   */
  public function groupMembersTitle($group) {

    // If it's not a group then it's a gid.
    if (!$group instanceof Group) {
      $group = Group::load($group);
    }
    return $this
      ->t('Members of @name', [
      '@name' => $group
        ->label(),
    ]);
  }

  /**
   * The _title_callback for the view.posts.block_stream_group route.
   *
   * @param object $group
   *   The group ID.
   *
   * @return string
   *   The page title.
   */
  public function groupStreamTitle($group) {
    $group_label = $group
      ->label();
    return $group_label;
  }

  /**
   * Callback function of the stream page of a group.
   *
   * @return array
   *   A renderable array.
   */
  public function groupStream() {
    return [
      '#markup' => '',
    ];
  }

  /**
   * The title callback for the entity.group_content.add_form.
   *
   * @return string
   *   The page title.
   */
  public function groupAddMemberTitle() {
    $group_content = \Drupal::routeMatch()
      ->getParameter('group_content');
    $group = \Drupal::routeMatch()
      ->getParameter('group');
    if ($group_content instanceof GroupContent && $group_content
      ->getGroupContentType()
      ->getContentPluginId() === 'group_invitation') {
      if ($group instanceof GroupInterface) {
        return $this
          ->t('Add invites to group: @group_name', [
          '@group_name' => $group
            ->label(),
        ]);
      }
      return $this
        ->t('Add invites');
    }
    if ($group instanceof GroupInterface) {
      return $this
        ->t('Add members to group: @group_name', [
        '@group_name' => $group
          ->label(),
      ]);
    }
    return $this
      ->t('Add members');
  }

  /**
   * The title callback for the entity.group_content.delete-form.
   *
   * @return string
   *   The page title.
   */
  public function groupRemoveContentTitle($group) {
    $group_content = \Drupal::routeMatch()
      ->getParameter('group_content');
    if ($group_content instanceof GroupContent && $group_content
      ->getGroupContentType()
      ->getContentPluginId() === 'group_invitation') {
      $group = \Drupal::routeMatch()
        ->getParameter('group');
      if ($group instanceof GroupInterface) {
        return $this
          ->t('Remove invitee from group: @group_name', [
          '@group_name' => $group
            ->label(),
        ]);
      }
      return $this
        ->t('Remove invitation');
    }
    return $this
      ->t('Remove a member');
  }

  /**
   * Function that checks access on the my groups pages.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The account we need to check access for.
   *
   * @return \Drupal\Core\Access\AccessResult
   *   If access is allowed.
   */
  public function myGroupAccess(AccountInterface $account) {

    // Fetch user from url.
    $user = $this->requestStack
      ->getCurrentRequest()
      ->get('user');

    // If we don't have a user in the request, assume it's my own profile.
    if (is_null($user)) {

      // Usecase is the user menu, which is generated on all LU pages.
      $user = User::load($account
        ->id());
    }

    // If not a user then just return neutral.
    if (!$user instanceof User) {
      $user = User::load($user);
      if (!$user instanceof User) {
        return AccessResult::neutral();
      }
    }
    if ($user
      ->isBlocked()) {
      return AccessResult::allowedIfHasPermission($account, 'view blocked user');
    }

    // Own profile?
    if ($user
      ->id() === $account
      ->id()) {
      return AccessResult::allowedIfHasPermission($account, 'view groups on my profile');
    }
    return AccessResult::allowedIfHasPermission($account, 'view groups on other profiles');
  }

  /**
   * Redirects users to their groups page.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   Returns a redirect to the groups of the currently logged in user.
   */
  public function redirectMyGroups() {
    return $this
      ->redirect('view.groups.page_user_groups', [
      'user' => $this
        ->currentUser()
        ->id(),
    ]);
  }

  /**
   * OtherGroupPage.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   Return Redirect to the group account.
   */
  public function otherGroupPage($group) {
    return $this
      ->redirect('entity.group.canonical', [
      'group' => $group,
    ]);
  }

  /**
   * 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());

    // The node_types that have a different article than a.
    $node_types = [
      'event' => 'an',
    ];

    // Make sure extensions can change this as well.
    \Drupal::moduleHandler()
      ->alter('social_node_title_prefix_articles', $node_types);
    if ($group_content_type !== NULL && array_key_exists($group_content_type
      ->label(), $node_types)) {
      return $this
        ->t('Create @article @name', [
        '@article' => $node_types[$group_content_type
          ->label()],
        '@name' => $group_content_type
          ->label(),
      ]);
    }
    return $this
      ->t('Create a @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::$entityFormBuilder	protected	property	The entity form builder.
ControllerBase::$entityTypeManager	protected	property	The entity type 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::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.
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.
SocialGroupController::$actionProcessor	protected	property	Views Bulk Operations action processor.
SocialGroupController::$requestStack	protected	property	The request.
SocialGroupController::$tempStoreFactory	protected	property	The tempstore service.
SocialGroupController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
SocialGroupController::createFormTitle	public	function	The _title_callback for the entity.group_content.create_form route.
SocialGroupController::groupAddMemberTitle	public	function	The title callback for the entity.group_content.add_form.
SocialGroupController::groupMembersTitle	public	function	The _title_callback for the view.group_members.page_group_members route.
SocialGroupController::groupRemoveContentTitle	public	function	The title callback for the entity.group_content.delete-form.
SocialGroupController::groupStream	public	function	Callback function of the stream page of a group.
SocialGroupController::groupStreamTitle	public	function	The _title_callback for the view.posts.block_stream_group route.
SocialGroupController::myGroupAccess	public	function	Function that checks access on the my groups pages.
SocialGroupController::otherGroupPage	public	function	OtherGroupPage.
SocialGroupController::redirectMyGroups	public	function	Redirects users to their groups page.
SocialGroupController::__construct	public	function	SocialGroupController constructor.
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.
ViewsBulkOperationsFormTrait::$tempStoreName	protected	property	The tempstore name.
ViewsBulkOperationsFormTrait::$viewTempstore	protected	property	The tempstore object associated with the current view.
ViewsBulkOperationsFormTrait::addCancelButton	protected	function	Add a cancel button into a VBO form.
ViewsBulkOperationsFormTrait::addListData	protected	function	Add data needed for entity list rendering.
ViewsBulkOperationsFormTrait::calculateEntityBulkFormKey	public static	function	Calculates the bulk form key for an entity.
ViewsBulkOperationsFormTrait::cancelForm	public	function	Submit callback to cancel an action and return to the view.
ViewsBulkOperationsFormTrait::deleteTempstoreData	protected	function	Deletes the current view user tempstore data.
ViewsBulkOperationsFormTrait::getFormData	protected	function	Helper function to prepare data needed for proper form display.
ViewsBulkOperationsFormTrait::getListItem	protected	function	Get an entity list item from a bulk form key.
ViewsBulkOperationsFormTrait::getListRenderable	protected	function	Build selected entities list renderable.
ViewsBulkOperationsFormTrait::getMultipageList	protected	function	Build the selection info element.
ViewsBulkOperationsFormTrait::getSelectionInfoTitle	protected	function	Get the selection info title.
ViewsBulkOperationsFormTrait::getTempstore	protected	function	Initialize the current view tempstore object.
ViewsBulkOperationsFormTrait::getTempstoreData	protected	function	Gets the current view user tempstore data.
ViewsBulkOperationsFormTrait::setTempstoreData	protected	function	Sets the current view user tempstore data.