class BlockOgMembership in Organic groups 8

Blocks a group membership.

Plugin annotation

@Action(
  id = "og_membership_block_action",
  label = @Translation("Block the selected membership(s)"),
  type = "og_membership"
)

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\ChangeOgMembershipStateBase implements ContainerFactoryPluginInterface
        • class \Drupal\og\Plugin\Action\BlockOgMembership

File

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

Namespace

Drupal\og\Plugin\Action

class BlockOgMembership extends ChangeOgMembershipStateBase {

  /**
   * {@inheritdoc}
   */
  public function getTargetState() {
    return OgMembershipInterface::STATE_BLOCKED;
  }

  /**
   * {@inheritdoc}
   */
  public function getOriginalState() {
    return NULL;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ActionBase::executeMultiple	public	function	Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple	3
BlockOgMembership::getOriginalState	public	function	Returns the state the membership should have for the action to be executed. Overrides ChangeOgMembershipStateBase::getOriginalState
BlockOgMembership::getTargetState	public	function	Returns the state the membership will have after the action is executed. Overrides ChangeOgMembershipStateBase::getTargetState
ChangeOgMembershipStateBase::$ogAccess	protected	property	The OG access service.
ChangeOgMembershipStateBase::access	public	function	Checks object access. Overrides ActionInterface::access
ChangeOgMembershipStateBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ChangeOgMembershipStateBase::execute	public	function	Executes the plugin. Overrides ExecutableInterface::execute
ChangeOgMembershipStateBase::__construct	public	function	Constructs an ApprovePendingOgMembership 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.