class OgChangeMultipleRolesFormBase in Organic groups 8

Base class for forms that act on multiple roles.

View source

class OgChangeMultipleRolesFormBase extends FormBase {

  /**
   * The action plugin ID for which this is the confirmation form.
   *
   * @var string
   */
  protected $pluginId;

  /**
   * The memberships on which roles should be changed.
   *
   * @var \Drupal\og\OgMembershipInterface[]
   */
  protected $memberships = [];

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

  /**
   * The temporary storage for the current user.
   *
   * @var \Drupal\Core\TempStore\PrivateTempStore
   */
  protected $tempStore;

  /**
   * The OG access service.
   *
   * @var \Drupal\og\OgAccessInterface
   */
  protected $ogAccess;

  /**
   * Constructs a OgChangeMultipleRolesFormbase object.
   *
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
   *   The tempstore factory.
   * @param \Drupal\og\OgAccessInterface $og_access
   *   The OG access service.
   */
  public function __construct(PrivateTempStoreFactory $temp_store_factory, OgAccessInterface $og_access) {
    $this->tempStoreFactory = $temp_store_factory;
    $this->ogAccess = $og_access;
  }

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

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return $this->pluginId . '_form';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Submit'),
    ];
    return $form;
  }

  /**
   * {@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()) {
          if ($membership
            ->hasRole($role
            ->id())) {
            $changed = TRUE;
            $membership
              ->revokeRole($role);
          }
        }
      }

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

  /**
   * Controls access to the form.
   *
   * @param \Drupal\Core\Session\AccountInterface $account
   *   The account for which to check access.
   *
   * @return \Drupal\Core\Access\AccessResult
   *   The access result.
   */
  public function access(AccountInterface $account) {

    // Only grant access to the form if there are memberships to process, and if
    // the user has permission to manage members on all the memberships.
    $memberships = $this
      ->getMemberships();
    $access = AccessResult::allowedIf(!empty($memberships));
    while ($access
      ->isAllowed() && ($membership = array_shift($memberships))) {
      $access = $this->ogAccess
        ->userAccess($membership
        ->getGroup(), 'manage members', $account);
    }
    return $access;
  }

  /**
   * Returns the temporary storage for the current user.
   *
   * @return \Drupal\Core\TempStore\PrivateTempStore
   *   The temporary storage for the current user.
   */
  protected function getTempStore() {
    if (empty($this->tempStore)) {
      $this->tempStore = $this->tempStoreFactory
        ->get($this->pluginId);
    }
    return $this->tempStore;
  }

  /**
   * Returns an array of memberships on which to change roles.
   *
   * @return \Drupal\og\OgMembershipInterface[]
   *   The array of memberships.
   */
  protected function getMemberships() {
    if (empty($this->memberships)) {
      $membership_ids = $this
        ->getTempStore()
        ->get('membership_ids');
      if (!empty($membership_ids)) {
        $this->memberships = OgMembership::loadMultiple($membership_ids);
      }
    }
    return $this->memberships;
  }

  /**
   * Returns an array of group types for which memberships are present.
   *
   * @return array
   *   An array of group types, each value an array with two keys:
   *   - entity_type_id: The entity type ID of the group type.
   *   - bundle_id: The bundle ID of the group type.
   */
  protected function getGroupTypes() {
    $group_types = [];
    foreach ($this
      ->getMemberships() as $membership) {
      $group = $membership
        ->getGroup();
      $key = implode('-', [
        $group
          ->getEntityTypeId(),
        $group
          ->bundle(),
      ]);
      $group_types[$key] = [
        'entity_type_id' => $group
          ->getEntityTypeId(),
        'bundle_id' => $group
          ->bundle(),
      ];
    }
    return $group_types;
  }

}

Members

Name	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.
OgChangeMultipleRolesFormBase::$memberships	protected	property	The memberships on which roles should be changed.
OgChangeMultipleRolesFormBase::$ogAccess	protected	property	The OG access service.
OgChangeMultipleRolesFormBase::$pluginId	protected	property	The action plugin ID for which this is the confirmation form.	2
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::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm	2
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::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm	2
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.

You are here

class OgChangeMultipleRolesFormBase in Organic groups 8

Hierarchy

File

Namespace

Members

API Navigation