Cory G Watson > DBIx-Class-ResultSet-Faceter-0.04 > DBIx::Class::ResultSet::Faceter::Facet

Download:
DBIx-Class-ResultSet-Faceter-0.04.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  2
Open  0
View/Report Bugs
Source  

NAME ^

DBIx::Class::ResultSet::Faceter::Facet - A Facet

SYNOPSIS ^

DESCRIPTION ^

ATTRIBUTES ^

min

The minimum number of values that a facet must have to be included. Anything less than the value of this attribute will be discarded.

name

The name of this facet. This attribute is required. It should be unique when compared to any other facets used on the ResultSet.

order

The sort order of this facet. Defaults to 'desc'. Valid values are desc and <asc>.

METHODS ^

has_min

Predicate for the min attribute.

process

The process method is the only required method for something implementing this role. When faceting the Facet class will be called once for each row in the ResultSet that is being faceted. It is expected to return a string that will place it into a facet. Any sorting, limiting, offseting or other operations are handled by the role and not necessary.

AUTHOR ^

Cory G Watson, <gphat at cpan.org>

COPYRIGHT & LICENSE ^

Copyright 2010 Cold Hard Code, LLC

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

syntax highlighting: