.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "DBIx::DR::Iterator 3pm"
.TH DBIx::DR::Iterator 3pm "2013-11-01" "perl v5.14.2" "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"
DBIx::DR::Iterator \- iterator for DBIx::DR.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&    my $it = DBIx::DR::Iterator\->new($arrayref);
\&
\&    printf "Rows count: %d\en", $it\->count;
\&
\&    while(my $row == $it\->next) {
\&        print "Row: %s\en", $row\->field;
\&    }
\&
\&    my $row = $it\->get(15); # element 15
\&
\&
\&
\&    my $it = DBIx::DR::Iterator\->new($hashref);
\&
\&    printf "Rows count: %d\en", $it\->count;
\&
\&    while(my $row == $it\->next) {
\&        print "Row: %s\en", $row\->field;
\&    }
\&
\&    my $row = $it\->get(\*(Aqabc\*(Aq); # element with key name eq \*(Aqabc\*(Aq
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The package constructs iterator from \s-1HASHREF\s0 or \s-1ARRAYREF\s0 value.
.SH "Methods"
.IX Header "Methods"
.SS "new"
.IX Subsection "new"
Constructor.
.PP
.Vb 1
\&    my $i = DBIx::DR::Iterator\->new($arrayset [, OPTIONS ]);
.Ve
.PP
Where \fB\s-1OPTIONS\s0\fR are:
.IP "\-item => 'decamelized_obj_define';" 4
.IX Item "-item => 'decamelized_obj_define';"
It will bless (or construct) row into specified class. See below.
.Sp
By default it constructs DBIx::DR::Iterator::Item objects.
.SS "count"
.IX Subsection "count"
Returns count of elements.
.SS "is_changed"
.IX Subsection "is_changed"
Returns (or set) flag that one of contained elements was changed.
.SS "exists(name|number)"
.IX Subsection "exists(name|number)"
Returns \fBtrue\fR if element '\fBname|number\fR' is exists.
.SS "get(name|number)"
.IX Subsection "get(name|number)"
Returns element by '\fBname|number\fR'. It will throw exception if element
isn't exists.
.SS "next"
.IX Subsection "next"
Returns next element or \fBundef\fR.
.SS "reset"
.IX Subsection "reset"
Resets internal iterator (that is used by next).
.SS "all"
.IX Subsection "all"
Returns all elements (as an array).
.PP
If You notice an argument it will extract specified fields:
.PP
.Vb 1
\&    my @ids = $it\->all(\*(Aqid\*(Aq);
.Ve
.PP
The same as:
.PP
.Vb 1
\&    my @ids = map { $_\->id } $it\->all;
.Ve
.SS "grep"
.IX Subsection "grep"
Constructs new iterator that is subset of parent iterator.
.PP
.Vb 1
\&    my $busy = $list\->grep(sub { $_[0]\->busy ? 1 : 0 });
.Ve
.SS "push"
.IX Subsection "push"
Pushes one element into iterator.
.PP
If You use HASH-iterator You have to note key name.
.PP
\fIExample\fR
.IX Subsection "Example"
.PP
.Vb 2
\&    $hiter\->push(abc => { id => 1 });
\&    $hiter\->push(abc => $oiter\->get(\*(Aqabc\*(Aq));
\&
\&    $aiter\->push({ id => 1 });
.Ve
.SH "DBIx::DR::Iterator::Item"
.IX Header "DBIx::DR::Iterator::Item"
One row. It has methods names coincident with field names. Also it has a few
additional methods:
.SS "new"
.IX Subsection "new"
Constructor. Receives two arguments: \fB\s-1HASHREF\s0\fR and link to
iterator.
.PP
.Vb 2
\&    my $row = DBIx::DR::Iterator::Item\->new({ id => 1 });
\&    $row = DBIx::DR::Iterator::Item\->new({ id => 1 }, $iterator); }
.Ve
.SS "iterator"
.IX Subsection "iterator"
Returns (or set) iterator object. The link is created by constructor.
This is a weaken link.
.SS "is_changed"
.IX Subsection "is_changed"
Returns (or set) flag if the row has been changed. If You change any of
row's fields the flag will be set. Also iterator's flag will be set.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
.Vb 2
\& Copyright (C) 2011 Dmitry E. Oboukhov <unera@debian.org>
\& Copyright (C) 2011 Roman V. Nikolaev <rshadow@rambler.ru>
\&
\& This program is free software, you can redistribute it and/or
\& modify it under the terms of the Artistic License.
.Ve