## Class mr_file_export_text_abstract

Description

MR File Export Text Abstract

- author: Mark Nielsen
- abstract:

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

    mr_plugin
       |
       --mr_file_export_abstract
          |
          --mr_file_export_text_abstract

Direct descendents

Class | Description
--- | ---
mr_file_export_text_csv | MR File Export Text CSV
mr_file_export_text_tsv | MR File Export Text TSV (Tab Separated Values)

Variable Summary
string $file
resource $fp
Method Summary
void add_row ( $row)
void cleanup ()
void close ()
string get_delimiter ()
void init (string $name, [string $dir = NULL])
void set_headers ( $headers)
Variables
string $file (line 43)

The export file

- access: protected

resource $fp (line 50)

The file point to the export file

- access: protected

Methods
add_row (line 99)

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

cleanup (line 114)

Remove the csv file

- access: public

void cleanup ()

Redefinition of:

mr_file_export_abstract::cleanup()
  Run any cleanup routines

close (line 106)

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

get_delimiter (line 57)

Get the text delimiter

- abstract:
- access: public

string get_delimiter ()

Redefined in descendants as:

- mr_file_export_text_csv::get_delimiter() : Get the text delimiter
- mr_file_export_text_tsv::get_delimiter() : Get the text delimiter

init (line 66)

Make the directory for the file and open the file pointer

- access: public

void init (string $name, [string $dir = NULL])

- string $name: The preferred file name (no extension)
- string $dir: The directory to store the file in (temp by default)

Redefinition of:

mr_file_export_abstract::init()
  Init routines, params can be unique to the plugin

set_headers (line 92)

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()

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