class ChangeGroupMembershipRole in Open Social 10.3.x

Change group membership role.

Plugin annotation

@Action(
  id = "social_group_change_member_role_action",
  label = @Translation("Change group membership role"),
  type = "group_content",
  confirm = TRUE,
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\Core\Action\ActionBase implements ActionInterface
      • class \Drupal\views_bulk_operations\Action\ViewsBulkOperationsActionBase implements ConfigurableInterface, ViewsBulkOperationsActionInterface uses ViewsBulkOperationsActionCompletedTrait
        • class \Drupal\social_group\Plugin\Action\ChangeGroupMembershipRole implements ContainerFactoryPluginInterface, PluginFormInterface

File

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

Namespace

Drupal\social_group\Plugin\Action

class ChangeGroupMembershipRole extends ViewsBulkOperationsActionBase implements ContainerFactoryPluginInterface, PluginFormInterface {

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

  /**
   * The currently active route match object.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

  /**
   * 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.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The currently active route match object.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityTypeManagerInterface $entity_type_manager, RouteMatchInterface $route_match) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->storage = $entity_type_manager
      ->getStorage('group');
    $this->routeMatch = $route_match;
  }

  /**
   * {@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'), $container
      ->get('current_route_match'));
  }

  /**
   * {@inheritdoc}
   */
  public function execute($entity = NULL) {
    $role = $this->configuration['role'];
    $is_member = $this->configuration['is_member'];
    $update = TRUE;
    $value = [];

    /** @var \Drupal\group\Entity\GroupContentInterface $entity */

    /** @var \Drupal\Core\Field\EntityReferenceFieldItemListInterface $roles */
    $roles =& $entity
      ->get('group_roles');
    if ($roles
      ->isEmpty() && $is_member) {
      $update = FALSE;
    }
    elseif (!$roles
      ->isEmpty() && !$is_member) {
      $value = $roles
        ->getValue();
      foreach ($value as $item) {
        if ($item['target_id'] === $role) {
          $update = FALSE;
          break;
        }
      }
    }
    if ($update) {
      if (!$is_member) {
        $value[] = [
          'target_id' => $role,
        ];
      }
      $entity
        ->set('group_roles', $value)
        ->save();
    }
    return $this
      ->t('Change roles');
  }

  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
    if ($object instanceof GroupContentInterface && $object
      ->getContentPlugin()
      ->getPluginId() === 'group_membership') {
      $access = $object
        ->access('update', $account, TRUE);
    }
    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'], 'Change the role of selected member', 'Change the role of @count selected members');
    $id = $this->routeMatch
      ->getRawParameter('group');

    /** @var \Drupal\group\Entity\GroupTypeInterface $group_type */
    $group_type = $this->storage
      ->load($id)
      ->getGroupType();
    $roles = $group_type
      ->getRoles(FALSE);
    $id = $group_type
      ->getMemberRoleId();
    $roles[$id] = $group_type
      ->getMemberRole();
    $markup = $this
      ->formatPlural($this->context['selected_count'], 'Choose which group roles to assign to the member you selected', 'Choose which group roles to assign to the @count members you selected');
    $form['description'] = [
      '#markup' => $markup,
    ];
    $form_state
      ->set('member_role', $id);

    /** @var \Drupal\group\Entity\GroupRoleInterface $role */
    foreach ($roles as &$role) {
      $role = $role
        ->label();
    }
    $form['role'] = [
      '#type' => 'radios',
      '#title' => $this
        ->t('Group roles'),
      '#options' => $roles,
      '#default_value' => $id,
    ];
    unset($form['list']);
    $form['actions']['submit']['#value'] = $this
      ->t('Change role');
    $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;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    parent::submitConfigurationForm($form, $form_state);
    $this->configuration['is_member'] = $this->configuration['role'] === $form_state
      ->get('member_role');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ChangeGroupMembershipRole::$routeMatch	protected	property	The currently active route match object.
ChangeGroupMembershipRole::$storage	protected	property	The group storage.
ChangeGroupMembershipRole::access	public	function	Checks object access. Overrides ActionInterface::access
ChangeGroupMembershipRole::buildConfigurationForm	public	function	Form constructor. Overrides PluginFormInterface::buildConfigurationForm
ChangeGroupMembershipRole::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ChangeGroupMembershipRole::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
ChangeGroupMembershipRole::submitConfigurationForm	public	function	Default configuration form submit handler. Overrides ViewsBulkOperationsActionBase::submitConfigurationForm
ChangeGroupMembershipRole::__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::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