ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
SimpleExcel\Writer\BaseWriter Class Reference
+ Inheritance diagram for SimpleExcel\Writer\BaseWriter:
+ Collaboration diagram for SimpleExcel\Writer\BaseWriter:

Public Member Functions

 __construct ()
 
 addRow ($values)
 Adding row data to table. More...
 
 saveString ()
 Get document content as string. More...
 
 saveFile ($filename, $target=NULL)
 Export the document. More...
 
 setData ($values)
 Set tabular data. More...
 
 addRow ($values)
 
 saveString ()
 
 saveFile ($filename, $target)
 
 setData ($values)
 

Protected Attributes

 $tabl_data
 
 $content_type = 'text'
 
 $file_extension = 'txt'
 

Detailed Description

Definition at line 11 of file BaseWriter.php.

Constructor & Destructor Documentation

◆ __construct()

SimpleExcel\Writer\BaseWriter::__construct ( )
Returns
void

Reimplemented in SimpleExcel\Writer\XMLWriter.

Definition at line 40 of file BaseWriter.php.

40 {
41 $this->tabl_data = array();
42 }

Member Function Documentation

◆ addRow()

SimpleExcel\Writer\BaseWriter::addRow (   $values)

Adding row data to table.

Parameters
array$valuesAn array contains ordered value for every cell
Returns
void

Implements SimpleExcel\Writer\IWriter.

Reimplemented in SimpleExcel\Writer\XMLWriter.

Definition at line 50 of file BaseWriter.php.

50 {
51 if (!is_array($values)) {
52 $values = array($values);
53 }
54 array_push($this->tabl_data, $values);
55 }

◆ saveFile()

SimpleExcel\Writer\BaseWriter::saveFile (   $filename,
  $target = NULL 
)

Export the document.

Parameters
string$filenameName for the saved file (extension will be set automatically)
string$targetSave location
Returns
void

Implements SimpleExcel\Writer\IWriter.

Definition at line 80 of file BaseWriter.php.

80 {
81
82 if (!isset($filename)) {
83 $filename = date('YmdHis');
84 }
85 if (!isset($target)) {
86 // write output to browser
87 $target = 'php://output';
88 }
89
90 // set HTTP response header
91 header('Content-Type: '.$this->content_type);
92 header('Content-Disposition: attachment; filename='.$filename.'.'.$this->file_extension);
93
94 $fp = fopen($target, 'w');
95 fwrite($fp, $this->saveString());
96 fclose($fp);
97
98 if ($target == 'php://output') {
99 // since there must be no data below
100 exit();
101 }
102 }
$filename
Definition: buildRTE.php:89
saveString()
Get document content as string.
Definition: BaseWriter.php:62
exit
Definition: login.php:54

References $filename, exit, and SimpleExcel\Writer\BaseWriter\saveString().

+ Here is the call graph for this function:

◆ saveString()

SimpleExcel\Writer\BaseWriter::saveString ( )

Get document content as string.

Returns
string Content of document

Implements SimpleExcel\Writer\IWriter.

Reimplemented in SimpleExcel\Writer\CSVWriter, SimpleExcel\Writer\HTMLWriter, SimpleExcel\Writer\JSONWriter, and SimpleExcel\Writer\XMLWriter.

Definition at line 62 of file BaseWriter.php.

62 {
63 $content = '';
64 foreach ($this->tabl_data as $row) {
65 foreach ($row as $cell) {
66 $content .= $cell.'\t';
67 }
68 $content .= '\n';
69 }
70 return $content;
71 }

References $row.

Referenced by SimpleExcel\Writer\BaseWriter\saveFile().

+ Here is the caller graph for this function:

◆ setData()

SimpleExcel\Writer\BaseWriter::setData (   $values)

Set tabular data.

Parameters
array$valuesAn array contains ordered value of arrays for all fields
Returns
void

Implements SimpleExcel\Writer\IWriter.

Reimplemented in SimpleExcel\Writer\XMLWriter.

Definition at line 110 of file BaseWriter.php.

110 {
111 if(!is_array($values)){
112 $values = array($values);
113 }
114 $this->tabl_data = $values;
115 }

Field Documentation

◆ $content_type

SimpleExcel\Writer\BaseWriter::$content_type = 'text'
protected

Definition at line 27 of file BaseWriter.php.

◆ $file_extension

SimpleExcel\Writer\BaseWriter::$file_extension = 'txt'
protected

Definition at line 35 of file BaseWriter.php.

◆ $tabl_data

SimpleExcel\Writer\BaseWriter::$tabl_data
protected

Definition at line 19 of file BaseWriter.php.

Referenced by SimpleExcel\Writer\XMLWriter\addRow().


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