CatalystX::CRUD::Results(3)

NAME
CatalystX::CRUD::Results - search results class

SYNOPSIS
 # in .tt file
 Your search returned [% results.count %] total hits.
 Your query was [% results.query %].
 You are on page [% results.pager.current_page %].
 [% FOREACH r IN results.results %]
  [% loop.count %]: [% r.name %]
 [% END %]

DESCRIPTION
CatalystX::CRUD::Results is a class for search results from a CatalystX::CRUD::Controller. See the do_search() method in CatalystX::CRUD::Controller.

METHODS
The following read-only accessors are available:

  count
Returns total number of results.

  pager
Returns Data::Pageset object for paging through results.

  query
Returns the search query.

  results
Returns array ref of current found objects.

  next
Returns next result. If results() is an arrayref, shift() is used. Otherwise, the results() value is assumed to act like a CatalystX::CRUD::Iterator and its next() method will be called.

  TO_JSON
Hook for the JSON module so that you can pass a Results object directly to encode_json(). Calls serialize() internally.

  serialize
Returns object as a hash ref. Objects are overloaded to call Data::Dump::dump( $results->serialize ) in string context.

AUTHOR
Peter Karman, "<perl at peknet.com>"

BUGS
Please report any bugs or feature requests to "bug-catalystx-crud at rt.cpan.org", or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=CatalystX-CRUD>. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT
You can find documentation for this module with the perldoc command.

    perldoc CatalystX::CRUD

You can also look for information at:

•   Mailing List

    <https://groups.google.com/forum/#!forum/catalystxcrud>

•   AnnoCPAN: Annotated CPAN documentation

    <http://annocpan.org/dist/CatalystX-CRUD>

•   CPAN Ratings

    <http://cpanratings.perl.org/d/CatalystX-CRUD>

•   RT: CPAN's request tracker

    <http://rt.cpan.org/NoAuth/Bugs.html?Dist=CatalystX-CRUD>

•   Search CPAN

    <http://search.cpan.org/dist/CatalystX-CRUD>

ACKNOWLEDGEMENTS

COPYRIGHT & LICENSE
Copyright 2008 Peter Karman, all rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.