interface ViewsDataExportExporterInterface in Views data export 7.4

Hierarchy

• interface \ViewsDataExportExporterInterface

File

exporters/ViewsDataExportExporterInterface.inc, line 4

interface ViewsDataExportExporterInterface {

  /**
   * Constructor for ViewsDataExportExporter classes.
   *
   * @param $options
   *   The array of export options as provided by the user-interface.
   */
  function __construct($options);
  function option_definition();

  /**
   * Add a single row to the export file.
   *
   * @param $file_handle
   *   A PHP file handle to the export file.
   * @param array $data
   *   An array of formatted data for this row. One cell per item.
   * @param int $row_count
   *   The current number of rows in the export file.
   * @param $field_titles
   * @return
   */
  function add_row(&$file_handle, $data, $row_count, $field_titles);

  /**
   * Provide headers to the page when an export file is being downloaded.
   *
   * @param $filename
   *   The name of the file being downloaded. e.g. export.xls.
   */
  function get_headers($filename);

  /**
   * Write the start of the export file.
   *
   * @param $file_handle
   *   A PHP file handle to the export file.
   */
  function bof(&$file_handle);

  /**
   * Write the end of the export file.
   *
   * @param $file_handle
   *   A PHP file handle to the export file.
   */
  function eof(&$file_handle, $row_count, $col_count);

  /**
   * Allow final processing of the results.
   *
   * @param $results
   *   An array of result data, including:
   *   - file_name: The full file path of the generated file.
   *   - row_count: The final number of rows in the generated file.
   */
  function post_process(&$results);

}

Members

Name	Modifiers	Type	Description	Overrides
ViewsDataExportExporterInterface::add_row		function	Add a single row to the export file.	1
ViewsDataExportExporterInterface::bof		function	Write the start of the export file.	1
ViewsDataExportExporterInterface::eof		function	Write the end of the export file.	1
ViewsDataExportExporterInterface::get_headers		function	Provide headers to the page when an export file is being downloaded.	1
ViewsDataExportExporterInterface::option_definition		function		1
ViewsDataExportExporterInterface::post_process		function	Allow final processing of the results.	1
ViewsDataExportExporterInterface::__construct		function	Constructor for ViewsDataExportExporter classes.	1