Login or Register to Ask a Question and Join Our Community

Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

jifty::collection(3pm) [debian man page]

Jifty::Collection(3pm)					User Contributed Perl Documentation				    Jifty::Collection(3pm)

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.

perl v5.14.2							    2010-12-10						    Jifty::Collection(3pm)

Check Out this Related Man Page

Jifty::DBI::Collection::Union(3pm)			User Contributed Perl Documentation			Jifty::DBI::Collection::Union(3pm)

NAME

       Jifty::DBI::Collection::Union - Deal with multiple Jifty::DBI::Collection result sets as one

SYNOPSIS

	 use Jifty::DBI::Collection::Union;
	 my $U = new Jifty::DBI::Collection::Union;
	 $U->add( $tickets1 );
	 $U->add( $tickets2 );

	 $U->GotoFirstItem;
	 while (my $z = $U->Next) {
	   printf "%5d %30.30s
", $z->Id, $z->Subject;
	 }

WARNING

       This module is still experimental.

DESCRIPTION

       Implements a subset of the Jifty::DBI::Collection methods, but enough to do iteration over a bunch of results.  Useful for displaying the
       results of two unrelated searches (for the same kind of objects) in a single list.

METHODS

   new
       Create a new Jifty::DBI::Collection::Union object.  No arguments.

   add COLLECTION
       Add Jifty::DBI::Collection object COLLECTION to the Union object.

       It must be the same type as the first object added.

   first
       Return the very first element of the Union (which is the first element of the first Collection).  Also reset the current pointer to that
       element.

   next
       Return the next element in the Union.

   last
       Returns the last item

   count
       Returns the total number of elements in the union collection

   goto_first_item
       Starts the recordset counter over from the first item. the next time you call "next", you'll get the first item returned by the database,
       as if you'd just started iterating through the result set.

   goto_item
       Unlike "goto_item" in Jifty::DBI::Collection, Union only supports going to the first item in the collection.

   is_last
       Returns true if the current row is the last record in the set.

   items_array_ref
       Return a reference to an array containing all objects found by this search.

       Will destroy any positional state.

AUTHOR

       Copyright (c) 2004 Robert Spier

       All rights reserved.

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

SEE ALSO

       Jifty::DBI, Jifty::DBI::Collection

perl v5.14.2							    2010-12-09					Jifty::DBI::Collection::Union(3pm)
Man Page