/ 
Catalyst-View-CSV-0.01 UNAUTHORIZED RELEASE
/ Catalyst::View::CSV

NAME

Catalyst::View::CSV - Comma separated values or Delimiter separated values for your data

VERSION

Version 0.01

SYNOPSIS

# lib/MyApp/View/CSV.pm
package MyApp::View::CSV;
use base qw( Catalyst::View::CSV );
1;

# lib/MyApp/Controller/SomeController.pm
sub example_action_1 : Local {
  my ($self, $c) = @_;

  # Array reference of array references.
  my $data = [
    ['col 1','col 2','col ...','col N'], # row 1
    ['col 1','col 2','col ...','col N'], # row 2
    ['col 1','col 2','col ...','col N'], # row ...
    ['col 1','col 2','col ...','col N']  # row N
  ];

  # To output your data in comma seperated values just pass your array by reference into the 'csv' key of the stash
  $c->stash->{'csv'} = $data;

  # Finally forward processing to the CSV View
  $c->forward('MyApp::View::CSV');
}

# Other ways of storing data
sub example_action_2 : Local {
  my ($self, $c) = @_;

  # Array of array references
  my @data;

  push(@data,['col 1','col 2','col ...','col N']); # row 1
  push(@data,['col 1','col 2','col ...','col N']); # row 2
  push(@data,['col 1','col 2','col ...','col N']); # row ...
  push(@data,['col 1','col 2','col ...','col N']); # row N

  # OR to produce a single column of data you can simply do the following 
  my @data = (
              'col 1 row 1',
              'col 1 row 2',
              'col 1 row ...',
              'col 1 row N'
             );

  $c->stash->{'csv'} = \@data;

  $c->forward('MyApp::View::CSV');
}

# Available Options to produce other types of delimiter seperated output
sub  example_action_3 : Local {
  my ($self, $c) = @_;

  my $data = [
    ['col 1','col 2','col ...','col N'], # row 1
    ['col 1','col 2','col ...','col N'] # row 2
  ];

  # You can change any of the aspects of a delimiter seperated values format by storing them in the appropriate stash key
  # This is an example of tab seperated values for instance

  $c->stash->{'quote_char'} = '"'; # default: '"'

  $c->stash->{'escape_char'} = '"'; # default: '"'

  $c->stash->{'sep_char'} = '\t'; # default: ','

  $c->stash->{'eol'} = "\n"; # default: "\n"

  $c->stash->{'csv'} = $data;
}

MIME MEDIA TYPE

If the Content-Type HTTP Header is not set, it will default to 'text/csv'.

# Example of setting your own Content-Type
$c->res->headers->header('Content-Type' => 'text/plain');

# Forward processing to CSV View with a text/plain Content-Type
$c->forward("MyApp::View::CSV");

OPTIONS

quote_char

Determines what value will be enclosed within if it contains whitespace or the delimiter character. DEFAULT: '"'

$c->stash->{'quote_char'} = '/';
escape_char

Determines what value will be to escape any delimiter's found in a column. DEFAULT: '"'

$c->stash->{'escape_char'} = '/';
sep_char

Determines the separator between columns. DEFAULT: ','

$c->stash->{'sep_char'} = '|';
eol

Any characters defined in eol will be placed at the end of a row. DEFAULT: '\n'

$c->stash->{'eol'} = '\0';
csv

The data that will be processed into delimiter separated values format is stored here. The data should be an array ref of array refs of scalars or an array ref of scalars. Note: if nothing is found in csv, the stash is searched and any array references found will be used as the data instead.

 # Array ref of array refs of scalars
 my $data = [
   ['apple','banana','pear'],
   ['red','yellow','green']
 ];

 $c->stash->{csv} = $data;

 # Array ref of scalars
 my @data = ('Jan','Feb','Mar','Apr');

 $c->stash->{csv} = \@data;

SUBROUTINES

process

This method will be called by Catalyst if it is asked to forward to a component without a specified action.

render

Allows others to use this view for much more fine-grained content generation.

_csv

Subroutine that actually produces the delimiter separated values. Intended to be private in scope to this module.

AUTHOR

Travis Chase, <gaudeon at cpan.org>

BUGS

Please report any bugs or feature requests to bug-catalyst-view-csv at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Catalyst-View-CSV. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Catalyst::View::CSV

You can also look for information at:

SEE ALSO

Catalyst Text::CSV

COPYRIGHT & LICENSE

Copyright 2008 Travis Chase, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.