You are here

class SocialBlockUser in Open Social 8

Same name and namespace in other branches
  1. 8.9 modules/social_features/social_user/src/Plugin/Action/SocialBlockUser.php \Drupal\social_user\Plugin\Action\SocialBlockUser
  2. 8.2 modules/social_features/social_user/src/Plugin/Action/SocialBlockUser.php \Drupal\social_user\Plugin\Action\SocialBlockUser
  3. 8.3 modules/social_features/social_user/src/Plugin/Action/SocialBlockUser.php \Drupal\social_user\Plugin\Action\SocialBlockUser
  4. 8.4 modules/social_features/social_user/src/Plugin/Action/SocialBlockUser.php \Drupal\social_user\Plugin\Action\SocialBlockUser
  5. 8.5 modules/social_features/social_user/src/Plugin/Action/SocialBlockUser.php \Drupal\social_user\Plugin\Action\SocialBlockUser
  6. 8.6 modules/social_features/social_user/src/Plugin/Action/SocialBlockUser.php \Drupal\social_user\Plugin\Action\SocialBlockUser
  7. 8.7 modules/social_features/social_user/src/Plugin/Action/SocialBlockUser.php \Drupal\social_user\Plugin\Action\SocialBlockUser
  8. 8.8 modules/social_features/social_user/src/Plugin/Action/SocialBlockUser.php \Drupal\social_user\Plugin\Action\SocialBlockUser
  9. 10.3.x modules/social_features/social_user/src/Plugin/Action/SocialBlockUser.php \Drupal\social_user\Plugin\Action\SocialBlockUser
  10. 10.0.x modules/social_features/social_user/src/Plugin/Action/SocialBlockUser.php \Drupal\social_user\Plugin\Action\SocialBlockUser
  11. 10.1.x modules/social_features/social_user/src/Plugin/Action/SocialBlockUser.php \Drupal\social_user\Plugin\Action\SocialBlockUser
  12. 10.2.x modules/social_features/social_user/src/Plugin/Action/SocialBlockUser.php \Drupal\social_user\Plugin\Action\SocialBlockUser

Alternate action plugin that can block users.

Adds new checking based on permissions.

Hierarchy

Expanded class hierarchy of SocialBlockUser

See also

\Drupal\user\Plugin\Action\BlockUser

1 file declares its use of SocialBlockUser
social_user.module in modules/social_features/social_user/social_user.module
The social user module alterations.

File

modules/social_features/social_user/src/Plugin/Action/SocialBlockUser.php, line 16

Namespace

Drupal\social_user\Plugin\Action
View source
class SocialBlockUser extends ActionBase {

  /**
   * {@inheritdoc}
   */
  public function execute($account = NULL) {

    // Skip blocking user if they are already blocked.
    if ($account !== FALSE && $account
      ->isActive()) {

      // For efficiency manually save the original account before applying any
      // changes.
      $account->original = clone $account;
      $account
        ->block();
      $account
        ->save();
    }
  }

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

    /** @var \Drupal\user\UserInterface $object */
    $access = $object->status
      ->access('edit', $account, TRUE)
      ->andIf($object
      ->access('update', $account, TRUE));
    return $return_as_object ? $access : $access
      ->isAllowed() | AccessResult::allowedIf($account
      ->hasPermission('block users'));
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ActionBase::executeMultiple public function Executes the plugin for an array of objects. Overrides ActionInterface::executeMultiple 3
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.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
SocialBlockUser::access public function Checks object access. Overrides ActionInterface::access
SocialBlockUser::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.