class ExportAllEnrolments in Open Social 8.5

Exports a event enrollment accounts to CSV.

Plugin annotation

@Action(
  id = "social_event_an_enroll_enrolments_export_action",
  label = @Translation("Export the selected enrollments to CSV"),
  type = "event_enrollment",
  confirm = TRUE,
  confirm_form_route_name = "social_event_managers.vbo.confirm",
)

Hierarchy

• class \Drupal\social_user_export\Plugin\Action\ExportUser extends \Drupal\views_bulk_operations\Action\ViewsBulkOperationsActionBase implements ContainerFactoryPluginInterface, PluginFormInterface uses MessengerTrait
  • class \Drupal\social_event_enrolments_export\Plugin\Action\ExportEnrolments
    • class \Drupal\social_event_an_enroll_enrolments_export\Plugin\Action\ExportAllEnrolments

File

modules/social_features/social_event/modules/social_event_an_enroll_enrolments_export/src/Plugin/Action/ExportAllEnrolments.php, line 25

Namespace

Drupal\social_event_an_enroll_enrolments_export\Plugin\Action

class ExportAllEnrolments extends ExportEnrolments {
  protected $entities;

  /**
   * The event an enroll manager.
   *
   * @var \Drupal\social_event_an_enroll\EventAnEnrollManager
   */
  protected $socialEventAnEnrollManager;

  /**
   * Constructs a ExportAllEnrolments 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\social_user_export\Plugin\UserExportPluginManager $userExportPlugin
   *   The user export plugin manager.
   * @param \Psr\Log\LoggerInterface $logger
   *   A logger instance.
   * @param \Drupal\social_event_an_enroll\EventAnEnrollManager $social_event_an_enroll_manager
   *   The event an enroll manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, UserExportPluginManager $userExportPlugin, LoggerInterface $logger, EventAnEnrollManager $social_event_an_enroll_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $userExportPlugin, $logger);
    $this->socialEventAnEnrollManager = $social_event_an_enroll_manager;
    $parents = [];
    foreach ($this->pluginDefinitions as $plugin_id => $plugin_definition) {
      if ($plugin_definition['provider'] === 'social_event_an_enroll_enrolments_export') {
        $parents += class_parents($plugin_definition['class']);
      }
    }
    if ($parents) {
      foreach ($this->pluginDefinitions as $plugin_id => $plugin_definition) {
        if ($plugin_definition['provider'] !== 'social_event_an_enroll_enrolments_export' && in_array($plugin_definition['class'], $parents)) {
          unset($this->pluginDefinitions[$plugin_id]);
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('plugin.manager.user_export_plugin'), $container
      ->get('logger.factory')
      ->get('action'), $container
      ->get('social_event_an_enroll.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function executeMultiple(array $entities) {
    $this->entities = $entities;
    parent::executeMultiple($entities);
  }

  /**
   * {@inheritdoc}
   */
  public function access($object, AccountInterface $account = NULL, $return_as_object = FALSE) {
    if ($object instanceof EventEnrollmentInterface) {
      if ($this->socialEventAnEnrollManager
        ->isGuest($object)) {
        $access = AccessResult::allowed();
      }
      else {
        $access = $this
          ->getAccount($object)
          ->access('view', $account, TRUE);
      }
    }
    else {
      $access = AccessResult::forbidden();
    }
    return $return_as_object ? $access : $access
      ->isAllowed();
  }

  /**
   * {@inheritdoc}
   */
  public function getPluginConfiguration($plugin_id, $entity_id) {
    $configuration = parent::getPluginConfiguration($plugin_id, $entity_id);
    $plugin_definition =& $this->pluginDefinitions[$plugin_id];
    if ($plugin_definition['provider'] === 'social_event_an_enroll_enrolments_export') {
      $configuration['entity'] = $this->entities[$entity_id];
    }
    return $configuration;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ExportAllEnrolments::$entities	protected	property
ExportAllEnrolments::$socialEventAnEnrollManager	protected	property	The event an enroll manager.
ExportAllEnrolments::access	public	function	Overrides ExportEnrolments::access
ExportAllEnrolments::create	public static	function	Creates an instance of the plugin. Overrides ExportUser::create
ExportAllEnrolments::executeMultiple	public	function	Overrides ExportEnrolments::executeMultiple
ExportAllEnrolments::getPluginConfiguration	public	function	Gets export plugin's configuration. Overrides ExportUser::getPluginConfiguration
ExportAllEnrolments::__construct	public	function	Constructs a ExportAllEnrolments object. Overrides ExportUser::__construct
ExportEnrolments::getAccount	public	function	Extract user entity from event enrollment entity.
ExportEnrolments::getFileTemporaryPath	public	function	Returns unique file path. Overrides ExportUser::getFileTemporaryPath
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::execute	public	function
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18