You are here

class AddMembersToGroup in Open Social 10.2.x

Same name and namespace in other branches
  1. 8.9 modules/social_features/social_group/src/Plugin/Action/AddMembersToGroup.php \Drupal\social_group\Plugin\Action\AddMembersToGroup
  2. 8.5 modules/social_features/social_group/src/Plugin/Action/AddMembersToGroup.php \Drupal\social_group\Plugin\Action\AddMembersToGroup
  3. 8.6 modules/social_features/social_group/src/Plugin/Action/AddMembersToGroup.php \Drupal\social_group\Plugin\Action\AddMembersToGroup
  4. 8.7 modules/social_features/social_group/src/Plugin/Action/AddMembersToGroup.php \Drupal\social_group\Plugin\Action\AddMembersToGroup
  5. 8.8 modules/social_features/social_group/src/Plugin/Action/AddMembersToGroup.php \Drupal\social_group\Plugin\Action\AddMembersToGroup
  6. 10.3.x modules/social_features/social_group/src/Plugin/Action/AddMembersToGroup.php \Drupal\social_group\Plugin\Action\AddMembersToGroup
  7. 10.0.x modules/social_features/social_group/src/Plugin/Action/AddMembersToGroup.php \Drupal\social_group\Plugin\Action\AddMembersToGroup
  8. 10.1.x modules/social_features/social_group/src/Plugin/Action/AddMembersToGroup.php \Drupal\social_group\Plugin\Action\AddMembersToGroup

Change group membership role.

Plugin annotation


@Action(
  id = "social_group_add_members_to_group_action",
  label = @Translation("Add members to group"),
  type = "user",
  confirm = TRUE,
)

Hierarchy

Expanded class hierarchy of AddMembersToGroup

File

modules/social_features/social_group/src/Plugin/Action/AddMembersToGroup.php, line 26

Namespace

Drupal\social_group\Plugin\Action
View source
class AddMembersToGroup extends ViewsBulkOperationsActionBase implements ContainerFactoryPluginInterface, PluginFormInterface {

  /**
   * The group storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $storage;

  /**
   * Constructs a ViewsBulkOperationSendEmail object.
   *
   * @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\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->storage = $entity_type_manager
      ->getStorage('group');
  }

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

  /**
   * {@inheritdoc}
   */
  public function execute($entity = NULL) {

    // Load the Group.
    $group = Group::load($this->configuration['groups']);
    if (NULL !== $group) {

      // Check if user already is a member.
      $is_member = $group
        ->getMember($entity);

      // If that is not the case we can add it to the group.
      if (!$is_member) {
        $group
          ->addMember($entity);
        return $this
          ->t('Amount of users added to group');
      }

      // Return this when user is already a member.
      return $this
        ->t('Amount of existing members');
    }

    // Fail safe if something went wrong.
    return $this
      ->t('Amount of users added not added');
  }

  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {

    // There is no permission to check if a user is able to be "added" to a
    // group. Joining doesn't cover it since we also want people to be able
    // to be added to a Secret/Closed group.
    // @todo when Invite people to a group or Add members to a group permission
    // lands add it.
    if ($object instanceof User) {
      $access = AccessResult::allowed();
    }
    else {
      $access = AccessResult::forbidden();
    }
    return $return_as_object ? $access : $access
      ->isAllowed();
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $form['#title'] = $this
      ->formatPlural($this->context['selected_count'], 'Add selected member to a group', 'Add @count selected members to a group');
    $groups = Group::loadMultiple(social_group_get_all_groups());
    $options = [];

    // Grab all the groups, sorted by group type for the select list.
    foreach ($groups as $group) {

      /** @var \Drupal\group\Entity\GroupTypeInterface $group_type */
      $group_type = $group
        ->getGroupType();
      $options[$group_type
        ->label()][$group
        ->id()] = $group
        ->label();
    }
    $markup = $this
      ->formatPlural($this->context['selected_count'], 'Please select the group you want to add the member you have selected to', 'Please select the group you want to add the @count members you have selected to');
    $form['description'] = [
      '#markup' => $markup,
    ];

    // Empty the options so we don't have a massive list of users.
    unset($form['list']);
    $form['groups'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Group'),
      '#options' => $options,
    ];
    $form['actions']['submit']['#value'] = $this
      ->t('Add to Group');
    $form['actions']['submit']['#attributes']['class'] = [
      'button button--primary js-form-submit form-submit btn js-form-submit btn-raised btn-primary waves-effect waves-btn waves-light',
    ];
    $form['actions']['cancel']['#attributes']['class'] = [
      'button button--danger btn btn-flat waves-effect waves-btn',
    ];
    return $form;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AddMembersToGroup::$storage protected property The group storage.
AddMembersToGroup::access public function Checks object access. Overrides ActionInterface::access
AddMembersToGroup::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
AddMembersToGroup::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
AddMembersToGroup::execute public function Executes the plugin. Overrides ExecutableInterface::execute
AddMembersToGroup::__construct public function Constructs a ViewsBulkOperationSendEmail object. Overrides PluginBase::__construct
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
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 2
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.
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.
ViewsBulkOperationsActionBase::$configuration protected property Configuration array. Overrides PluginBase::$configuration
ViewsBulkOperationsActionBase::$context protected property Action context.
ViewsBulkOperationsActionBase::$view protected property The processed view.
ViewsBulkOperationsActionBase::customAccess public static function Default custom access callback.
ViewsBulkOperationsActionBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
ViewsBulkOperationsActionBase::executeMultiple public function Execute action on multiple entities. Overrides ActionBase::executeMultiple 1
ViewsBulkOperationsActionBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ViewsBulkOperationsActionBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ViewsBulkOperationsActionBase::setContext public function Set action context. Overrides ViewsBulkOperationsActionInterface::setContext
ViewsBulkOperationsActionBase::setView public function Set view object. Overrides ViewsBulkOperationsActionInterface::setView
ViewsBulkOperationsActionBase::submitConfigurationForm public function Default configuration form submit handler. 1
ViewsBulkOperationsActionBase::validateConfigurationForm public function Default configuration form validator.
ViewsBulkOperationsActionCompletedTrait::finished public static function Batch finished callback. 1
ViewsBulkOperationsActionCompletedTrait::message public static function Set message function wrapper. 1
ViewsBulkOperationsActionCompletedTrait::translate public static function Translation function wrapper. 1