html::formfu::filter(3pm) [debian man page]

HTML::FormFu::Filter(3pm)				User Contributed Perl Documentation				 HTML::FormFu::Filter(3pm)

NAME

       HTML::FormFu::Filter - Filter Base Class

SYNOPSIS

	   ---
	   elements:
	     - type: Text
	       name: foo
	       filters:
		 - type: Encode
		   candidates:
		     - utf8
		     - Hebrew
	     - type: Text
	       name: bar
	       filters:
		 - LowerCase
		 - Encode
	   filters:
	     - TrimEdges

DESCRIPTION

       "filters()" and "filter" can be called on any form, block element (includes fieldsets) or field element.

       If called on a field element, no "name" argument should be passed.

       If called on a form or block element, if no "name" argument is provided, a new filter is created for and added to every field on that form
       or block.

       See "FORM LOGIC AND VALIDATION" in HTML::FormFu for further details.

METHODS

   type
       Returns the "type" argument originally used to create the filter.

   localise_args
       Provide arguments that should be passed to localize to replace "[_1]", "[_2]", etc. in the localized string.

   parent
       Returns the HTML::FormFu::Element::_Field object that the filter is associated with.

   get_parent
       Arguments: \%options

       Traverses the parent hierarchy, returning the first parent that matches the supplied options.

   form
       Returns the HTML::FormFu object that the filter's field is attached to.

   name
       Shorthand for "$filter->parent->name"

CORE FILTERS

       HTML::FormFu::Filter::Callback
       HTML::FormFu::Filter::CompoundJoin
       HTML::FormFu::Filter::CompoundSprintf
       HTML::FormFu::Filter::CopyValue
       HTML::FormFu::Filter::Default
       HTML::FormFu::Filter::Encode
       HTML::FormFu::Filter::FormatNumber
       HTML::FormFu::Filter::HTMLEscape
       HTML::FormFu::Filter::HTMLScrubber
       HTML::FormFu::Filter::LowerCase
       HTML::FormFu::Filter::NonNumeric
       HTML::FormFu::Filter::Regex
       HTML::FormFu::Filter::Split
       HTML::FormFu::Filter::TrimEdges
       HTML::FormFu::Filter::UpperCase
       HTML::FormFu::Filter::Whitespace

FILTER BASE CLASSES

       The following are base classes for other filters, and generally needn't be used directly.

       HTML::FormFu::Filter::_Compound

AUTHOR

       Carl Franks, "cfranks@cpan.org"

       Based on the original source code of HTML::Widget::Filter, by Sebastian Riedel.

LICENSE

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

perl v5.14.2							    2012-01-23						 HTML::FormFu::Filter(3pm)

HTML::FormFu::Element::ComboBox(3pm)			User Contributed Perl Documentation		      HTML::FormFu::Element::ComboBox(3pm)

NAME

       HTML::FormFu::Element::ComboBox - Select / Text hybrid

SYNOPSIS

	   ---
	   elements:
	     - type: ComboBox
	       name: answer
	       label: 'Select yes or no, or write an alternative:'
	       values:
		 - yes
		 - no

DESCRIPTION

       Creates a multi element containing a Select field and a Text field.

       A ComboBox element named "foo" would result in a Select menu named "foo_select" and a Text field named "foo_text". The names can instead be
       overridden by the "name" value in "select" and "text".

       If a value is submitted for the Text field, this will be used in preference to any submitted value for the Select menu.

       You can access the submitted value by using the ComboBox's name:

	   my $value = $form->param_value('foo');

METHODS

   default
       If the value matches one of the Select menu's options, that options will be selected. Otherwise, the Text field will use the value as its
       default.

   options
       See "options" in HTML::FormFu::Element::_Group for details.

   values
       See "values" in HTML::FormFu::Element::_Group for details.

   value_range
       See "value_range" in HTML::FormFu::Element::_Group for details.

   empty_first
       See "empty_first" in HTML::FormFu::Element::_Group for details.

   empty_first_label
       See "empty_first_label" in HTML::FormFu::Element::_Group for details.

   select
       Arguments: \%setting

       Set values effecting the Select menu. Known keys are:

       name

       Override the auto-generated name of the select menu.

   text
       Arguments: \%setting

       Set values effecting the Text field. Known keys are:

       name

       Override the auto-generated name of the select menu.

CAVEATS

       Although this element inherits from HTML::FormFu::Element::Block, its behaviour for the methods filter/filters, constraint/constraints,
       inflator/inflators, validator/validators and transformer/transformers is more like that of a field element, meaning all processors are
       added directly to the date element, not to its child elements.

       This element's get_elements and get_all_elements are inherited from HTML::FormFu::Element::Block, and so have the same behaviour. However,
       it overrides the "get_fields|HTML::FormFu/get_fields" method, such that it returns both itself and its child elements.

SEE ALSO

       Is a sub-class of, and inherits methods from HTML::FormFu::Element::Multi, HTML::FormFu::Element::Block, HTML::FormFu::Element

       HTML::FormFu

AUTHOR

       Carl Franks, "cfranks@cpan.org"

LICENSE

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

perl v5.14.2							    2012-01-23				      HTML::FormFu::Element::ComboBox(3pm)