summaryrefslogtreecommitdiffstats
path: root/lib/Spreadsheet/Template/Writer.pm
blob: 4bf41eea5d9a43c7e2b2518c7c58ad593181c15b (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
package Spreadsheet::Template::Writer;
use Moose::Role;
# ABSTRACT: role for classes which write spreadsheet files from a template

requires 'write';

=head1 SYNOPSIS

  package MyWriter;
  use Moose;

  with 'Spreadsheet::Template::Writer';

  sub write {
      # ...
  }

=head1 DESCRIPTION

This role should be consumed by any class which will be used as the
C<writer_class> in a L<Spreadsheet::Template> instance.

=cut

=method write($data)

This method is required to be implemented by any classes which consume this
role. It should use the data in C<$data> (in the format described in
L<Spreadsheet::Template>) to create a new spreadsheet file containing that
data. It should return a string containing the binary contents of the
spreadsheet file.

=cut

no Moose::Role;

1;