SimpleExcel\SimpleExcel Class Reference

Collaboration diagram for SimpleExcel\SimpleExcel:

Public Member Functions
	__construct ($filetype='XML')
	SimpleExcel constructor method. More...
	constructParser ($filetype)
	Construct a SimpleExcel Parser. More...
	constructWriter ($filetype)
	Construct a SimpleExcel Writer. More...
	convertTo ($filetype)
	Change writer type to convert to another format. More...

Data Fields
	$parser
	$writer

Protected Attributes
	$validParserTypes = array('XML', 'CSV', 'TSV', 'HTML', 'JSON')
	$validWriterTypes = array('XML', 'CSV', 'TSV', 'HTML', 'JSON')

Detailed Description

Definition at line 53 of file SimpleExcel.php.

Constructor & Destructor Documentation

__construct()

SimpleExcel\SimpleExcel::__construct

(

$filetype = 'XML'

)

SimpleExcel constructor method.

Parameters

string

$filetype

Set the filetype of the file which will be parsed (XML/CSV/TSV/HTML/JSON)

Returns

void

Definition at line 80 of file SimpleExcel.php.

                                                  {
        $this->constructParser($filetype);
        $this->constructWriter($filetype);
    }

Member Function Documentation

constructParser()

SimpleExcel\SimpleExcel::constructParser

(

$filetype

)

Construct a SimpleExcel Parser.

Parameters

string

$filetype

Set the filetype of the file which will be parsed (XML/CSV/TSV/HTML/JSON)

Exceptions

Exception

If filetype is neither XML/CSV/TSV/HTML/JSON

Definition at line 91 of file SimpleExcel.php.

                                              {
        $filetype = strtoupper($filetype);
        if(!in_array($filetype, $this->validParserTypes)){
            throw new \Exception('Filetype '.$filetype.' is not supported', SimpleExcelException::FILETYPE_NOT_SUPPORTED);
        }
        $parser_class = 'SimpleExcel\\Parser\\'.$filetype.'Parser';
        $this->parser = new $parser_class();
    }

References SimpleExcel\Exception\SimpleExcelException\FILETYPE_NOT_SUPPORTED.

constructWriter()

SimpleExcel\SimpleExcel::constructWriter

(

$filetype

)

Construct a SimpleExcel Writer.

Parameters

string

$filetype

Set the filetype of the file which will be written (XML/CSV/TSV/HTML/JSON)

Returns

bool

Exceptions

Exception

If filetype is neither XML/CSV/TSV/HTML/JSON

Definition at line 107 of file SimpleExcel.php.

                                              {
        $filetype = strtoupper($filetype);
 
        if(!in_array($filetype, $this->validWriterTypes)){
            throw new \Exception('Filetype '.$filetype.' is not supported', SimpleExcelException::FILETYPE_NOT_SUPPORTED);
        }
        $writer_class = 'SimpleExcel\\Writer\\'.$filetype.'Writer';
        $this->writer = new $writer_class();
    }

References SimpleExcel\Exception\SimpleExcelException\FILETYPE_NOT_SUPPORTED.

convertTo()

SimpleExcel\SimpleExcel::convertTo

(

$filetype

)

Change writer type to convert to another format.

Parameters

string

$filetype

Set the filetype of the file which will be written (XML/CSV/TSV/HTML/JSON)

Definition at line 122 of file SimpleExcel.php.

                                        {
        $this->constructWriter($filetype);
        $this->writer->setData($this->parser->getField());
    }

Field Documentation

$parser

SimpleExcel\SimpleExcel::$parser

Definition at line 59 of file SimpleExcel.php.

$validParserTypes

SimpleExcel\SimpleExcel::$validParserTypes = array('XML', 'CSV', 'TSV', 'HTML', 'JSON')

protected

Definition at line 71 of file SimpleExcel.php.

$validWriterTypes

SimpleExcel\SimpleExcel::$validWriterTypes = array('XML', 'CSV', 'TSV', 'HTML', 'JSON')

protected

Definition at line 72 of file SimpleExcel.php.

$writer

SimpleExcel\SimpleExcel::$writer

Definition at line 65 of file SimpleExcel.php.

---

The documentation for this class was generated from the following file:

• Modules/DataCollection/libs/SimpleExcel/SimpleExcel.php