ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
class.ilCSVWriter.php
Go to the documentation of this file.
1<?php
2/*
3 +-----------------------------------------------------------------------------+
4 | ILIAS open source |
5 +-----------------------------------------------------------------------------+
6 | Copyright (c) 1998-2006 ILIAS open source, University of Cologne |
7 | |
8 | This program is free software; you can redistribute it and/or |
9 | modify it under the terms of the GNU General Public License |
10 | as published by the Free Software Foundation; either version 2 |
11 | of the License, or (at your option) any later version. |
12 | |
13 | This program is distributed in the hope that it will be useful, |
14 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
15 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
16 | GNU General Public License for more details. |
17 | |
18 | You should have received a copy of the GNU General Public License |
19 | along with this program; if not, write to the Free Software |
20 | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
21 +-----------------------------------------------------------------------------+
22*/
23
39{
40 private $csv = '';
41 private $separator = ',';
42 private $delimiter = '"';
43 private $new_line = "\n";
44 private $doUTF8Decoding = false;
45
46 private $first_entry = true;
47
55 public function __construct()
56 {
57 }
65 public function setSeparator($a_sep)
66 {
67 $this->separator = $a_sep;
68 }
69
77 public function setDelimiter($a_del)
78 {
79 $this->delimiter = $a_del;
80 }
81
88 public function addRow()
89 {
90 $this->csv .= $this->new_line;
91 $this->first_entry = true;
92 }
93
101 {
102 $this->doUTF8Decoding = $doUTF8Decoding ? true : false;
103 }
104
112 public function addColumn($a_col)
113 {
114 if (!$this->first_entry) {
115 $this->csv .= $this->separator;
116 }
117 $this->csv .= $this->delimiter;
118 $this->csv .= $this->quote($a_col);
119 $this->csv .= $this->delimiter;
120 $this->first_entry = false;
121 }
122
130 public function getCSVString()
131 {
132 return $this->csv;
133 }
134
143 private function quote($a_str)
144 {
145 return str_replace($this->delimiter, $this->delimiter . $this->delimiter, ($this->doUTF8Decoding) ? utf8_decode($a_str) : $a_str);
146 }
147}
An exception for terminatinating execution or to throw for unit testing.
Helper class to generate CSV files.
quote($a_str)
Quote Delimiter by doubling it This seems to be the standard way in Excel and Openoffice.
__construct()
Constructor.
setSeparator($a_sep)
Set Seperator.
setDoUTF8Decoding($doUTF8Decoding)
set to true if you want to utf8 decode for output.
getCSVString()
Get CSV string.
addColumn($a_col)
Add Column.
setDelimiter($a_del)
Set delimiter.
addRow()
Add new line.