---
name: "Jifty::Collection"
section: "3pm"
platform: "linux"
package: "libjifty-perl"
version: "1.10518+dfsg-2"
release: "Debian 7 (Wheezy)"
platforms: ["linux"]
url: "https://new.carta.tech/Jifty::Collection"
---

# Jifty::Collection(3pm)

Collection of Jifty::Record objects

## NAME

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

## 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 **not** 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 **set** 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 **get** 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 **get** information about paging, not to **set** 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.