GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  JIFTY::COLLECTION (3)

.ds Aq ’

NAME

Jifty::Collection - Collection of Jifty::Record objects

CONTENTS

SYNOPSIS



  package Foo::Model::BarCollection
  use base qw/Jifty::Collection/;



DESCRIPTION

This is a wrapper over Jifty::DBI::Collection that at the same time is a Jifty::Object. To use it, subclass it.

Alternatively, an ’anonymous’ collection can be made by creating a new Jifty::Collection object, and calling record_class(Application::Model::Foo) or similar on it.

In addition, each Jifty::Collection includes a Data::Page object to help with calculations related to paged data. You should <B>notB> call the first_row and rows_per_page methods from Jifty::DBI::Collection on a Jifty::Collection. Instead, if you’d like to use paging, you should use the set_page_info method to <B>setB> the number of records per page and first record on the current page, and you should use the Data::Page object returned by the pager method to <B>getB> information related to paging.

MODEL

    pager

Returns a Data::Page object associated with this collection. This object defaults to 10 entries per page. You should use only use Data::Page methods on this object to <B>getB> information about paging, not to <B>setB> it; use set_page_info to set paging information.

    results_are_readable

If your results from the query are guaranteed to be readable by current_user, you can create the collection with results_are_readable => 1. This causes check_read_rights to bypass normal current_user_can checks.

    as_search_action PARAMHASH

Returns the Jifty::Action::Record::Search action for the model associated with this collection.

The PARAMHASH allows you to add additional parameters to pass to new_action in Jifty::Web.

    add_record

If results_are_readable is false, only add records to the collection that we can read (by checking check_read_rights in Jifty::Record). Otherwise, make sure all records added are readable.

    implicit_clauses

Defaults to ordering by the id column.

    jifty_serialize_format

This returns an array reference of the individual records that make up this collection.

SEE ALSO

Jifty::DBI::Collection, Jifty::Object, Jifty::Record

LICENSE

Jifty is Copyright 2005-2010 Best Practical Solutions, LLC. Jifty is distributed under the same terms as Perl itself.
Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 JIFTY::COLLECTION (3) 2010-12-10

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.