You are here

class ExportMember in Open Social 10.1.x

Same name and namespace in other branches
  1. 8.9 modules/social_features/social_group/modules/social_group_members_export/src/Plugin/Action/ExportMember.php \Drupal\social_group_members_export\Plugin\Action\ExportMember
  2. 8.5 modules/social_features/social_group/modules/social_group_members_export/src/Plugin/Action/ExportMember.php \Drupal\social_group_members_export\Plugin\Action\ExportMember
  3. 8.6 modules/social_features/social_group/modules/social_group_members_export/src/Plugin/Action/ExportMember.php \Drupal\social_group_members_export\Plugin\Action\ExportMember
  4. 8.7 modules/social_features/social_group/modules/social_group_members_export/src/Plugin/Action/ExportMember.php \Drupal\social_group_members_export\Plugin\Action\ExportMember
  5. 8.8 modules/social_features/social_group/modules/social_group_members_export/src/Plugin/Action/ExportMember.php \Drupal\social_group_members_export\Plugin\Action\ExportMember
  6. 10.3.x modules/social_features/social_group/modules/social_group_members_export/src/Plugin/Action/ExportMember.php \Drupal\social_group_members_export\Plugin\Action\ExportMember
  7. 10.0.x modules/social_features/social_group/modules/social_group_members_export/src/Plugin/Action/ExportMember.php \Drupal\social_group_members_export\Plugin\Action\ExportMember
  8. 10.2.x modules/social_features/social_group/modules/social_group_members_export/src/Plugin/Action/ExportMember.php \Drupal\social_group_members_export\Plugin\Action\ExportMember

Exports a group member accounts to CSV.

Plugin annotation


@Action(
  id = "social_group_members_export_member_action",
  label = @Translation("Export the selected members to CSV"),
  type = "group_content",
  confirm = TRUE,
)

Hierarchy

Expanded class hierarchy of ExportMember

File

modules/social_features/social_group/modules/social_group_members_export/src/Plugin/Action/ExportMember.php, line 20

Namespace

Drupal\social_group_members_export\Plugin\Action
View source
class ExportMember extends ExportUser {

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

    /** @var \Drupal\group\Entity\GroupContentInterface $entity */
    foreach ($entities as &$entity) {
      $entity = $entity
        ->getEntity();
    }
    parent::executeMultiple($entities);
  }

  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
    if ($object instanceof GroupContentInterface && $object
      ->getContentPlugin()
      ->getPluginId() === 'group_membership') {
      $access = $object
        ->getEntity()
        ->access('view', $account, TRUE);
    }
    else {
      $access = AccessResult::forbidden();
    }
    return $return_as_object ? $access : $access
      ->isAllowed();
  }

  /**
   * {@inheritdoc}
   *
   * To make sure the file can be downloaded, the path must be declared in the
   * download pattern of the social user export module.
   *
   * @see social_user_export_file_download()
   */
  protected function generateFilePath() : string {
    $hash = md5(microtime(TRUE));
    return 'export-members-' . substr($hash, 20, 12) . '.csv';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
ExportMember::access public function Checks object access. Overrides ExportUser::access
ExportMember::executeMultiple public function Execute action on multiple entities. Overrides ExportUser::executeMultiple
ExportMember::generateFilePath protected function To make sure the file can be downloaded, the path must be declared in the download pattern of the social user export module. Overrides ExportUser::generateFilePath
ExportUser::$config protected property The user export plugin config object.
ExportUser::$currentUser protected property The current user account.
ExportUser::$logger protected property A logger instance.
ExportUser::$pluginDefinitions protected property User export plugin definitions.
ExportUser::$userExportPlugin protected property The User export plugin manager.
ExportUser::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm
ExportUser::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
ExportUser::execute public function Executes the plugin. Overrides ExecutableInterface::execute
ExportUser::getBaseOutputDirectory protected function Returns the directory that forms the base for this exports file output.
ExportUser::getPluginConfiguration public function Gets export plugin's configuration. 1
ExportUser::pluginAccess protected function Check the access of export plugins based on config and permission.
ExportUser::sortDefinitions protected function Order by weight.
ExportUser::__construct public function Constructs a ExportUser object. Overrides PluginBase::__construct 1
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
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 2
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. 4
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.
ViewsBulkOperationsActionBase::$configuration protected property Configuration array. Overrides PluginBase::$configuration
ViewsBulkOperationsActionBase::$context protected property Action context.
ViewsBulkOperationsActionBase::$view protected property The processed view.
ViewsBulkOperationsActionBase::customAccess public static function Default custom access callback.
ViewsBulkOperationsActionBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
ViewsBulkOperationsActionBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
ViewsBulkOperationsActionBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
ViewsBulkOperationsActionBase::setContext public function Set action context. Overrides ViewsBulkOperationsActionInterface::setContext
ViewsBulkOperationsActionBase::setView public function Set view object. Overrides ViewsBulkOperationsActionInterface::setView
ViewsBulkOperationsActionBase::submitConfigurationForm public function Default configuration form submit handler. 1
ViewsBulkOperationsActionBase::validateConfigurationForm public function Default configuration form validator.
ViewsBulkOperationsActionCompletedTrait::finished public static function Batch finished callback. 1
ViewsBulkOperationsActionCompletedTrait::message public static function Set message function wrapper. 1
ViewsBulkOperationsActionCompletedTrait::translate public static function Translation function wrapper. 1