Class mr_file_export_spreadsheet_abstract

Description

MR File Export Spreadsheet Abstract

  • author: Mark Nielsen
  • abstract:

Located in /file/export/spreadsheet/abstract.php (line 37)

mr_plugin
   |
   --mr_file_export_abstract
      |
      --mr_file_export_spreadsheet_abstract
Direct descendents
Class Description
mr_file_export_spreadsheet_excel MR File Export Spreadsheet Excel
mr_file_export_spreadsheet_ods MR File Export Spreadsheet ODS
Class Constant Summary
 MAXROWS = 65535
Variable Summary
string $name
int $row
MoodleExcelWorkbook $workbook
MoodleExcelWorksheet $writer
Method Summary
void add_row ( $row)
void close ()
void generates_file ()
void init (string $name)
mixed new_workbook ()
void set_headers ( $headers)
Variables
string $name = '' (line 76)

Export name

  • access: protected
int $row = 0 (line 62)

Current row

  • access: protected
MoodleExcelWorkbook $workbook (line 48)

Workbook instance

  • access: protected
int $worksheet = 1 (line 69)

Worksheet count

  • access: protected
MoodleExcelWorksheet $writer (line 55)

Current worksheet

  • access: protected
Methods
add_row (line 113)

Write the row to the file

  • access: public
void add_row ( $row)
  • $row

Redefinition of:
mr_file_export_abstract::add_row()
Add a row to the export
close (line 136)

Close the file pointer and return file

  • access: public
void close ()

Redefinition of:
mr_file_export_abstract::close()
Close the export and return whatever the export generated
generates_file (line 81)

Cannot make files with the lib

  • access: public
void generates_file ()

Redefinition of:
mr_file_export_abstract::generates_file()
If the export plugin can generate a file or not.
init (line 91)

Open workbook and send to browser

  • access: public
void init (string $name)
  • string $name: The preferred file name (no extension)

Redefinition of:
mr_file_export_abstract::init()
Init routines, params can be unique to the plugin
new_workbook (line 145)

Generate a new workbook

  • abstract:
  • access: public
mixed new_workbook ()

Redefined in descendants as:
set_headers (line 106)

Write headers to the file

  • access: public
void set_headers ( $headers)
  • $headers

Redefinition of:
mr_file_export_abstract::set_headers()
Header setup

Inherited Methods

Inherited From mr_file_export_abstract

mr_file_export_abstract::add_row()
mr_file_export_abstract::cleanup()
mr_file_export_abstract::close()
mr_file_export_abstract::generates_file()
mr_file_export_abstract::get_component()
mr_file_export_abstract::get_extension()
mr_file_export_abstract::init()
mr_file_export_abstract::max_rows()
mr_file_export_abstract::set_headers()
mr_file_export_abstract::type()

Inherited From mr_plugin

mr_plugin::get_component()
mr_plugin::name()
mr_plugin::type()
Class Constants
MAXROWS = 65535 (line 41)

Max rows per worksheet

Documentation generated on Thu, 28 Jun 2012 16:33:44 -0700 by phpDocumentor 1.4.3