jifty::action::record::search(3pm) [debian man page]

Jifty::Action::Record::Search(3pm)			User Contributed Perl Documentation			Jifty::Action::Record::Search(3pm)

NAME

       Jifty::Action::Record::Search - Automagic search action

DESCRIPTION

       The class is a base class for Jifty::Actions that serve to provide an interface to general searches through Jifty::Record objects. To use
       it, subclass it and override the "record_class" method to return the fully qualified name of the model to do searches over.

METHODS

   arguments
       Remove validators from arguments, as well as ``mandatory'' restrictions. Remove any arguments that render as password fields, or refer to
       collections.

       Generate additional search arguments for each field based on the following criteria:

       "text", "char" or "varchar" fields
	   Create "field"_contains and "field"_lacks arguments

       "date", or "timestamp" fields
	   Create "field"_before, "field"_after, "field"_since and "field"_until arguments.

       "integer", "float", "double", "decimal" or "numeric" fields
	   Generate "field"_lt, "field"_gt, "field"_le and "field"_ge arguments, as well as a "field"_dwim field that accepts a prefixed
	   comparison operator in the search value, such as ">100" and "!100".

   take_action
       Return a collection with the result of the search specified by the given arguments.

       We interpret a "undef" argument as SQL "NULL", and ignore empty or non-present arguments.

SEE ALSO

       Jifty::Action::Record, Jifty::Collection

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::Action::Record::Search(3pm)

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)