abstract class ChangeOgMembershipStateBase in Organic groups 8

Base class for actions that change the state of a 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

File

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

Namespace

Drupal\og\Plugin\Action

abstract class ChangeOgMembershipStateBase extends ActionBase implements ContainerFactoryPluginInterface {

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

  /**
   * Constructs an ApprovePendingOgMembership 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.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, OgAccessInterface $og_access) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->ogAccess = $og_access;
  }

  /**
   * {@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'));
  }

  /**
   * {@inheritdoc}
   */
  public function execute(?OgMembership $membership = NULL) {
    if (!$membership) {
      return;
    }
    $membership
      ->setState($this
      ->getTargetState())
      ->save();
  }

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

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

    // Deny access if the membership is not in the required state.
    $original_state = $this
      ->getOriginalState();
    if ($original_state && $object
      ->getState() !== $original_state) {
      $access = AccessResult::forbidden();
    }
    elseif ($object
      ->getState() === $this
      ->getTargetState()) {
      $access = AccessResult::forbidden();
    }
    elseif ($object
      ->isOwner()) {
      $access = AccessResult::forbidden();
    }
    else {
      $access = $this->ogAccess
        ->userAccess($object
        ->getGroup(), 'manage members', $account);
    }
    return $return_as_object ? $access : $access
      ->isAllowed();
  }

  /**
   * Returns the state the membership will have after the action is executed.
   *
   * @return string
   *   One of the following:
   *   - Drupal\og\OgMembershipInterface::STATE_ACTIVE
   *   - Drupal\og\OgMembershipInterface::STATE_PENDING
   *   - Drupal\og\OgMembershipInterface::STATE_BLOCKED
   */
  public abstract function getTargetState();

  /**
   * Returns the state the membership should have for the action to be executed.
   *
   * @return string|null
   *   Either NULL if the action does not require the membership to be in a
   *   particular state for the action to be executed, or one of the following:
   *   - Drupal\og\OgMembershipInterface::STATE_ACTIVE
   *   - Drupal\og\OgMembershipInterface::STATE_PENDING
   *   - Drupal\og\OgMembershipInterface::STATE_BLOCKED
   */
  public abstract function getOriginalState();

}

Members

Name	Modifiers	Type	Description	Overrides
ActionBase::executeMultiple	public	function	Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple	3
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::getOriginalState	abstract public	function	Returns the state the membership should have for the action to be executed.	3
ChangeOgMembershipStateBase::getTargetState	abstract public	function	Returns the state the membership will have after the action is executed.	3
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.