ExportUser.php in Open Social 8.4
Same filename in this branch
Same filename and directory in other branches
- 8.9 modules/social_features/social_user_export/src/Plugin/Action/ExportUser.php
- 8 modules/social_features/social_user_export/src/Plugin/Action/ExportUser.php
- 8.2 modules/social_features/social_user_export/src/Plugin/Action/ExportUser.php
- 8.3 modules/social_features/social_user_export/src/Plugin/Action/ExportUser.php
- 8.5 modules/social_features/social_user_export/src/Plugin/Action/ExportUser.php
- 8.6 modules/social_features/social_user_export/src/Plugin/Action/ExportUser.php
- 8.7 modules/social_features/social_user_export/src/Plugin/Action/ExportUser.php
- 8.8 modules/social_features/social_user_export/src/Plugin/Action/ExportUser.php
- 10.3.x modules/social_features/social_user_export/src/Plugin/Action/ExportUser.php
- 10.0.x modules/social_features/social_user_export/src/Plugin/Action/ExportUser.php
- 10.1.x modules/social_features/social_user_export/src/Plugin/Action/ExportUser.php
- 10.2.x modules/social_features/social_user_export/src/Plugin/Action/ExportUser.php
Namespace
Drupal\social_user_export\Plugin\ActionFile
modules/social_features/social_user_export/src/Plugin/Action/ExportUser.phpView source
<?php
namespace Drupal\social_user_export\Plugin\Action;
use Drupal\Core\Action\ActionBase;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\user\PrivateTempStoreFactory;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
* Exports a user accounts to CSV.
*
* @Action(
* id = "social_user_export_user_action",
* label = @Translation("Export the selected user(s) to CSV"),
* type = "user",
* confirm_form_route_name = "social_user_export.export_user_confirm"
* )
*/
class ExportUser extends ActionBase implements ContainerFactoryPluginInterface {
/**
* The tempstore factory.
*
* @var \Drupal\user\PrivateTempStoreFactory
*/
protected $tempStoreFactory;
/**
* The current user.
*
* @var \Drupal\Core\Session\AccountInterface
*/
protected $currentUser;
/**
* Apply for all.
*
* @var bool
*/
protected $applyAll;
/**
* The query.
*
* @var array
*/
protected $query = [];
/**
* Constructs a ExportUser 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\user\PrivateTempStoreFactory $temp_store_factory
* The tempstore factory.
* @param \Drupal\Core\Session\AccountInterface $current_user
* The current user.
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, PrivateTempStoreFactory $temp_store_factory, AccountInterface $current_user) {
$this->currentUser = $current_user;
$this->tempStoreFactory = $temp_store_factory;
parent::__construct($configuration, $plugin_id, $plugin_definition);
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('user.private_tempstore'), $container
->get('current_user'));
}
/**
* {@inheritdoc}
*/
public function executeMultiple(array $entities) {
if ($this->applyAll) {
$this->tempStoreFactory
->get('user_operations_export')
->set($this->currentUser
->id(), [
'apply_all' => TRUE,
'query' => $this->query,
]);
}
else {
$this->tempStoreFactory
->get('user_operations_export')
->set($this->currentUser
->id(), [
'entities' => $entities,
]);
}
}
/**
* {@inheritdoc}
*/
public function execute($object = NULL) {
$this
->executeMultiple([
$object,
]);
}
/**
* {@inheritdoc}
*/
public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
/** @var \Drupal\user\UserInterface $object */
return $object
->access('view', $account, $return_as_object);
}
/**
* Set the apply_all property.
*
* @param bool $applyAll
* Boolean that determines if this applies for all or not.
*/
public function setApplyAll($applyAll) {
$this->applyAll = $applyAll;
}
/**
* Set the query property.
*
* @param array $query
* An array with query properties.
*/
public function setQuery(array $query) {
$this->query = $query;
}
}
Classes
Name | Description |
---|---|
ExportUser | Exports a user accounts to CSV. |