File Source for CSVFiles.class.php

<?php
/**
* For including this file you have to define the constant "CLASSPATH".
* Because every include in the framework depends on the CLASSPATH definition.
* The CLASSPATH means the relative path to the folder that contains the
* framework GilliGan.
*
* @package filesystem
*/
if( !defined( "CLASSPATH" ) )
{
echo "<h3>You have to define the constant CLASSPATH!</h3>\r\n";
echo "Example: define( 'CLASSPATH', '../path/to/classes/' );\r\n";
exit();
}
/**
*
*/
include_once( CLASSPATH."filesystem/Files.class.php" );
/**
*
*/
include_once( CLASSPATH."core/Arrays.class.php" );
/**
*
*/
include_once( CLASSPATH."core/Strings.class.php" );
/**
* A class to manage files with comma separated values.
*
* @package filesystem
* @version 0.1.22
* @since 0.9.0.7
* @author Daniel Plücken <daniel@debakel.net>
* @license http://www.gnu.org/copyleft/lesser.html
* GNU Lesser General Public License
* @copyright Copyright (c) 2006 Daniel Plücken <daniel@debakel.net>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General
* Public License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place, Suite 330,
* Boston, MA 02111-1307 USA
*/
class CSVFiles extends Files
{
/**
* @access public
* @var char $separator_chart
*/
var $separator_char = ";";
/**
* @access public
* @var char $enclosing_char
*/
var $enclosing_char = "\"";
/**
* @access public
* @var char $escape_char
*/
var $escape_char = "\\\\";
/**
* @access public
* @var char line_terminator_char
*/
var $line_terminator_char = "\r\n";
/**
* @access public
* @var array $content_arr
*/
var $content_arr = array();
/**
* @access public
* @var integer $cols
*/
var $cols = 0;
/**
* Constructor
*
* @access public
* @version 1.0
* @since 0.1.0
*
* @param string $path_and_filename
* @or
* @param string $path
* @param string $filename
*
* @return CSVFiles
*/
function CSVFiles( $path, $filename = "" )
{
if( empty( $filename ) )
{
$tmpArr = FilesystemToolkit
::separatePathAndFile( $path );
$path = $tmpArr[0];
$filename = $tmpArr[1];
}
$this->path = $path;
$this->filename = $filename;
}
/**
* Stores the number of columns of this csv-file object.
*
* @access public
* @version 1.0
* @since 0.1.2
*
* @return void
*/
function setCols( $int_cols )
{ $this->cols = $int_cols; }
/**
* Returns the number of columns of this csvfile object.
*
* @access public
* @version 1.0
* @since 0.1.2
*
* @return integer
*/
function getCols()
{ return $this->cols; }
/**
* Stores the number of columns of this csv-file object.
*
* @access public
* @version 1.0
* @since 0.1.2
*
* @param string $str_val
*
* @return void
*/
function addCol( $str_val )
{
if ( empty( $this->cols ) )
echo "To insert a value in a cell of an csv-file, set the number of "
."columns in this file first!";
else
{
$int_actual_row = count( $this->content_arr ) - 1;
if ( $int_actual_row < 0 )
$int_actual_row = 0;
$int_next_col = count( $this->content_arr[$int_actual_row] );
if ( $int_next_col >= $this->cols )
{
$int_next_col = 0;
$int_actual_row++;
}
$this->content_arr[$int_actual_row][$int_next_col] = $str_val;
}
}
/**
* Sets the header for an excel output.
*
* @access public
* @version 1.0
* @since 0.1.22
*
* @return void
*/
function headerForExcel()
{
header( "Content-type: application/x-msexcel" );
header( "Content-disposition: attachment; filename=".$this->filename );
header( "Pragma: no-cache" );
header( "Expires: 0" );
}
/**
* Returns the content of this file object.
*
* @access public
* @version 1.0
* @since 0.1.2
*
* @return string
*/
function &getContent ()
{
if(
empty( $this->content )
|| Arrays::is_empty( $this->content_arr )
)
$this->load();
for ( $i = 0; $i < count( $this->content_arr ); $i++ )
{
if ( $i > 0 )
$this->content .= $this->line_terminator_char;
for ( $k = 0; $k < count( $this->content_arr[$i] ); $k++ )
{
if ( $k > 0 )
$this->content .= $this->separator_char;
$this->content .= $this->enclosing_char
.Strings::escapeLineBreaks(
addslashes( $this->content_arr[$i][$k] )
)
.$this->enclosing_char;
}
}
return $this->content;
}
} // End of class CSVFiles
?>

Source for file CSVFiles.class.php