ExcelExport.php in Excel Serialization 8

Namespace

Drupal\xls_serialization\Plugin\views\style

File

src/Plugin/views/style/ExcelExport.php

<?php

namespace Drupal\xls_serialization\Plugin\views\style;

use Drupal\Component\Utility\Html;
use Drupal\Core\Url;
use Drupal\Core\Form\FormStateInterface;
use Drupal\rest\Plugin\views\style\Serializer;

/**
 * A style plugin for Excel export views.
 *
 * @ingroup views_style_plugins
 *
 * @ViewsStyle(
 *   id = "excel_export",
 *   title = @Translation("Excel export"),
 *   help = @Translation("Configurable row output for Excel exports."),
 *   display_types = {"data"}
 * )
 */
class ExcelExport extends Serializer {

  /**
   * Constructs a Plugin 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 mixed $serializer
   *   The serializer for the plugin instance.
   * @param array $serializer_formats
   *   The serializer formats for the plugin instance.
   * @param array $serializer_format_providers
   *   The serializer format providers for the plugin instance.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, $serializer, array $serializer_formats, array $serializer_format_providers) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $serializer, $serializer_formats, $serializer_format_providers);
    $this->formats = [
      'xls',
      'xlsx',
    ];
    $this->formatProviders = [
      'xls' => 'xls_serialization',
      'xlsx' => 'xls_serialization',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function defineOptions() {
    $options = parent::defineOptions();
    $options['xls_settings']['contains'] = [
      'xls_format' => [
        'default' => 'Excel2007',
      ],
    ];
    $options['xls_settings']['metadata']['contains'] = [
      // The 'created' and 'modified' elements are not exposed here, as they
      // default to the current time (that the spreadsheet is created), and
      // would probably just confuse the UI.
      'creator' => [
        'default' => '',
      ],
      'last_modified_by' => [
        'default' => '',
      ],
      'title' => [
        'default' => '',
      ],
      'description' => [
        'default' => '',
      ],
      'subject' => [
        'default' => '',
      ],
      'keywords' => [
        'default' => '',
      ],
      'category' => [
        'default' => '',
      ],
      'manager' => [
        'default' => '',
      ],
      'company' => [
        'default' => '',
      ],
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildOptionsForm($form, $form_state);
    switch ($form_state
      ->get('section')) {
      case 'style_options':

        // Change format to radios instead, since multiple formats here do not
        // make sense as they do for REST exports.
        $form['formats']['#type'] = 'radios';
        $form['formats']['#default_value'] = reset($this->options['formats']);

        // Remove now confusing description.
        unset($form['formats']['#description']);

        // XLS options.
        $xls_options = $this->options['xls_settings'];
        $form['xls_settings'] = [
          '#type' => 'details',
          '#open' => TRUE,
          '#title' => $this
            ->t('XLS(X) settings'),
          '#tree' => TRUE,
          'xls_format' => [
            '#type' => 'select',
            '#title' => $this
              ->t('Format'),
            '#options' => [
              // @todo Add all PHPExcel supported formats.
              'Excel2007' => $this
                ->t('Excel 2007'),
              'Excel5' => $this
                ->t('Excel 5'),
            ],
            '#default_value' => $xls_options['xls_format'],
          ],
        ];
        $metadata = !empty($xls_options['metadata']) ? array_filter($xls_options['metadata']) : [];

        // XLS metadata.
        $form['xls_settings']['metadata'] = [
          '#type' => 'details',
          '#title' => $this
            ->t('Document metadata'),
          '#open' => $metadata,
        ];
        $xls_fields = [
          'creator' => $this
            ->t('Author/creator name'),
          'last_modified_by' => $this
            ->t('Last modified by'),
          'title' => $this
            ->t('Title'),
          'description' => $this
            ->t('Description'),
          'subject' => $this
            ->t('Subject'),
          'keywords' => $this
            ->t('Keywords'),
          'category' => $this
            ->t('Category'),
          'manager' => $this
            ->t('Manager'),
          'company' => $this
            ->t('Company'),
        ];
        foreach ($xls_fields as $xls_field_key => $xls_field_title) {
          $form['xls_settings']['metadata'][$xls_field_key] = [
            '#type' => 'textfield',
            '#title' => $xls_field_title,
          ];
          if (isset($xls_options['metadata'][$xls_field_key])) {
            $form['xls_settings']['metadata']['#default_value'] = $xls_options['metadata'][$xls_field_key];
          }
        }
        break;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitOptionsForm(&$form, FormStateInterface $form_state) {

    // Transform the formats back into an array.
    $format = $form_state
      ->getValue([
      'style_options',
      'formats',
    ]);
    $form_state
      ->setValue([
      'style_options',
      'formats',
    ], [
      $format => $format,
    ]);
    parent::submitOptionsForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   *
   * @todo This should implement AttachableStyleInterface once
   * https://www.drupal.org/node/2779205 lands.
   */
  public function attachTo(array &$build, $display_id, Url $url, $title) {

    // @todo This mostly hard-codes CSV handling. Figure out how to abstract.
    $url_options = [];
    $input = $this->view
      ->getExposedInput();
    if ($input) {
      $url_options['query'] = $input;
    }
    if ($pager = $this->view
      ->getPager()) {
      $url_options['query']['page'] = $pager
        ->getCurrentPage();
    }
    $url_options['absolute'] = TRUE;
    if (!empty($this->options['formats'])) {
      $url_options['query']['_format'] = reset($this->options['formats']);
    }
    $url = $url
      ->setOptions($url_options)
      ->toString();

    // Add the CSV icon to the view.
    $type = $this->displayHandler
      ->getContentType();
    $this->view->feedIcons[] = [
      '#theme' => 'export_icon',
      '#url' => $url,
      '#type' => mb_strtoupper($type),
      '#theme_wrappers' => [
        'container' => [
          '#attributes' => [
            'class' => [
              Html::cleanCssIdentifier($type) . '-feed',
              'views-data-export-feed',
            ],
          ],
        ],
      ],
      '#attached' => [
        'library' => [
          'views_data_export/views_data_export',
        ],
      ],
    ];

    // Attach a link to the CSV feed, which is an alternate representation.
    $build['#attached']['html_head_link'][][] = [
      'rel' => 'alternate',
      'type' => $this->displayHandler
        ->getMimeType(),
      'title' => $title,
      'href' => $url,
    ];
  }

}

Classes

Name	Description
ExcelExport	A style plugin for Excel export views.