ExporterInterface Interface Reference

Inheritance diagram for ExporterInterface:
CSVExporter Exporter FlatTextExporter HTMLExporter JSONExporter MarkdownExporter TabTextExporter TextListExporter XLSXExporter XMLExporter YAMLExporter

Public Member Functions

 formatColumn ($column, $format_code)
 setData (ExportDataInterface $data)
 setTitle ($title)
 getTitle ()
 setFilename ($filename)
 getFilename ()
 export ($page_id=NULL)
 save ($filename= '', $page_id=NULL)
 getData ()
 getHeader ($page_id=0)
 getInfo ()

Detailed Description

Interface ExporterInterface


Member Function Documentation

export ( page_id = NULL  ) 

Export data as a string

Parameters:
mixed $page_id (Optional) Defaults to NULL. Set this to export a single page.
Returns:
string

Implemented in Exporter, and XLSXExporter.

formatColumn ( column,
format_code 
)

Format a single column with format by string

Parameters:
string $column
string $format_code

  • USD
Returns:
$this

Implemented in Exporter, and XLSXExporter.

getData (  ) 

Return the ExportDataInterface object

Returns:
ExportDataInterface

Implemented in Exporter.

getFilename (  ) 

Get the filename

Returns:
string

Implemented in Exporter.

getHeader ( page_id = 0  ) 

Return an array containing the header row values for a page

Parameters:
mixed $page_id (Optional) Defaults to 0.
Returns:
array
  • The keys of the header MUST match the keys of each row of data

Implemented in Exporter.

getInfo (  ) 

Return info about this class

Parameters:
type $string description
Returns:
array
  • name string The human name of this exporter
  • descripttion string A further description
  • extension string The file extension used by this class

Implemented in CSVExporter, Exporter, FlatTextExporter, JSONExporter, MarkdownExporter, TabTextExporter, TextListExporter, XLSXExporter, XMLExporter, and YAMLExporter.

getTitle (  ) 

Implemented in Exporter.

save ( filename = '',
page_id = NULL 
)

Save as a file to the server

Parameters:
string $filename The correct extension will be appended to this string
mixed $page_id (Optional) Defaults to NULL. Set this to export a single page.

Implemented in Exporter, and XLSXExporter.

setData ( ExportDataInterface data  ) 

Set the export data object

Parameters:
ExportDataInterface $data
Returns:
$this

Implemented in Exporter.

setFilename ( filename  ) 

Getter/Setter for the filename

Parameters:
string $filename Extension (if present in $filename) will be corrected based on the object
Returns:
string The final $filename with correct extension

Implemented in Exporter.

setTitle ( title  ) 

Set a title for the exported document

Returns:
$this

Implemented in Exporter, and XLSXExporter.


The documentation for this interface was generated from the following file:
 All Data Structures Files Functions Variables

Generated on Fri Jan 17 20:40:34 2014 for Loft Data Grids by  doxygen 1.6.1