.\" 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 "RoPkg::Simba::Commands 3pm"
.TH RoPkg::Simba::Commands 3pm "2006-07-04" "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"
RoPkg::Simba::Commands
.SH "VERSION"
.IX Header "VERSION"
0.2.2
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
RoPkg::Simba::Commands is a class used to count and get
the commands from the database.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& !#/usr/bin/perl
\& 
\& use RoPkg::DB;
\& use RoPkg::Simba::Commands;
\& 
\& sub main {
\&   my $dbp = new RoPkg::DB();
\&   $dbp\->Add(\*(Aqdbi:mysql:database=mysql;host=localhost\*(Aq,
\&             \*(Aqroot\*(Aq,
\&             \*(Aq\*(Aq,
\&             \*(Aqlocal\*(Aq);
\&
\&   my $m = new RoPkg::Simba::Commands(dbo => $dbp, dbo_method => \*(Aqdb_local\*(Aq);
\&
\&   print $m\->Count,\*(Aq commands found in database\*(Aq,$/;
\& }
\& 
\& main();
.Ve
.SH "SUBROUTINES/METHODS"
.IX Header "SUBROUTINES/METHODS"
.SS "\fInew()\fP"
.IX Subsection "new()"
The class constructor. At this moment, it just calls
RoPkg::DBObject\->\fInew()\fR . Please read the RoPkg::DBObject
manual page for more information about the \fInew()\fR parameters.
.SS "Count($fields)"
.IX Subsection "Count($fields)"
Returns the number of commands from database. The \fB\f(CB$fields\fB\fR parameter
contains a list of \s-1WHERE\s0 clauses. For more details of \fB\f(CB$fields\fB\fR
see SQL::Abstract.
.ie n .SS "Get($fields, $orderby)"
.el .SS "Get($fields, \f(CW$orderby\fP)"
.IX Subsection "Get($fields, $orderby)"
Returns a array of \fIRoPkg::Simba::Command\fR objects. The commands are 
read from the database.  The \fB\f(CB$fields\fB\fR parameter
contains a list of \s-1WHERE\s0 clauses. For more details of \fB\f(CB$fields\fB\fR
see SQL::Abstract. \fB\f(CB$orderby\fB\fR is a reference to a array holding
the fields specification used for sorting the data.
.SH "DIAGNOSTICS"
.IX Header "DIAGNOSTICS"
Unpack the source and use 'make test' command
.SH "CONFIGURATION AND ENVIRONMENT"
.IX Header "CONFIGURATION AND ENVIRONMENT"
This module does not use any configuration files or environment
variables.
.SH "DEPENDENCIES"
.IX Header "DEPENDENCIES"
RoPkg::DBCollection and RoPkg::Exceptions
.SH "INCOMPATIBILITIES"
.IX Header "INCOMPATIBILITIES"
None known to the author
.SH "BUGS AND LIMITATIONS"
.IX Header "BUGS AND LIMITATIONS"
None know to the author
.SH "PERL CRITIC"
.IX Header "PERL CRITIC"
The code is perl critic level 2 compliant
.SH "SEE ALSO"
.IX Header "SEE ALSO"
RoPkg::Simba RoPkg::Simba::Command SQL::Abstract
.SH "AUTHOR"
.IX Header "AUTHOR"
Subredu Manuel <diablo@iasi.roedu.net>
.SH "LICENSE AND COPYRIGHT"
.IX Header "LICENSE AND COPYRIGHT"
Copyright (C) 2005 Subredu Manuel.  All Rights Reserved.
This module is free software; you can redistribute it 
and/or modify it under the same terms as Perl itself.
The \s-1LICENSE\s0 file contains the full text of the license.