class_pdfExporter.inc

Go to the documentation of this file.

<?php
/*
  This code is part of FusionDirectory (http://www.fusiondirectory.org/)
  Copyright (C) 2003-2010  Cajus Pollmeier
  Copyright (C) 2011-2016  FusionDirectory

  This program is free software; you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation; either version 2 of the License, or
  (at your option) any later version.

  This program is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.

  You should have received a copy of the GNU General Public License
  along with this program; if not, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
*/

// Try to load PDF library
@include_once(FPDF);

// Load supporter class only if FPDF is loaded
$classes = get_declared_classes();
if (in_array('FPDF', $classes)) {
  include('class_PDF.php');
}

class pdfExporter
{
  var $result;

  function __construct ($headline, $header, $entries, $columns = [])
  {
    // Bail out if no FPDF available
    if (!class_exists('FPDF')) {
      die(_("No PDF export possible: there is no FPDF library installed."));
    }

    // If no preset, render all columns
    if (!count($columns)) {
      $columns = array_keys($header);
    }

    // Create new PDF
    $this->result = new PDF('L', 'mm', 'A4');
    $this->result->AliasNbPages();
    $this->result->SetFont('Helvetica', '', 10);
    $this->result->setHeadline(utf8_decode($headline));
    $this->result->AddPage();

    // Analyze for width
    $width = $this->calcWidth($header, $entries, $columns);

    // Render head
    $this->result->SetFont('', 'B');
    $this->result->SetTextColor(0);
    $this->result->SetDrawColor(0, 0, 0);
    $this->result->SetLineWidth(.3);

    // Height calculator
    $height = 0;

    $fill = FALSE;
    foreach ($entries as $row) {
      // Render header
      if ($height == 0) {
        // Generate header
        $this->result->SetFillColor(230, 230, 230);
        $this->result->SetFont('', 'B');

        foreach ($columns as $order => $index) {
          if (isset($header[$index])) {
            $this->result->Cell($width[$order], 7, utf8_decode($header[$index]), 1, 0, 'C', 1);
          } else {
            $this->result->Cell($width[$order], 7, '', 1, 0, 'C', 1);
          }
        }
        $this->result->Ln();
        $height = 7;

        // Set entry collors
        $this->result->SetFillColor(240, 240, 240);
        $this->result->SetFont('');
      }

      foreach ($columns as $order => $index) {
        if (isset($row["_sort$index"])) {
          $this->result->Cell($width[$order], 6, utf8_decode($row["_sort$index"]), 'LR', 0, 'L', $fill);
        } else {
          $this->result->Cell($width[$order], 6, '', 'LR', 0, 'L', $fill);
        }
      }

      $this->result->Ln();

      // Increase height to eventually create new page
      $height += 8;
      if ($height > 220) {
        $height = 0;
        $this->result->Cell(array_sum($width), 0, '', 'T');
        $this->result->AddPage();
        $fill = FALSE;
      } else {
        $fill = !$fill;
      }
    }
    $this->result->Cell(array_sum($width), 0, '', 'T');
  }

  function calcWidth ($header, $entries, $columns)
  {
    $width = [];

    // Locate longest value for each column
    foreach ($columns as $index) {
      $max = 0;

      if (isset($header[$index])) {
        $len = $this->result->GetStringWidth($header[$index]);
        if ($len > $max) {
          $max = $len;
        }
      }

      foreach ($entries as $row) {
        if (isset($row["_sort$index"])) {
          $len = $this->result->GetStringWidth($row["_sort$index"]);
          if ($len > $max) {
            $max = $len;
          }
        }
      }

      $width[] = $max;
    }

    // Scale to page width
    $printWidth = 280;
    $scale      = $printWidth / array_sum($width);
    foreach ($width as &$w) {
      $w *= $scale;
    }
    unset($w);

    return $width;
  }

  static function calcColumnsWidth ($result, $columns, $iterator)
  {
    $width = [];

    // Locate longest value for each column
    foreach ($columns as $index => $column) {
      if (!$column->isExportable()) {
        continue;
      }
      $max = 0;

      $len = $result->GetStringWidth($column->getLabel());
      if ($len > $max) {
        $max = $len;
      }

      foreach ($iterator as $entry) {
        $len = $result->GetStringWidth(implode(',', $column->getRawExportValues($entry)));
        if ($len > $max) {
          $max = $len;
        }
      }

      $width[$index] = $max;
    }

    // Scale to page width
    $printWidth = 280;
    $scale      = $printWidth / array_sum($width);
    foreach ($width as &$w) {
      $w *= $scale;
    }
    unset($w);

    return $width;
  }

  function query ()
  {
    return $this->result->Output("", "S");
  }

  static function export (managementListing $listing)
  {
    global $ui;

    // Bail out if no FPDF available
    if (!class_exists('FPDF')) {
      die(_('No PDF export possible: there is no FPDF library installed.'));
    }

    $columns  = $listing->getColumns();
    $iterator = $listing->getIterator();

    // Create new PDF
    $result = new PDF('L', 'mm', 'A4');
    $result->AliasNbPages();
    $result->SetFont('Helvetica', '', 10);
    $headline = $listing->parent->headline;
    $headline .= ', '._('created by').' '.$ui->cn.' - '.strftime('%A, %d. %B %Y, %H:%M:%S');
    $result->setHeadline(utf8_decode($headline));
    $result->AddPage();

    // Analyze for width
    $width = static::calcColumnsWidth($result, $columns, $iterator);

    // Render head
    $result->SetTextColor(0);
    $result->SetDrawColor(0, 0, 0);
    $result->SetLineWidth(.3);

    // Render header
    $result->SetFillColor(230, 230, 230);
    $result->SetFont('', 'B');

    foreach ($columns as $index => $column) {
      if ($column->isExportable()) {
        $result->Cell($width[$index], 7, utf8_decode($column->getLabel()), 1, 0, 'C', 1);
      }
    }
    $result->Ln();
    $height = 7;

    // Set entry colors
    $result->SetFillColor(240, 240, 240);
    $result->SetFont('');

    $fill = TRUE;
    foreach ($iterator as $entry) {
      if ($height > 220) {
        $height = 0;
        $result->Cell(array_sum($width), 0, '', 'T');
        $result->AddPage();
        $fill = FALSE;
      } else {
        $fill = !$fill;
      }

      foreach ($columns as $index => $column) {
        if ($column->isExportable()) {
          $result->Cell(
            $width[$index],
            6,
            implode(
              ',',
              array_map(
                'utf8_decode',
                $column->getRawExportValues($entry)
              )
            ),
            'LR',
            0,
            'L',
            $fill
          );
        }
      }

      $result->Ln();

      // Increase height to eventually create new page
      $height += 8;
    }
    $result->Cell(array_sum($width), 0, '', 'T');

    return $result->Output('', 'S');
  }

  static function getInfo ()
  {
    // Check if class defined
    $classes = get_declared_classes();
    if (in_array('FPDF', $classes)) {
      return ["exportPDF" => [ "label" => _("PDF"), "image" => "geticon.php?context=mimetypes&icon=application-pdf&size=16", "class" => "pdfExporter", "mime" => "application/pdf", "filename" => "export.pdf" ]];
    } else {
      return NULL;
    }
  }
}