Scroll to navigation

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

NAME

HTML::FormFu::Filter - Filter Base Class

VERSION

version 2.07

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::Role::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

FILTER BASE CLASSES

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

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.

AUTHOR

Carl Franks <cpan@fireartist.com>

COPYRIGHT AND LICENSE

This software is copyright (c) 2018 by Carl Franks.

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

2024-04-10 perl v5.38.2