.\" 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 "Class::DBI::Search::Basic 3pm"
.TH Class::DBI::Search::Basic 3pm "2022-03-28" "perl v5.34.0" "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"
Class::DBI::Search::Basic \- Simple Class::DBI search
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\&        my $searcher = Class::DBI::Search::Basic\->new(
\&                $cdbi_class, @search_args
\&        );
\&
\&        my @results = $searcher\->run_search;
\&
\&        # Over in your Class::DBI subclass:
\&        
\&        _\|_PACKAGE_\|_\->add_searcher(
\&                search  => "Class::DBI::Search::Basic",
\&          isearch => "Class::DBI::Search::Plugin::CaseInsensitive",
\&        );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This is the start of a pluggable Search infrastructure for Class::DBI.
.PP
At the minute Class::DBI::Search::Basic doubles up as both the default
search within Class::DBI as well as the search base class. We will
probably need to tease this apart more later and create an abstract base
class for search plugins.
.SH "METHODS"
.IX Header "METHODS"
.SS "new"
.IX Subsection "new"
.Vb 3
\&        my $searcher = Class::DBI::Search::Basic\->new(
\&                $cdbi_class, @search_args
\&        );
.Ve
.PP
A Searcher is created with the class to which the results will belong,
and the arguments passed to the search call by the user.
.SS "opt"
.IX Subsection "opt"
.Vb 1
\&        if (my $order = $self\->opt(\*(Aqorder_by\*(Aq)) { ... }
.Ve
.PP
The arguments passed to search may contain an options hash. This will
return the value of a given option.
.SS "run_search"
.IX Subsection "run_search"
.Vb 2
\&        my @results = $searcher\->run_search;
\&        my $iterator = $searcher\->run_search;
.Ve
.PP
Actually run the search.
.SH "SUBCLASSING"
.IX Header "SUBCLASSING"
.SS "sql / bind / fragment"
.IX Subsection "sql / bind / fragment"
The actual mechanics of generating the \s-1SQL\s0 and executing it split up
into a variety of methods for you to override.
.PP
\&\fBrun_search()\fR is implemented as:
.PP
.Vb 1
\&  return $cdbi\->sth_to_objects($self\->sql, $self\->bind);
.Ve
.PP
Where \fBsql()\fR is
.PP
.Vb 1
\&  $cdbi\->sql_Retrieve($self\->fragment);
.Ve
.PP
There are also a variety of private methods underneath this that could
be overridden in a pinch, but if you need to do this I'd rather you let
me know so that I can make them public, or at least so that I don't
remove them from under your feet.