abstract class ChangeMultipleOgMembershipRolesBase in Organic groups 8

Provides a base class for actions that change multiple roles at once.

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\og\Plugin\Action\ChangeMultipleOgMembershipRolesBase implements ContainerFactoryPluginInterface

File

src/Plugin/Action/ChangeMultipleOgMembershipRolesBase.php, line 18

Namespace

Drupal\og\Plugin\Action

abstract class ChangeMultipleOgMembershipRolesBase extends ActionBase implements ContainerFactoryPluginInterface {

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

  /**
   * The private temporary storage.
   *
   * @var \Drupal\Core\TempStore\PrivateTempStore
   */
  protected $tempStore;

  /**
   * Constructs a new RemoveMultipleOgMembershipRoles 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\og\OgAccessInterface $og_access
   *   The OG access service.
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
   *   The private temporary storage factory.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, OgAccessInterface $og_access, PrivateTempStoreFactory $temp_store_factory) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->ogAccess = $og_access;
    $this->tempStore = $temp_store_factory
      ->get($plugin_id);
  }

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

  /**
   * {@inheritdoc}
   */
  public function executeMultiple(array $memberships) {

    // Store the memberships to be processed in temporary storage. The actual
    // processing will be handled in the confirmation form.
    // @see \Drupal\og\Form\OgAddMultipleRolesForm
    // @see \Drupal\og\Form\OgRemoveMultipleRolesForm
    $membership_ids = array_map(function (OgMembershipInterface $membership) {
      return $membership
        ->id();
    }, $memberships);
    $this->tempStore
      ->set('membership_ids', $membership_ids);
  }

  /**
   * {@inheritdoc}
   */
  public function execute($object = NULL) {
    $this
      ->executeMultiple([
      $object,
    ]);
  }

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

    /** @var \Drupal\og\Entity\OgMembership $object */

    // Only grant access if the user has permission to manage members in this
    // group.
    $access = $this->ogAccess
      ->userAccess($object
      ->getGroup(), 'manage members', $account);
    return $return_as_object ? $access : $access
      ->isAllowed();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ChangeMultipleOgMembershipRolesBase::$ogAccess	protected	property	The OG access service.
ChangeMultipleOgMembershipRolesBase::$tempStore	protected	property	The private temporary storage.
ChangeMultipleOgMembershipRolesBase::access	public	function	Checks object access. Overrides ActionInterface::access
ChangeMultipleOgMembershipRolesBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ChangeMultipleOgMembershipRolesBase::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
ChangeMultipleOgMembershipRolesBase::executeMultiple	public	function	Executes the plugin for an array of objects. Overrides ActionBase::executeMultiple
ChangeMultipleOgMembershipRolesBase::__construct	public	function	Constructs a new RemoveMultipleOgMembershipRoles object. Overrides PluginBase::__construct
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
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
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	3
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.	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.