Next
Returns the next row from the set as an object of the apropriate type. Returns undef when you're done. Starts over after that
GotoFirstItem
Starts the counter over from 0. the next time you call Next, you'll get the first item
GotoItem
Takes an integer, n. Sets the counter to n. the next time you call Next, you'll get the n'th item.
First
Returns the first item
Limit
Limit takes a paramhash.
# TABLE can be set to something different than this table if a join is # wanted (that means we can't do recursive joins as for now). Unless # ALIAS is set, the join criterias will be taken from EXT_LINKFIELD # and INT_LINKFIELD and added to the criterias. If ALIAS is set, new # criterias about the foreign table will be added.
# VALUE should always be set and will always be quoted. Maybe TYPE # should imply that the value shouldn't be quoted? IMO (TobiX) we # shouldn't use quoted values, we should rather use placeholders and # pass the arguments when executing the statement. This will also # allow us to alter limits and reexecute the search with a low cost by # keeping the statement handler.
# ENTRYAGGREGATOR can be AND or OR (or anything else valid to aggregate two clauses in SQL
# OPERATOR is whatever should be putted in between the FIELD and the # VALUE.
# ORDERBY is the SQL ORDERBY
# ORDER can be ASCending or DESCending.
NewAlias
Takes the name of a table. Returns the string of a new Alias for that table
Join
Join takes a param hash with ALIAS1, FIELD1, ALIAS2 and FIELD2
ALIAS1 and ALIAS2 are column aliases obtained from $self->NewAlias or a $self->Limit FIELD1 and FIELD2 are the fields in ALIAS1 and ALIAS2 that should be linked, respectively
CleanSlate
This erases all the data in the SearchBuilder object. It's useful if a subclass is doing funky stuff to keep track of a search
Rows
Optionally, takes an integer which restricts the # of rows returned in a result Returns an integer which is the number of rows the database should display.
FirstRow
Set or get what the first row the database should return is.
Counter
Returns the current record in the set
Count
Returns the number of records in the set
IsLast
returns true if the current Counter is the last row
NAME
DBIx::SearchBuilder - Perl extension for easy SQL SELECT Statement generation
SYNOPSIS
use DBIx::SearchBuilder;
then read the code. (yes, i'm being lame)DESCRIPTION
Jesse is lame and hasn't written docs yet
AUTHOR
Jesse Vincent, jesse@fsck.com
SEE ALSO
DBIx::Handle, DBIx::Record, perl(1).