class XLSXExporter in Loft Data Grids 6.2

Class XLSXExporter

http://www.phpexcel.net

Hierarchy

• class \AKlump\LoftDataGrids\Exporter implements ExporterInterface
  • class \AKlump\LoftDataGrids\XLSXExporter implements ExporterInterface

File

vendor/aklump/loft_data_grids/src/AKlump/LoftDataGrids/XLSXExporter.php, line 9

Namespace

AKlump\LoftDataGrids

class XLSXExporter extends Exporter implements ExporterInterface {
  protected $extension = '.xlsx';
  protected $sheets = array();

  /**
   * @var $worksheet
   * The PHPExcel object
   */
  protected $excel;

  /**
   * Constructor
   *
   * @param ExportDataInterface $data
   * @param string $filename
   *   (Optional) Defaults to ''.
   * @param array $properties
   */
  public function __construct(ExportDataInterface $data = NULL, $filename = '', $properties = array()) {
    parent::__construct($data, $filename);
    $this->output = FALSE;
    $this->excel = new \PHPExcel();
    if ($properties) {
      $this
        ->setProperties($properties);
    }
  }
  public function getInfo() {
    $info = parent::getInfo();
    $info = array(
      'name' => 'Excel Format',
      'shortname' => 'Excel',
      'description' => 'Export data in the .xlsx file format.',
    ) + $info;
    return $info;
  }
  public function setTitle($title) {
    parent::setTitle($title);
    $this->excel
      ->getProperties()
      ->setTitle($title);
  }

  /**
   * Set properties
   *
   * @param array $properties
   *   - Title
   *   - Creator
   *   - LastModifiedBy
   *   - Description
   *   - Keywords
   *   - Category
   *
   * @return $this
   */
  public function setProperties($properties) {
    $obj = $this->excel
      ->getProperties();
    foreach ($properties as $property_name => $value) {
      $method = "set{$property_name}";
      if (method_exists($obj, $method)) {
        $obj
          ->{$method}($value);
      }
    }
    return $this;
  }

  /**
   * Return the value of a single property or NULL
   *
   * @param  string $property_name e.g. Creator
   *
   * @return mixed
   */
  public function getProperty($property_name) {
    $obj = $this->excel
      ->getProperties();
    $method = "get{$property_name}";
    return method_exists($obj, $method) ? $obj
      ->{$method}() : NULL;
  }

  /**
   * Returns the PHPExcel object
   *
   * @return PHPExcel
   */
  public function export($page_id = NULL) {
    return $this->excel;
  }
  public function compile($page_id = NULL) {
    $pages = $this
      ->getData()
      ->get();
    $this->output = !empty($pages);
    foreach ($pages as $page_id => $data) {
      if (empty($this->sheets)) {
        $this->sheets[] = $page_id;
      }
      elseif (!in_array($page_id, $this->sheets)) {
        $this->sheets[] = $page_id;
        $this->excel
          ->createSheet();
      }

      // Assure our active sheet is an integar
      $active_sheet = array_search($page_id, $this->sheets);
      $this->excel
        ->setActiveSheetIndex($active_sheet);
      $worksheet = $this->excel
        ->getActiveSheet();

      //@todo The column count is wrong when sheets differ in the column count.

      // Format the header row:
      $header = $this
        ->getHeader($page_id);

      // Format the rows:
      $row_index = 1;
      $worksheet
        ->fromArray($header, NULL, 'A' . $row_index++, TRUE);
      foreach ($data as $row) {
        $col_index = 'A';
        $worksheet
          ->fromArray($row, NULL, 'A' . $row_index, TRUE);
        $row_index++;
      }
    }
  }
  public function save($filename = '', $page_id = NULL) {

    // Make sure we have rendered the data
    if (empty($this->output)) {
      $this
        ->compile($page_id);
    }

    // Assure the correct file extension
    if ($filename) {
      $this
        ->setFilename($filename);
    }
    $filename = $this
      ->getFilename();

    // Redirect output to a client’s web browser (Excel2007)
    header('Content-Type: application/vnd.openxmlformats-officedocument.spreadsheetml.sheet');
    header('Content-Disposition: attachment;filename="' . $this->filename . '"');
    header('Cache-Control: max-age=0');
    $objWriter = \PHPExcel_IOFactory::createWriter($this->excel, 'Excel2007');
    $objWriter
      ->save('php://output');
    exit;
  }

  /**
   * Format a single column with a number format
   *
   * You must do this after calling $this->compile!
   *
   * @param string $column
   * @param string $format_code
   * - USD OR PHPExcel_Style_NumberFormat::setFormatCode()
   *
   * @return $this
   */
  public function formatColumn($column, $format_code) {

    // By default we'll use USD.
    $format_code = isset($format_code) ? $format_code : 'USD';
    $phpexcel_format = \PHPExcel_Style_NumberFormat::FORMAT_CURRENCY_USD_SIMPLE;

    // Map to specific formats in PHPExcel
    if ($format_code === 'USD') {
      $phpexcel_format = \PHPExcel_Style_NumberFormat::FORMAT_CURRENCY_USD_SIMPLE;
    }
    elseif ($format_code === \PHPExcel_Style_NumberFormat::FORMAT_CURRENCY_USD_SIMPLE) {
      $format_code = 'USD';
    }
    $columns = $this
      ->getPHPExcelColumns();
    if (!array_key_exists($column, $columns)) {
      return;
    }
    $phpexcel_column = $columns[$column];
    $page = $this->excel
      ->getActiveSheet();
    foreach ($page
      ->getRowIterator() as $row) {
      $row_index = $row
        ->getRowIndex();
      $page
        ->getStyle("{$phpexcel_column}{$row_index}")
        ->getNumberFormat()
        ->setFormatCode($phpexcel_format);
    }
    return parent::formatColumn($column, $format_code);
  }

  /**
   * Convert a column key into an excel column, e.g. A, AB, etc.
   *
   * @param  string $column
   *
   * @return string
   */
  public function getPHPExcelColumns() {

    // @todo This will not work past 26 columns; fix!!!!
    $columns = array();
    $current = array(
      65,
    );
    $chr =& $current[count($current) - 1];
    foreach ($this
      ->getHeader() as $header_key) {
      $columns[$header_key] = chr($chr++);
    }
    return $columns;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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::filenameSafe	protected	function	Return a string as a safe filename
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::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::showPageIds	public	function	Set the exporter to display page ids. Overrides ExporterInterface::showPageIds
XLSXExporter::$excel	protected	property	The PHPExcel object
XLSXExporter::$extension	protected	property
XLSXExporter::$sheets	protected	property
XLSXExporter::compile	public	function	Build $this->output in prep for export/save Overrides Exporter::compile
XLSXExporter::export	public	function	Returns the PHPExcel object Overrides Exporter::export
XLSXExporter::formatColumn	public	function	Format a single column with a number format Overrides Exporter::formatColumn
XLSXExporter::getInfo	public	function	Return info about this class Overrides Exporter::getInfo
XLSXExporter::getPHPExcelColumns	public	function	Convert a column key into an excel column, e.g. A, AB, etc.
XLSXExporter::getProperty	public	function	Return the value of a single property or NULL
XLSXExporter::save	public	function	Save as a file to the server Overrides Exporter::save
XLSXExporter::setProperties	public	function	Set properties
XLSXExporter::setTitle	public	function	Set a title for the exported document Overrides Exporter::setTitle
XLSXExporter::__construct	public	function	Constructor Overrides Exporter::__construct