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 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101
|
package Perinci::Object::EnvResultTable;
our $DATE = '2021-01-02'; # DATE
our $VERSION = '0.311'; # VERSION
use 5.010;
use strict;
use warnings;
use parent qw(Perinci::Object::EnvResult);
sub add_field {
my ($self, $name, %attrs) = @_;
${$self}->[3]{'table.fields'} //= [];
push @{ ${$self}->[3]{'table.fields'} }, $name;
}
1;
# ABSTRACT: Represent enveloped result (table)
__END__
=pod
=encoding UTF-8
=head1 NAME
Perinci::Object::EnvResultTable - Represent enveloped result (table)
=head1 VERSION
This document describes version 0.311 of Perinci::Object::EnvResultTable (from Perl distribution Perinci-Object), released on 2020-01-02.
=head1 SYNOPSIS
use Perinci::Object::EnvResultTable;
sub myfunc {
...
my $envres = Perinci::Object::EnvResultTable->new;
# add fields
$envres->add_field('foo');
$envres->add_field('foo');
# finally, return the result
return $envres->as_struct;
}
=head1 DESCRIPTION
This class is a subclass of L<Perinci::Object::EnvResult> and provides
convenience methods when you want to return table data.
=head1 METHODS
=head2 new($res) => OBJECT
Create a new object from C<$res> enveloped result array.
=head2 $envres->add_field($name, %attrs)
Add a table field. This will create/push an entry to the C<table.fields> result
metadata array.
=head1 HOMEPAGE
Please visit the project's homepage at L<https://metacpan.org/release/Perinci-Object>.
=head1 SOURCE
Source repository is at L<https://github.com/perlancar/perl-Perinci-Object>.
=head1 BUGS
Please report any bugs or feature requests on the bugtracker website L<https://github.com/perlancar/perl-Perinci-Object/issues>
When submitting a bug or request, please include a test-file or a
patch to an existing test-file that illustrates the bug or desired
feature.
=head1 SEE ALSO
L<Perinci::Object>
L<Perinci::Object::EnvResult>
=head1 AUTHOR
perlancar <perlancar@cpan.org>
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2021, 2017, 2016, 2015, 2014, 2013, 2012, 2011 by perlancar@cpan.org.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|