You are here

Home » API reference » Bulk User Registration 8 » SampleCsv.php

class SampleCsv in Bulk User Registration 8

Sample CSV controller.

@package Drupal\bulk_user_registration

Hierarchy

Expanded class hierarchy of SampleCsv

File

src/Controller/SampleCsv.php, line 13

Namespace

Drupal\bulk_user_registration\Controller
View source 
class SampleCsv extends ControllerBase {

  /**
   * Provides a response with downloadable CSV file data.
   */
  public function content() {
    $response = new Response();
    $response
      ->setContent($this
      ->getCsvData());
    $response->headers
      ->set('Content-Type', 'text/csv');
    $response->headers
      ->set('Content-Disposition', 'attachment; filename="bulk-user-registration-sample.csv"');
    return $response;
  }

  /**
   * Returns the sample CSV data.
   *
   * @return string
   *   CSV data. Fields separated by comma, rows separated by new line.
   */
  protected function getCsvData() {
    $rows[] = implode(',', $this
      ->wrap($this
      ->getFieldNames()));
    $rows[] = 'active-user-default-role,mail1@example.com,1';
    $rows[] = 'blocked-user-default-role,mail2@example.com,0';
    $rows = array_merge($rows, $this
      ->getUserDataWithRole());
    return implode("\n", $rows);
  }

  /**
   * Returns CSV data for users with role. One user per role.
   *
   * @return array
   *   Comma separated user data.
   */
  protected function getUserDataWithRole() {
    $data = [];
    $allowedRoles = \Drupal::config('bulk_user_registration.settings')
      ->get('allowed_roles');
    foreach (array_filter($allowedRoles) as $role) {
      $data[] = "user_{$role},mail.{$role}@example.com,1,{$role}";
    }
    return $data;
  }

  /**
   * Returns the CSV field names.
   *
   * @return string[]
   *   Array of field names.
   */
  protected function getFieldNames() {
    $standardFields = [
      'username',
      'email',
      'status',
      'role',
    ];
    $extraFields = \Drupal::moduleHandler()
      ->invokeAll('bulk_user_registration_extra_fields');
    return array_merge($standardFields, $extraFields);
  }

  /**
   * A simple treatment for strings in CSV.
   *
   * Since this sample CSV generator uses controlled content, we can safely
   * assume no double quotes or comma's are present in string content. Therefore
   * no library is needed and we can use a simple treatment for stings.
   *
   * @param string|string[] $source
   *   The string to check.
   *
   * @return string|string[]
   *   When the source string contains a space it is wrapped in double quotes.
   */
  protected function wrap($source) {
    $strings = is_array($source) ? $source : [
      $source,
    ];
    $result = [];
    foreach ($strings as $string) {
      if (strpos($string, ' ') === FALSE) {
        $result[] = $string;
      }
      else {
        $result[] = '"' . $string . '"';
      }
    }
    return is_array($source) ? $result : reset($result);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 40
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
SampleCsv::content public function Provides a response with downloadable CSV file data.
SampleCsv::getCsvData protected function Returns the sample CSV data.
SampleCsv::getFieldNames protected function Returns the CSV field names.
SampleCsv::getUserDataWithRole protected function Returns CSV data for users with role. One user per role.
SampleCsv::wrap protected function A simple treatment for strings in CSV.
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.