You are here

class RemoveSingleOgMembershipRole in Organic groups 8

Removes a role from a group membership.

Plugin annotation


@Action(
  id = "og_membership_remove_single_role_action",
  label = @Translation("Remove a role from the selected members"),
  type = "og_membership"
)

Hierarchy

Expanded class hierarchy of RemoveSingleOgMembershipRole

File

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

Namespace

Drupal\og\Plugin\Action
View source
class RemoveSingleOgMembershipRole extends ChangeSingleOgMembershipRoleBase {

  /**
   * {@inheritdoc}
   */
  public function execute(?OgMembership $membership = NULL) {
    if (!$membership) {
      return;
    }
    $role_name = $this->configuration['role_name'];
    $role_id = implode('-', [
      $membership
        ->getGroupEntityType(),
      $membership
        ->getGroupBundle(),
      $role_name,
    ]);

    // Skip removing the role from the membership if it doesn't have it.
    if (in_array($role_id, $membership
      ->getRolesIds())) {
      $membership
        ->revokeRoleById($role_id)
        ->save();
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ActionBase::executeMultiple public function Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple 3
ChangeSingleOgMembershipRoleBase::$entityType protected property The OG role entity type.
ChangeSingleOgMembershipRoleBase::$ogAccess protected property The OG access service.
ChangeSingleOgMembershipRoleBase::access public function Checks object access. Overrides ActionInterface::access
ChangeSingleOgMembershipRoleBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
ChangeSingleOgMembershipRoleBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ChangeSingleOgMembershipRoleBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableActionBase::defaultConfiguration
ChangeSingleOgMembershipRoleBase::getOgRoleLabels protected function Returns a list of OgRole labels.
ChangeSingleOgMembershipRoleBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
ChangeSingleOgMembershipRoleBase::__construct public function Constructs a ChangeSingleOgMembershipRoleBase object. Overrides ConfigurableActionBase::__construct
ConfigurableActionBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies 1
ConfigurableActionBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ConfigurableActionBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ConfigurableActionBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm 2
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
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
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.
RemoveSingleOgMembershipRole::execute public function Executes the plugin. Overrides ExecutableInterface::execute
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.