0 #ˆl–ßi~””ÔD¨ ¥íÀ3q—Å£É ƒ}Ç™ÈÂË%Ó.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "Template::Iterator 3" .TH Template::Iterator 3 "2024-06-21" "perl v5.32.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" Template::Iterator \- Data iterator used by the FOREACH directive .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& my $iter = Template::Iterator\->new(\e@data, \e%options); .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" The \f(CW\*(C`Template::Iterator\*(C'\fR module defines a generic data iterator for use by the \f(CW\*(C`FOREACH\*(C'\fR directive. .PP It may be used as the base class for custom iterators. .SH "PUBLIC METHODS" .IX Header "PUBLIC METHODS" .SS "new($data)" .IX Subsection "new($data)" Constructor method. A reference to a list of values is passed as the first parameter. Subsequent calls to \fBget_first()\fR and \fBget_next()\fR calls will return each element from the list. .PP .Vb 1 \& my $iter = Template::Iterator\->new([ \*(Aqfoo\*(Aq, \*(Aqbar\*(Aq, \*(Aqbaz\*(Aq ]); .Ve .PP The constructor will also accept a reference to a hash array and will expand it into a list in which each entry is a hash array containing a '\f(CW\*(C`key\*(C'\fR' and '\f(CW\*(C`value\*(C'\fR' item, sorted according to the hash keys. .PP .Vb 4 \& my $iter = Template::Iterator\->new({ \& foo => \*(AqFoo Item\*(Aq, \& bar => \*(AqBar Item\*(Aq, \& }); .Ve .PP This is equivalent to: .PP .Vb 4 \& my $iter = Template::Iterator\->new([ \& { key => \*(Aqbar\*(Aq, value => \*(AqBar Item\*(Aq }, \& { key => \*(Aqfoo\*(Aq, value => \*(AqFoo Item\*(Aq }, \& ]); .Ve .PP When passed a single item which is not an array reference, the constructor will automatically create a list containing that single item. .PP .Vb 1 \& my $iter = Template::Iterator\->new(\*(Aqfoo\*(Aq); .Ve .PP This is equivalent to: .PP .Vb 1 \& my $iter = Template::Iterator\->new([ \*(Aqfoo\*(Aq ]); .Ve .PP Note that a single item which is an object based on a blessed \s-1ARRAY\s0 reference