Noalyss_Csv Class Reference

Manage the CSV : manage files and write CSV record. More...

Collaboration diagram for Noalyss_Csv:

Public Member Functions
	__construct ($p_filename)
	add ($p_item, $p_type="text")
	Add column to export to csv , the string are enclosed with double-quote,.
	get_element ()
	get_encoding ()
	get_filename ()
	get_sep_dec ()
	get_sep_field ()
	get_size ()
	send_header ()
	Send an header for CSV , the filename is corrected.
	set_element ($element)
	set_encoding ($encoding)
	set_filename ($filename)
	set_sep_dec ($sep_dec)
	set_sep_field ($sep_field)
	set_size ($size)
	write ()
	the string are enclosed with double-quote, we remove problematic character and the number are formatted.
	write_header ($p_array)
	write header

Static Public Member Functions
static	csv2table ($string)
	convert CSV strings (content of a file) into HTML table,

Protected Member Functions
	clean ()
	clean the row
	correct_name ()
	Correct the name of the file , remove forbidden character and add extension and date.
	encode ($str)
	nb ($p_number)
	format the number for the CSV export

Private Attributes
	$element
	$encoding
	$filename
	$sep_dec
	$sep_field
	$size

Detailed Description

Manage the CSV : manage files and write CSV record.

Definition at line 33 of file noalyss_csv.class.php.

Constructor & Destructor Documentation

__construct()

Noalyss_Csv::__construct

(

$p_filename

)

Definition at line 43 of file noalyss_csv.class.php.

    {
        $this->filename=$p_filename;
        $this->element=array();
        $this->size=0;
     
        $a_field=[';',','];
        $this->sep_field=$a_field[$_SESSION[SESSION_KEY.'csv_fieldsep']];
        $a_field=['.',','];
        $this->sep_dec=$a_field[$_SESSION[SESSION_KEY.'csv_decimal']];
        $this->encoding=$_SESSION[SESSION_KEY.'csv_encoding'];
    
    }

References size.

Member Function Documentation

add()

Noalyss_Csv::add	(		$p_item,
			$p_type = "text" )

Add column to export to csv , the string are enclosed with double-quote,.

Parameters

$p_item	value to export
$p_type	must be text(default) or number

Exceptions

Exception

Definition at line 123 of file noalyss_csv.class.php.

    {
        if ( ! in_array($p_type, array("text","number"))) {
                throw new Exception("NOALYSS_CSV::ADD");
        }
        $this->element[$this->size]['value']=$p_item;
        $this->element[$this->size]['type']=$p_type;
        $this->size++;
    }

References $p_type, $size, and size.

clean()

Noalyss_Csv::clean ( )

protected

clean the row

Definition at line 167 of file noalyss_csv.class.php.

    {
        $this->element=array();
        $this->size=0;
    }

References size.

Referenced by write().

correct_name()

Noalyss_Csv::correct_name ( )

protected

Correct the name of the file , remove forbidden character and add extension and date.

Definition at line 62 of file noalyss_csv.class.php.

    {
        if (trim(strlen($this->filename))==0) {
            record_log('CSV->correct_name filename is empty');
            throw new Exception('CSV-CORRECT_NAME');
        }
        $this->filename.="-".date("ymd-Hi");
        $this->filename.=".csv";
        
        $this->filename=noalyss_str_replace(";", "", $this->filename);
        $this->filename=noalyss_str_replace("/", "", $this->filename);
        $this->filename=noalyss_str_replace(":", "", $this->filename);
        $this->filename=noalyss_str_replace("*", "", $this->filename);
        $this->filename=noalyss_str_replace(" ", "_", $this->filename);
        $this->filename=strtolower($this->filename);
    }

References noalyss_str_replace(), and record_log().

Referenced by send_header().

Here is the call graph for this function:

csv2table()

static Noalyss_Csv::csv2table ( $string )

static

convert CSV strings (content of a file) into HTML table,

Parameters

$string

CSV files

Definition at line 304 of file noalyss_csv.class.php.

    {
        $a_field=[';',','];
        $sep_field=$a_field[$_SESSION[SESSION_KEY.'csv_fieldsep']];
        $a_field=['.',','];
        $sep_dec=$a_field[$_SESSION[SESSION_KEY.'csv_decimal']];
        $encoding=$_SESSION[SESSION_KEY.'csv_encoding'];
 
        $aRow=explode("\r\n", $string);
 
        echo '<table class="result">';
        foreach ($aRow as $row) {
            echo '<tr>';
            $aCol=explode($sep_field, $row);
            foreach ($aCol as $col)  {
                echo '<td>';
                echo h($col);
                echo '</td>';
            }
            echo '</tr>';
 
        }
        echo '</table>';
    }

References $aRow, $encoding, $row, $sep_dec, $sep_field, $string, and h.

encode()

Noalyss_Csv::encode ( $str )

protected

Definition at line 187 of file noalyss_csv.class.php.

   {
       if ($this->encoding=="utf8") return $str;
       if ($this->encoding=="latin1") return mb_convert_encoding($str,'ISO-8859-1','UTF-8');
       throw new Exception(_("Encodage invalide"));
   }

References $str, and _.

get_element()

Noalyss_Csv::get_element

(

)

Returns

array

Definition at line 214 of file noalyss_csv.class.php.

    {
        return $this->element;
        return $this;
    }

References $element.

get_encoding()

Noalyss_Csv::get_encoding

(

)

Returns

mixed

Definition at line 268 of file noalyss_csv.class.php.

    {
        return $this->encoding;
        return $this;
    }

References $encoding.

get_filename()

Noalyss_Csv::get_filename

(

)

Returns

mixed

Definition at line 196 of file noalyss_csv.class.php.

    {
        return $this->filename;
        return $this;
    }

References $filename.

get_sep_dec()

Noalyss_Csv::get_sep_dec

(

)

Returns

mixed

Definition at line 250 of file noalyss_csv.class.php.

    {
        return $this->sep_dec;
        return $this;
    }

References $sep_dec.

get_sep_field()

Noalyss_Csv::get_sep_field

(

)

Returns

mixed

Definition at line 232 of file noalyss_csv.class.php.

    {
        return $this->sep_field;
        return $this;
    }

References $sep_field.

get_size()

Noalyss_Csv::get_size

(

)

Returns

int

Definition at line 286 of file noalyss_csv.class.php.

    {
        return $this->size;
        return $this;
    }

References $size.

nb()

Noalyss_Csv::nb ( $p_number )

protected

format the number for the CSV export

Parameters

$p_number

number

Definition at line 176 of file noalyss_csv.class.php.

   {
       $p_number=noalyss_trim($p_number);
       if ($p_number=="") {return $p_number;}
       if ( isNumber($p_number) == 1 ) {
            $r=number_format($p_number, 4, $this->sep_dec,'');
       } else {
           $r=$p_number;
       }
       return $r;
   }

References $r, isNumber(), and noalyss_trim().

Here is the call graph for this function:

send_header()

Noalyss_Csv::send_header

(

)

Send an header for CSV , the filename is corrected.

If TEST_UNIT is defined, the function is called from a test file (located in scenario , see manual )and no header are requested

Definition at line 83 of file noalyss_csv.class.php.

    {
        $this->correct_name();
        if ( defined('TEST_UNIT')) {
 
            return;
        }
        header('Pragma: public');
        header('Content-type: application/csv');
        header("Content-Disposition: attachment;filename=\"{$this->filename}\"",
                FALSE);
        header('Cache-Control: no-store, no-cache, must-revalidate');
        header('Expires: Sun, 1 Jan 2000 12:00:00 GMT');
        header('Last-Modified: '.gmdate('D, d M Y H:i:s').'GMT');
    }

References correct_name().

Here is the call graph for this function:

set_element()

Noalyss_Csv::set_element

(

$element

)

Parameters

array

$element

Definition at line 223 of file noalyss_csv.class.php.

    {
        $this->element = $element;
        return $this;
    }

References $element.

set_encoding()

Noalyss_Csv::set_encoding

(

$encoding

)

Parameters

mixed

$encoding

Definition at line 277 of file noalyss_csv.class.php.

    {
        $this->encoding = $encoding;
        return $this;
    }

References $encoding.

set_filename()

Noalyss_Csv::set_filename

(

$filename

)

Parameters

mixed

$filename

Definition at line 205 of file noalyss_csv.class.php.

    {
        $this->filename = $filename;
        return $this;
    }

References $filename.

set_sep_dec()

Noalyss_Csv::set_sep_dec

(

$sep_dec

)

Parameters

mixed

$sep_dec

Definition at line 259 of file noalyss_csv.class.php.

    {
        $this->sep_dec = $sep_dec;
        return $this;
    }

References $sep_dec.

set_sep_field()

Noalyss_Csv::set_sep_field

(

$sep_field

)

Parameters

mixed

$sep_field

Definition at line 241 of file noalyss_csv.class.php.

    {
        $this->sep_field = $sep_field;
        return $this;
    }

References $sep_field.

set_size()

Noalyss_Csv::set_size

(

$size

)

Parameters

int

$size

Definition at line 295 of file noalyss_csv.class.php.

    {
        $this->size = $size;
        return $this;
    }

References $size, and size.

write()

Noalyss_Csv::write

(

)

the string are enclosed with double-quote, we remove problematic character and the number are formatted.

Clean the row after exporting

Returns

nothing

Definition at line 139 of file noalyss_csv.class.php.

    {
        if ($this->size == 0 ) return;
        $sep="";
        for ($i=0;$i < $this->size;$i++)
        {
            if ($this->element[$i]['type'] == 'number' )
            {
                printf($sep.'%s', $this->nb($this->element[$i]['value']));
            }
            else
            {
                $export=($this->element[$i]['value']==null)?"":$this->element[$i]['value'];
                // remove break-line, 
                $export=noalyss_str_replace("\n"," ",$export);
                $export=noalyss_str_replace("\r"," ", $export);
                // remove double quote
                $export=noalyss_str_replace('"',"", $export);
                printf($sep.'"%s"', $this->encode($export));
            }
            $sep=$this->sep_field;
        }
        printf("\r\n");
        $this->clean();
    }

References $export, $i, $sep, $sep_field, $size, clean(), noalyss_str_replace(), and size.

Here is the call graph for this function:

write_header()

Noalyss_Csv::write_header

(

$p_array

)

write header

Parameters

array

$p_array

Array of 1 dimension with the contains of a row

Definition at line 104 of file noalyss_csv.class.php.

    {
        $size_array=count($p_array);
        $sep="";
        for ($i=0; $i<$size_array; $i++)
        {
            
            printf($sep.'"%s"', $this->encode($p_array[$i]));
            $sep=$this->sep_field;
        }
        printf("\r\n");
    }

References $i, $p_array, $sep, and $sep_field.

Field Documentation

$element

Noalyss_Csv::$element

private

Definition at line 37 of file noalyss_csv.class.php.

Referenced by get_element(), and set_element().

$encoding

Noalyss_Csv::$encoding

private

Definition at line 40 of file noalyss_csv.class.php.

Referenced by csv2table(), get_encoding(), and set_encoding().

$filename

Noalyss_Csv::$filename

private

Definition at line 36 of file noalyss_csv.class.php.

Referenced by get_filename(), and set_filename().

$sep_dec

Noalyss_Csv::$sep_dec

private

Definition at line 39 of file noalyss_csv.class.php.

Referenced by csv2table(), get_sep_dec(), and set_sep_dec().

$sep_field

Noalyss_Csv::$sep_field

private

Definition at line 38 of file noalyss_csv.class.php.

Referenced by csv2table(), get_sep_field(), set_sep_field(), write(), and write_header().

$size

Noalyss_Csv::$size

private

Definition at line 41 of file noalyss_csv.class.php.

Referenced by add(), get_size(), set_size(), and write().

---

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

• include/lib/noalyss_csv.class.php