jifty::param(3pm) [debian man page]
Jifty::Param(3pm) User Contributed Perl Documentation Jifty::Param(3pm) NAME
Jifty::Param - Parameters for Jifty actions DESCRIPTION
Describes a parameter to a "Jifty::Action" object. Do not construct this by hand -- use Jifty::Param::Schema in the action package to declare parameters instead. accessors Although this class is not derived from Jifty::Web::Form::Field, it does share the accessors from it; see Jifty::Web::Form::Field, for the list of possible keys that each parameter can have. In addition to the list there, you may use these additional keys: constructor A boolean which, if set, indicates that the argument must be present in the "arguments" passed to create the action, rather than being expected to be set later. Defaults to false. valid_values An array reference. Each element should be either: o A hash reference with a "display" field for the string to display for the value, and a "value" field for the value to actually send to the server. o A hash reference with a "collection" field containing a Jifty::Collection, and "display_from" and "value_from" fields containing the names of methods to call on each record in the collection to get "display" and "value". o A simple string, which is treated as both "display" and "value". available_values Just like valid_values, but represents the list of suggested values, instead of the list of acceptable values. sort_order An integer of how the parameter sorts relative to other parameters. This is usually implicitly generated by its declaration order. new Creates a new Jifty::Param object. Note that unlike Jifty::Web::Form::Field, the object is never magically reblessed into a subclass. Should only be called implicitly from a Jifty::Param::Schema declaration. perl v5.14.2 2010-09-25 Jifty::Param(3pm)
Check Out this Related 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)