include/parsecsv.lib.php

Show:

inherited

Classes
- \parseCSV

Table of Contents

\parseCSV
jump to top

Package:

Properties


                 $auto_depth= '15'

Default value15Details

Type: n/a


                 $auto_non_chars= '"a-zA-Z0-9\n\r"'

Default value"a-zA-Z0-9\n\r"Details

Type: n/a


                 $auto_preferred= '",;\t.:|"'

Default value",;\t.:|"Details

Type: n/a


                 $conditions= 'null'

Default valuenullDetails

Type: n/a


                 $convert_encoding= 'false'

Default valuefalseDetails

Type: n/a


                 $data= 'array()'

Default valuearray()Details

Type: n/a


                 $delimiter= '',''

Default value','Details

Type: n/a


                 $enclosure= ''"''

Default value'"'Details

Type: n/a


                 $error= '0'

Default value0Details

Type: n/a


                 $error_info= 'array()'

Default valuearray()Details

Type: n/a


                 $fields= 'array()'

Default valuearray()Details

Type: n/a


                 $file= ''

Internal variables

Details

Type: n/a


                 $file_data= ''

Details

Type: n/a


                 $heading= 'true'

Configuration - set these options with $object->var_name = 'value';

Default valuetrueDetails

Type: n/a


                 $input_encoding= ''ISO-8859-1''

Default value'ISO-8859-1'Details

Type: n/a


                 $keep_file_data= 'false'

Default valuefalseDetails

Type: n/a


                 $limit= 'null'

Default valuenullDetails

Type: n/a


                 $linefeed= '"\r\n"'

Default value"\r\n"Details

Type: n/a


                 $offset= 'null'

Default valuenullDetails

Type: n/a


                 $output_delimiter= '',''

Default value','Details

Type: n/a


                 $output_encoding= ''ISO-8859-1''

Default value'ISO-8859-1'Details

Type: n/a


                 $output_filename= ''data.csv''

Default value'data.csv'Details

Type: n/a


                 $sort_by= 'null'

Default valuenullDetails

Type: n/a


                 $sort_reverse= 'false'

Default valuefalseDetails

Type: n/a


                 $sort_type= 'null'

Default valuenullDetails

Type: n/a


                 $titles= 'array()'

Default valuearray()Details

Type: n/a

Methods

_check_count(
           $char,  $array,  $depth,  $preferred
          )
        
        :
          \special

Check if passed info might be delimiter - only used by find_delimiter()

Parameters

Name	Type	Description
$char
$array
$depth
$preferred

Returns

Type	Description
\special	string used for delimiter selection, or false

_check_data(
          \file $file
              =
              null
          )
        
        :
          true

Check file data

Parameters

Name	Type	Description
$file	\file	local filename

Returns

Type	Description
true	or false

_enclose_value(
          \value $value
              =
              null
          )
        
        :
          \Processed

Enclose values if needed - only used by unparse()

Parameters

Name	Type	Description
$value	\value	string to process

Returns

Type	Description
\Processed	value

_rfile(
          \file $file
              =
              null
          )
        
        :
          \Data

Read local file

Parameters

Name	Type	Description
$file	\file	local filename

Returns

Type	Description
\Data	from file, or false on failure

_validate_offset(
          \current_row $current_row
          )
        
        :
          true

Validates if the row is within the offset or not if sorting is disabled

Parameters

Name	Type	Description
$current_row	\current_row	the current row number being processed

Returns

Type	Description
true	of false

_validate_row_condition(
          \row $row, \condition $condition
          )
        
        :
          true

Validate a row against a single condition

Parameters

Name	Type	Description
$row	\row	array with values from a row
$condition	\condition	specified condition that the row must match

Returns

Type	Description
true	of false

_validate_row_conditions(
          \row $row
              =
              array(), \conditions $conditions
              =
              null
          )
        
        :
          true

Validate a row against specified conditions

Parameters

Name	Type	Description
$row	\row	array with values from a row
$conditions	\conditions	specified conditions that the row must match

Returns

Type	Description
true	of false

_wfile(
          \file $file, string $string
              =
              '', \mode $mode
              =
              'wb', \lock $lock
              =
              2
          )
        
        :
          true

Write to local file

Parameters

Name	Type	Description
$file	\file	local filename
$string	string	data to write to file
$mode	\mode	fopen() mode
$lock	\lock	flock() mode

Returns

Type	Description
true	or false

auto(
          \file $file
              =
              null, \parse $parse
              =
              true, \search_depth $search_depth
              =
              null, \preferred $preferred
              =
              null, \enclosure $enclosure
              =
              null
          )
        
        :
          \delimiter

Auto-Detect Delimiter: Find delimiter by analyzing a specific number of rows to determine most probable delimiter character

Parameters

Name	Type	Description
$file	\file	local CSV file
$parse	\parse	true/false parse file directly
$search_depth	\search_depth	number of rows to analyze
$preferred	\preferred	preferred delimiter characters
$enclosure	\enclosure	enclosure character, default is double quote (").

Returns

Type	Description
\delimiter	character

encoding(
          \input $input
              =
              null, \output $output
              =
              null
          )
        
        :
          \nothing

Convert character encoding

Parameters

Name	Type	Description
$input	\input	input character encoding, uses default if left blank
$output	\output	output character encoding, uses default if left blank

Returns

Type	Description
\nothing

load_data(
          \input $input
              =
              null
          )
        
        :
          true

Load local file or string

Parameters

Name	Type	Description
$input	\input	local CSV file

Returns

Type	Description
true	or false

output(
          \filename $filename
              =
              null, \data $data
              =
              array(), \fields $fields
              =
              array(), \delimiter $delimiter
              =
              null
          )
        
        :
          \CSV

Generate CSV based string for output

Parameters

Name	Type	Description
$filename	\filename	if specified, headers and data will be output directly to browser as a downloable file
$data	\data	2D array with data
$fields	\fields	field names
$delimiter	\delimiter	delimiter used to separate data

Returns

Type	Description
\CSV	data using delimiter of choice, or default

parse(
          \input $input
              =
              null,  $offset
              =
              null,  $limit
              =
              null,  $conditions
              =
              null
          )
        
        :
          \nothing

Parse CSV file or string

Parameters

Name	Type	Description
$input	\input	CSV file or string
$offset
$limit
$conditions

Returns

Type	Description
\nothing

parseCSV(
          \input $input
              =
              null,  $offset
              =
              null,  $limit
              =
              null,  $conditions
              =
              null
          )
        
        :
          \nothing

Constructor

Parameters

Name	Type	Description
$input	\input	CSV file or string
$offset
$limit
$conditions

Returns

Type	Description
\nothing

parse_file(
          \file $file
              =
              null
          )
        
        :
          \2D

Read file to string and call parse_string()

Parameters

Name	Type	Description
$file	\file	local CSV file

Returns

Type	Description
\2D	array with CSV data, or false on failure

parse_string(
          \data $data
              =
              null
          )
        
        :
          \2D

Parse CSV strings to arrays

Parameters

Name	Type	Description
$data	\data	CSV string

Returns

Type	Description
\2D	array with CSV data, or false on failure

save(
          \file $file
              =
              null, \data $data
              =
              array(), \append $append
              =
              false, \fields $fields
              =
              array()
          )
        
        :
          true

Save changes, or new file and/or data

Parameters

Name	Type	Description
$file	\file	file to save to
$data	\data	2D array with data
$append	\append	append current data to end of target CSV if exists
$fields	\fields	field names

Returns

Type	Description
true	or false

unparse(
          \data $data
              =
              array(), \fields $fields
              =
              array(), \append $append
              =
              false, \is_php $is_php
              =
              false, \delimiter $delimiter
              =
              null
          )
        
        :
          \CSV

Create CSV data from array

Parameters

Name	Type	Description
$data	\data	2D array with data
$fields	\fields	field names
$append	\append	if true, field names will not be output
$is_php	\is_php	if a php die() call should be put on the first line of the file, this is later ignored when read.
$delimiter	\delimiter	field delimiter to use

Returns

Type	Description
\CSV	data (text string)

include/parsecsv.lib.php

\parseCSVjump to top

Properties

Methods

\parseCSV
jump to top