You are here

Home » API reference » Loft Data Grids 6.2 » FlatTextExporter.php

class FlatTextExporter in Loft Data Grids 6.2

Same name and namespace in other branches
  1. 7.2 vendor/aklump/loft_data_grids/src/AKlump/LoftDataGrids/FlatTextExporter.php \AKlump\LoftDataGrids\FlatTextExporter

Class FlatTextExporter

Hierarchy

Expanded class hierarchy of FlatTextExporter

File

vendor/aklump/loft_data_grids/src/AKlump/LoftDataGrids/FlatTextExporter.php, line 7

Namespace

AKlump\LoftDataGrids
View source 
class FlatTextExporter extends CSVExporter implements ExporterInterface {
  protected $extension = '.txt';
  protected $format;

  /**
   * Constructor
   */
  public function __construct(ExportDataInterface $data = NULL, $filename = '') {
    parent::__construct($data, $filename);
    $this->format = new \stdClass();
    $this->format->cr = "\n";
    $this->format->hline = "-";
    $this->format->vline = "|";
    $this->format->bol = $this->format->vline;
    $this->format->eol = $this->format->vline . $this->format->cr;
    $this->format->left = ' ';
    $this->format->right = ' ';
    $this->format->sep = $this->format->vline;
    $this->format->escape = '';
    $this->format->html = TRUE;
    $this
      ->hidePageIds();
  }
  public function getInfo() {
    $info = parent::getInfo();
    $info = array(
      'name' => 'Monospace Flatfile Text',
      'shortname' => 'Flat Text',
      'description' => 'Export data in a plain-text format.  Columns and rows are drawn with text pipes and hyphens.  Best results when using monospaced fonts.',
    ) + $info;
    return $info;
  }
  public function compile($page_id = NULL) {
    $this->output = '';
    $pages = $this
      ->getData()
      ->get();
    if ($page_id && array_key_exists($page_id, $pages)) {
      $pages = array(
        $pages[$page_id],
      );
    }
    foreach ($pages as $page_id => $data) {
      if ($this
        ->getShowPageIds()) {
        $this->output .= '-- ' . strtoupper($page_id) . ' --' . $this->format->cr;
      }
      $header = $this
        ->getHeader($page_id);
      foreach ($header as $key => $title) {
        $header[$key] = strtoupper($title);
      }
      $header = array_combine(array_keys(reset($data)), $header);
      array_unshift($data, $header);

      // Scan the data to determine the total width of each column
      $columns = array();
      foreach ($data as $row) {
        foreach ($row as $key => $value) {
          if (empty($columns[$key])) {
            $columns[$key] = 0;
          }
          $columns[$key] = max($columns[$key], strlen($value));
        }
      }

      // Pad all the cells based on our determination from above
      foreach ($data as $row_key => $row) {
        foreach ($row as $key => $value) {
          $data[$row_key][$key] = str_pad($value, $columns[$key], ' ');
        }
      }

      // Determine the width of a single row in chars
      $row_width = 0;
      $row_width += array_sum($columns);
      $row_width += strlen($this->format->bol);
      $row_width += strlen($this->format->left) * count($columns);
      $row_width += strlen($this->format->sep) * count($columns) - 2;
      $row_width += strlen($this->format->right) * count($columns);
      $row_width += strlen($this->format->eol);
      $hrule = str_repeat($this->format->hline, $row_width);

      // Build the output
      $this->output .= $hrule . $this->format->cr;
      foreach ($data as $row) {
        $this->output .= $this
          ->collapseRow($row);
        $this->output .= $hrule . $this->format->cr;
      }
    }
  }

  /**
   * Collapse a row
   */
  protected function collapseRow($row) {
    $output = '';

    // Check if we're dealing with a simple or complex row
    if (isset($row['data'])) {
      foreach ($row as $key => $value) {
        if ($key == 'data') {
          $cells = $value;
        }
      }
    }
    else {
      $cells = $row;
    }
    $output = array();
    if (count($cells)) {
      foreach ($cells as $cell) {

        //compress a complex cell
        if (is_array($cell)) {
          $cell = isset($cell['data']) ? $cell['data'] : '';
        }
        if (!$this->format->html) {
          $cell = strip_tags($cell);
        }

        // Escape chars that conflice with delimiters
        if (!empty($this->format->escape)) {
          $escapeables = array(
            $this->format->left,
            $this->format->right,
          );
          $escapeables = array_filter(array_unique($escapeables));
          foreach ($escapeables as $find) {
            $cell = str_replace($find, $this->format->escape . $find, $cell);
          }
        }

        // A cell cannot contain line breaks so we replace them
        $cell = preg_replace('/\\r\\n|\\r|\\n/', '; ', $cell);
        $output[] = $this->format->left . $cell . $this->format->right;
      }
    }
    $output = $this->format->bol . implode($this->format->sep, $output) . $this->format->eol;
    return $output;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CSVExporter::$page protected property
CSVExporter::collapseCell protected function Collapse a single cell in a row. 1
Exporter::$export_data protected property
Exporter::$header protected property
Exporter::$settings protected property
Exporter::addSetting public function Adds/Updates a single setting by name. Overrides ExporterInterface::addSetting
Exporter::cssSafe protected function
Exporter::export public function Export data as a string Overrides ExporterInterface::export 1
Exporter::filenameSafe protected function Return a string as a safe filename
Exporter::formatColumn public function Format a single column with format by string Overrides ExporterInterface::formatColumn 1
Exporter::getData public function Return the ExportDataInterface object Overrides ExporterInterface::getData
Exporter::getFilename public function Get the filename Overrides ExporterInterface::getFilename
Exporter::getHeader public function Return an array containing the header row values for a page Overrides ExporterInterface::getHeader
Exporter::getSettings public function Return the settings object. Overrides ExporterInterface::getSettings
Exporter::getShowPageIds public function Return the showPageIds. Overrides ExporterInterface::getShowPageIds
Exporter::getTitle public function Overrides ExporterInterface::getTitle
Exporter::hidePageIds public function Set the exporter to hide page ids. Overrides ExporterInterface::hidePageIds
Exporter::save public function Save as a file to the server Overrides ExporterInterface::save 1
Exporter::setData public function Set the export data object Overrides ExporterInterface::setData
Exporter::setFilename public function Getter/Setter for the filename Overrides ExporterInterface::setFilename
Exporter::setSettings public function Set the settings object. Overrides ExporterInterface::setSettings
Exporter::setSettingsDefault protected function Setup default values on object data. 1
Exporter::setTitle public function Set a title for the exported document Overrides ExporterInterface::setTitle 1
Exporter::showPageIds public function Set the exporter to display page ids. Overrides ExporterInterface::showPageIds
FlatTextExporter::$extension protected property Overrides CSVExporter::$extension 1
FlatTextExporter::$format protected property Overrides CSVExporter::$format 1
FlatTextExporter::collapseRow protected function Collapse a row Overrides CSVExporter::collapseRow
FlatTextExporter::compile public function Build $this->output in prep for export/save Overrides CSVExporter::compile 1
FlatTextExporter::getInfo public function Return info about this class Overrides CSVExporter::getInfo 1
FlatTextExporter::__construct public function Constructor Overrides CSVExporter::__construct 1