You are here

class OgAddMultipleRolesForm in Organic groups 8

Provides a form to add multiple OG roles to a membership.

Hierarchy

Expanded class hierarchy of OgAddMultipleRolesForm

See also

\Drupal\og\Plugin\Action\AddMultipleOgMembershipRoles

1 string reference to 'OgAddMultipleRolesForm'
og.routing.yml in ./og.routing.yml
og.routing.yml

File

src/Form/OgAddMultipleRolesForm.php, line 15

Namespace

Drupal\og\Form
View source
class OgAddMultipleRolesForm extends OgChangeMultipleRolesFormBase {

  /**
   * {@inheritdoc}
   */
  protected $pluginId = 'og_membership_add_multiple_roles_action';

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $options = [];
    foreach ($this
      ->getGroupTypes() as $group_type) {

      /** @var \Drupal\og\OgRoleInterface $role */
      foreach (OgRole::loadByGroupType($group_type['entity_type_id'], $group_type['bundle_id']) as $role) {

        // Only add the role to the list if it is not a required role, these
        // cannot be added.
        if (!$role
          ->isRequired()) {
          $options[$role
            ->id()] = $role
            ->label();
        }
      }
    }
    $form['roles'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Add roles'),
      '#multiple' => TRUE,
      '#required' => TRUE,
      '#options' => $options,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $role_ids = array_keys($form_state
      ->getValue('roles'));

    /** @var \Drupal\og\OgRoleInterface[] $roles */
    $roles = OgRole::loadMultiple($role_ids);
    foreach ($this
      ->getMemberships() as $membership) {
      $changed = FALSE;
      foreach ($roles as $role) {
        $group = $membership
          ->getGroup();
        if ($group
          ->getEntityTypeId() === $role
          ->getGroupType() && $group
          ->bundle() === $role
          ->getGroupBundle()) {

          // Only add the role to the membership if it is valid and doesn't
          // exist yet.
          if ($membership
            ->isRoleValid($role) && !$membership
            ->hasRole($role
            ->id())) {
            $changed = TRUE;
            $membership
              ->addRole($role);
          }
        }
      }

      // Only save the membership if it has actually changed.
      if ($changed) {
        $membership
          ->save();
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
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.
OgAddMultipleRolesForm::$pluginId protected property The action plugin ID for which this is the confirmation form. Overrides OgChangeMultipleRolesFormBase::$pluginId
OgAddMultipleRolesForm::buildForm public function Form constructor. Overrides OgChangeMultipleRolesFormBase::buildForm
OgAddMultipleRolesForm::submitForm public function Form submission handler. Overrides OgChangeMultipleRolesFormBase::submitForm
OgChangeMultipleRolesFormBase::$memberships protected property The memberships on which roles should be changed.
OgChangeMultipleRolesFormBase::$ogAccess protected property The OG access service.
OgChangeMultipleRolesFormBase::$tempStore protected property The temporary storage for the current user.
OgChangeMultipleRolesFormBase::$tempStoreFactory protected property The tempstore factory.
OgChangeMultipleRolesFormBase::access public function Controls access to the form.
OgChangeMultipleRolesFormBase::create public static function Instantiates a new instance of this class. Overrides FormBase::create
OgChangeMultipleRolesFormBase::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
OgChangeMultipleRolesFormBase::getGroupTypes protected function Returns an array of group types for which memberships are present.
OgChangeMultipleRolesFormBase::getMemberships protected function Returns an array of memberships on which to change roles.
OgChangeMultipleRolesFormBase::getTempStore protected function Returns the temporary storage for the current user.
OgChangeMultipleRolesFormBase::__construct public function Constructs a OgChangeMultipleRolesFormbase object.
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.