.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29) .\" .\" 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 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. .\" .\" 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 "RoPkg::Simba::Excludes 3pm" .TH RoPkg::Simba::Excludes 3pm "2016-08-21" "perl v5.22.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::Excludes .SH "VERSION" .IX Header "VERSION" 0.2.2 .SH "DESCRIPTION" .IX Header "DESCRIPTION" RoPkg::Simba::Excludes is a class used to count and get the excludes from the database. .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& !#/usr/bin/perl \& \& use RoPkg::DB; \& use RoPkg::Simba::Excludes; \& \& 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::Excludes(dbo => $dbp, dbo_method => \*(Aqdb_local\*(Aq); \& \& print $m\->Count,\*(Aq excludes 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 excludes 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::exclude list\fR objects. The excludes 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 known to the author .SH "PERL CRITIC" .IX Header "PERL CRITIC" This module is perl critic level 2 compliant .SH "SEE ALSO" .IX Header "SEE ALSO" RoPkg::Simba RoPkg::Simba::Exclude SQL::Abstract .SH "AUTHOR" .IX Header "AUTHOR" Subredu Manuel .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.