You are here

class ExportEnrolments in Open Social 8.6

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

Exports a event enrollment accounts to CSV.

Plugin annotation


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

Hierarchy

Expanded class hierarchy of ExportEnrolments

1 file declares its use of ExportEnrolments
ExportAllEnrolments.php in modules/social_features/social_event/modules/social_event_an_enroll_enrolments_export/src/Plugin/Action/ExportAllEnrolments.php

File

modules/social_features/social_event/modules/social_event_enrolments_export/src/Plugin/Action/ExportEnrolments.php, line 21

Namespace

Drupal\social_event_enrolments_export\Plugin\Action
View source
class ExportEnrolments extends ExportUser {

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

    /** @var \Drupal\social_event\EventEnrollmentInterface $entity */
    foreach ($entities as &$entity) {
      $entity = $this
        ->getAccount($entity);
    }
    parent::executeMultiple($entities);
  }

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

  /**
   * {@inheritdoc}
   */
  protected function generateFilePath() : string {
    $hash = md5(microtime(TRUE));
    return 'export-enrollments-' . substr($hash, 20, 12) . '.csv';
  }

  /**
   * Extract user entity from event enrollment entity.
   *
   * @param \Drupal\social_event\EventEnrollmentInterface $entity
   *   The event enrollment.
   *
   * @return \Drupal\user\UserInterface
   *   The user.
   */
  public function getAccount(EventEnrollmentInterface $entity) {
    $accounts = $entity->field_account
      ->referencedEntities();
    return reset($accounts);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ExportEnrolments::access public function Overrides ExportUser::access 1
ExportEnrolments::executeMultiple public function Overrides ExportUser::executeMultiple 1
ExportEnrolments::generateFilePath protected function Returns a unique file path for this export. Overrides ExportUser::generateFilePath
ExportEnrolments::getAccount public function Extract user entity from event enrollment entity.
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
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::__construct public function Constructs a ExportUser object. 1
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