From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

SKIM / Data-InfoBox-0.06 / lib / Data / InfoBox.pm 

            

              
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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157

              
package Data::InfoBox;
use strict;
use warnings;
use Mo qw(build is);
use Mo::utils 0.21 qw(check_array_object check_array_required);
our $VERSION = 0.06;
has items => (
        is => 'ro',
);
sub BUILD {
        my $self = shift;
        # Check items.
        check_array_object($self, 'items', 'Data::InfoBox::Item');
        check_array_required($self, 'items');
        return;
}
1;
__END__
=pod
=encoding utf8
=head1 NAME
Data::InfoBox - Data object for info box.
=head1 DESCRIPTION
Data object for definition of common infobox which contains lines with
informations. The informations are in form of text description (optionaly with icon and link).
=head1 SYNOPSIS
 use Data::InfoBox;
 my $obj = Data::InfoBox->new(%params);
 my $items_ar = $obj->items;
=head1 METHODS
=head2 C<new>
 my $obj = Data::InfoBox->new(%params);
Constructor.
=over 8
=item * C<items>
List of L<Data::InfoBox::Item> items. Must be as reference to array.
It's required.
=back
Returns instance of object.
=head2 C<items>
 my $items_ar = $obj->items;
Get list of items in info box.
Returns reference to array with L<Data::InfoBox::Item> objects.
=head1 EXAMPLE
=for comment filename=create_infobox_object_and_print.pl
 use strict;
 use warnings;
 use Data::InfoBox;
 use Data::InfoBox::Item;
 use Data::Text::Simple;
 my $obj = Data::InfoBox->new(
         'items' => [
                Data::InfoBox::Item->new(
                        'text' => Data::Text::Simple->new(
                                'text' => 'First item',
                        ),
                ),
                Data::InfoBox::Item->new(
                        'text' => Data::Text::Simple->new(
                                'text' => 'Second item',
                        ),
                ),
         ],
 );
 # Print out.
 my $num = 0;
 foreach my $item (@{$obj->items}) {
         $num++;
         print "Item $num: ".$item->text->text."\n";
 }
 # Output:
 # Item 1: First item
 # Item 2: Second item
=head1 DEPENDENCIES
L<Mo>,
L<Mo::utils>.
=head1 SEE ALSO
=over
=item L<Data::InfoBox::Item>
Data object for info box item.
=item L<Tags::HTML::InfoBox>
Tags helper for HTML info box.
=item L<Test::Shared::Fixture::Data::InfoBox::Street>
Street info box fixture.
=back
=head1 REPOSITORY
L<https://github.com/michal-josef-spacek/Data-InfoBox>
=head1 AUTHOR
Michal Josef Špaček L<mailto:skim@cpan.org>
L<http://skim.cz>
=head1 LICENSE AND COPYRIGHT
© 2024-2025 Michal Josef Špaček
BSD 2-Clause License
=head1 VERSION
0.06
=cut