View on
MetaCPAN
Travis Chase > Catalyst-View-Download-0.09 > Catalyst::View::Download::CSV

Download:
Catalyst-View-Download-0.09.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  3
Open  0
View/Report Bugs
Module Version: 0.05   Source  

NAME ^

Catalyst::View::Download::CSV

VERSION ^

0.05

SYNOPSIS ^

    # lib/MyApp/View/Download/CSV.pm
    package MyApp::View::Download::CSV;
    use base qw( Catalyst::View::Download::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 pass your array by reference
        # into hatever stash key you have defined (default is 'csv'). Content passed
        # via the stash must be passed in a hashref in the key labeled 'data'.
        $c->stash->{'csv'} = $data;

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

DESCRIPTION ^

Takes a nested array and outputs CSV formatted content.

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.

CONFIG ^

stash_key

Determines the key in the stash this view will look for when attempting to retrieve data to process. If this key isn't found it will then look at the stash as a whole, find any array references and process them. Data passed into the defined stash_key must be a HASHREF with at least the key 'data' existing with the nested array of data to create a CSV from.

        $c->view('MyApp::View::Download::CSV')->config->{'stash_key'} = 'data';
quote_char

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

  $c->view('MyApp::View::Download::CSV')->config->{'quote_char'} = '/';
escape_char

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

  $c->view('MyApp::View::Download::CSV')->config->{'escape_char'} = '/';
sep_char

Determines the separator between columns. DEFAULT: ','

  $c->view('MyApp::View::Download::CSV')->config->{'sep_char'} = '|';
eol

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

  $c->view('MyApp::View::Download::CSV')->config->{'eol'} = '\0';

AUTHOR ^

Travis Chase, <gaudeon at cpan dot org>

SEE ALSO ^

Catalyst Catalyst::View Catalyst::View::Download Text::CSV

LICENSE ^

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

syntax highlighting: