|
Text::CSV_XS - comma-separated values manipulation routines |
Text::CSV_XS - comma-separated values manipulation routines
use Text::CSV_XS;
$csv = Text::CSV_XS->new(); # create a new object $csv = Text::CSV_XS->new(\%attr); # create a new object
$status = $csv->combine(@columns); # combine columns into a string $line = $csv->string(); # get the combined string
$status = $csv->parse($line); # parse a CSV string into fields @columns = $csv->fields(); # get the parsed fields
$status = $csv->status(); # get the most recent status $bad_argument = $csv->error_input(); # get the most recent bad argument
$status = $csv->print($io, $columns); # Write an array of fields immediately
# to a file $io
$columns = $csv->getline($io); # Read a line from file $io, parse it
# and return an array ref of fields
$csv->types(\@t_array); # Set column types
Text::CSV_XS provides facilities for the composition and decomposition of comma-separated values. An instance of the Text::CSV_XS class can combine fields into a CSV string and parse a CSV string into fields.
version()new(\%attr)\%attr.
Currently the following attributes are available:
"). A value of undef suppresses
quote chars. (For simple cases only).
undef (nothing,
default), "\012" (Line Feed) or "\015\012" (Carriage Return,
Line Feed)
")
,)
"0.) By default this feature is off.
To sum it up,
$csv = Text::CSV_XS->new();
is equivalent to
$csv = Text::CSV_XS->new({
'quote_char' => '"',
'escape_char' => '"',
'sep_char' => ',',
'binary' => 0
});
$status = $csv->combine(@columns);
This object function constructs a CSV string from the arguments, returning
success or failure. Failure can result from lack of arguments or an argument
containing an invalid character. Upon success, string() can be called to
retrieve the resultant CSV string. Upon failure, the value returned by
string() is undefined and error_input() can be called to retrieve an
invalid argument.
$status = $csv->print($io, $columns);
Similar to combine, but it expects an array ref as input (not an array!) and the resulting string is not really created, but immediately written to the $io object, typically an IO handle or any other object that offers a print method. Note, this implies that the following is wrong:
open(FILE, ">whatever"); $status = $csv->print(\*FILE, $columns);
The glob \*FILE is not an object, thus it doesn't have a print
method. The solution is to use an IO::File object or to hide the
glob behind an IO::Wrap object. See the IO::File(3) manpage and the IO::Wrap(3) manpage
for details.
For performance reasons the print method doesn't create a result string. In particular the $csv->string(), $csv->status(), $csv-fields()> and $csv->error_input() methods are meaningless after executing this method.
$line = $csv->string();
This object function returns the input to parse() or the resultant CSV
string of combine(), whichever was called more recently.
$status = $csv->parse($line);
This object function decomposes a CSV string into fields, returning
success or failure. Failure can result from a lack of argument or the
given CSV string is improperly formatted. Upon success, fields() can
be called to retrieve the decomposed fields . Upon failure, the value
returned by fields() is undefined and error_input() can be called
to retrieve the invalid argument.
You may use the types() method for setting column types. See the description below.
$columns = $csv->getline($io);
This is the counterpart to print, like parse is the counterpart to
combine: It reads a row from the IO object $io using $io->getline()
and parses this row into an array ref. This array ref is returned
by the function or undef for failure.
The $csv->string(), $csv->fields() and $csv->status() methods are meaningless, again.
$csv->types(\@tref);
This method is used to force that columns are of a given type. For example, if you have an integer column, two double columns and a string column, then you might do a
$csv->types([Text::CSV_XS::IV(),
Text::CSV_XS::NV(),
Text::CSV_XS::NV(),
Text::CSV_XS::PV()]);
Column types are used only for decoding columns, in other words by the parse() and getline() methods.
You can unset column types by doing a
$csv->types(undef);
or fetch the current type settings with
$types = $csv->types();
@columns = $csv->fields();
This object function returns the input to combine() or the resultant
decomposed fields of parse(), whichever was called more recently.
$status = $csv->status();
This object function returns success (or failure) of combine() or
parse(), whichever was called more recently.
$bad_argument = $csv->error_input();
This object function returns the erroneous argument (if it exists) of
combine() or parse(), whichever was called more recently.
require Text::CSV_XS;
my $csv = Text::CSV_XS->new;
my $column = '';
my $sample_input_string = '"I said, ""Hi!""",Yes,"",2.34,,"1.09"';
if ($csv->parse($sample_input_string)) {
my @field = $csv->fields;
my $count = 0;
for $column (@field) {
print ++$count, " => ", $column, "\n";
}
print "\n";
} else {
my $err = $csv->error_input;
print "parse() failed on argument: ", $err, "\n";
}
my @sample_input_fields = ('You said, "Hello!"',
5.67,
'Surely',
'',
'3.14159');
if ($csv->combine(@sample_input_fields)) {
my $string = $csv->string;
print $string, "\n";
} else {
my $err = $csv->error_input;
print "combine() failed on argument: ", $err, "\n";
}
This module is based upon a working definition of CSV format which may not be the most general.
"0 for representation of a
NUL byte.
Alan Citterman <alan@mfgrtl.com> wrote the original Perl module. Please don't send mail concerning Text::CSV_XS to Alan, as he's not involved in the C part which is now the main part of the module.
Jochen Wiedmann <joe@ispsoft.de> rewrote the encoding and decoding in C by implementing a simple finite-state machine and added the variable quote, escape and separator characters, the binary mode and the print and getline methods.
perl(1), the IO::File(3) manpage, the IO::Wrap(3) manpage
|
Text::CSV_XS - comma-separated values manipulation routines |