{"id":20387251,"url":"https://github.com/leto/html-formfu","last_synced_at":"2025-09-09T06:12:06.375Z","repository":{"id":66530110,"uuid":"1488465","full_name":"leto/HTML-FormFu","owner":"leto","description":"Release history of HTML-FormFu","archived":false,"fork":false,"pushed_at":"2011-03-16T19:50:31.000Z","size":933,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-04T23:32:09.883Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://search.cpan.org/dist/HTML-FormFu/","language":"Perl","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/leto.png","metadata":{"files":{"readme":"README","changelog":"Changes","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2011-03-16T18:53:50.000Z","updated_at":"2014-10-08T00:05:25.000Z","dependencies_parsed_at":"2023-02-20T06:00:57.623Z","dependency_job_id":null,"html_url":"https://github.com/leto/HTML-FormFu","commit_stats":null,"previous_names":[],"tags_count":30,"template":false,"template_full_name":null,"purl":"pkg:github/leto/HTML-FormFu","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leto%2FHTML-FormFu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leto%2FHTML-FormFu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leto%2FHTML-FormFu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leto%2FHTML-FormFu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/leto","download_url":"https://codeload.github.com/leto/HTML-FormFu/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/leto%2FHTML-FormFu/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":274250794,"owners_count":25249459,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-09T02:00:10.223Z","response_time":80,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T02:44:29.825Z","updated_at":"2025-09-09T06:12:06.316Z","avatar_url":"https://github.com/leto.png","language":"Perl","funding_links":[],"categories":[],"sub_categories":[],"readme":"NAME\n    HTML::FormFu - HTML Form Creation, Rendering and Validation Framework\n\nBETA SOFTWARE\n    There may be API changes required before the 1.0 release. Any\n    incompatible changes will first be discussed on the mailing list. See\n    \"DEPRECATION POLICY\" for further details.\n\n    Work is still needed on the documentation, if you come across any errors\n    or find something confusing, please give feedback via the mailing list.\n\nSYNOPSIS\n    Note: These examples make use of HTML::FormFu::Model::DBIC. As of\n    \"HTML::FormFu\" v02.005, the HTML::FormFu::Model::DBIC module is not\n    bundled with \"HTML::FormFu\" and is available in a stand-alone\n    distribution.\n\n        use HTML::FormFu;\n\n        my $form = HTML::FormFu-\u003enew;\n\n        $form-\u003eload_config_file('form.yml');\n\n        $form-\u003eprocess( $cgi_query );\n\n        if ( $form-\u003esubmitted_and_valid ) {\n            # do something with $form-\u003eparams\n        }\n        else {\n            # display the form\n            $template-\u003eparam( form =\u003e $form );\n        }\n\n    If you're using Catalyst, a more suitable example might be:\n\n        package MyApp::Controller::User;\n        use strict;\n        use base 'Catalyst::Controller::HTML::FormFu';\n\n        sub user : Chained CaptureArgs(1) {\n            my ( $self, $c, $id ) = @_;\n\n            my $rs = $c-\u003emodel('Schema')-\u003eresultset('User');\n\n            $c-\u003estash-\u003e{user} = $rs-\u003efind( $id );\n\n            return;\n        }\n\n        sub edit : Chained('user') Args(0) FormConfig {\n            my ( $self, $c ) = @_;\n\n            my $form = $c-\u003estash-\u003e{form};\n            my $user = $c-\u003estash-\u003e{user};\n\n            if ( $form-\u003esubmitted_and_valid ) {\n\n                $form-\u003emodel-\u003eupdate( $user );\n\n                $c-\u003eres-\u003eredirect( $c-\u003euri_for( \"/user/$id\" ) );\n                return;\n            }\n\n            $form-\u003emodel-\u003edefault_values( $user )\n                if ! $form-\u003esubmitted;\n\n        }\n\n    Note: Because \"process\" is automatically called for you by the Catalyst\n    controller; if you make any modifications to the form within your action\n    method, such as adding or changing elements, adding constraints, etc;\n    you must call \"process\" again yourself before using\n    \"submitted_and_valid\", any of the methods listed under \"SUBMITTED FORM\n    VALUES AND ERRORS\" or \"MODIFYING A SUBMITTED FORM\", or rendering the\n    form.\n\n    Here's an example of a config file to create a basic login form (all\n    examples here are YAML, but you can use any format supported by\n    Config::Any), you can also create forms directly in your perl code,\n    rather than using an external config file.\n\n        ---\n        action: /login\n        indicator: submit\n        auto_fieldset: 1\n\n        elements:\n          - type: Text\n            name: user\n            constraints:\n              - Required\n\n          - type: Password\n            name: pass\n            constraints:\n              - Required\n\n          - type: Submit\n            name: submit\n\n        constraints:\n          - SingleValue\n\nDESCRIPTION\n    HTML::FormFu is a HTML form framework which aims to be as easy as\n    possible to use for basic web forms, but with the power and flexibility\n    to do anything else you might want to do (as long as it involves forms).\n\n    You can configure almost any part of formfu's behaviour and output. By\n    default formfu renders \"XHTML 1.0 Strict\" compliant markup, with as\n    little extra markup as possible, but with sufficient CSS class names to\n    allow for a wide-range of output styles to be generated by changing only\n    the CSS.\n\n    All methods listed below (except \"new\") can either be called as a normal\n    method on your $form object, or as an option in your config file.\n    Examples will mainly be shown in YAML config syntax.\n\n    This documentation follows the convention that method arguments\n    surrounded by square brackets \"[]\" are *optional*, and all other\n    arguments are required.\n\nBUILDING A FORM\n  new\n    Arguments: [\\%options]\n\n    Return Value: $form\n\n    Create a new HTML::FormFu object.\n\n    Any method which can be called on the HTML::FormFu object may instead be\n    passed as an argument to \"new\".\n\n        my $form = HTML::FormFu-\u003enew({\n            action        =\u003e '/search',\n            method        =\u003e 'GET',\n            auto_fieldset =\u003e 1,\n        });\n\n  load_config_file\n    Arguments: $filename\n\n    Arguments: \\@filenames\n\n    Return Value: $form\n\n    Accepts a filename or list of file names, whose filetypes should be of\n    any format recognized by Config::Any.\n\n    The content of each config file is passed to \"populate\", and so are\n    added to the form.\n\n    \"load_config_file\" may be called in a config file itself, so as to allow\n    common settings to be kept in a single config file which may be loaded\n    by any form.\n\n        ---\n        load_config_file:\n          - file1\n          - file2\n\n    YAML multiple documents within a single file. The document start marker\n    is a line containing 3 dashes. Multiple documents will be applied in\n    order, just as if multiple filenames had been given.\n\n    In the following example, multiple documents are taken advantage of to\n    load another config file after the elements are added. (If this were a\n    single document, the \"load_config_file\" would be called before\n    \"elements\", regardless of its position in the file).\n\n        ---\n        elements:\n          - name: one\n          - name: two\n\n        ---\n        load_config_file: ext.yml\n\n    Relative paths are resolved from the \"config_file_path\" directory if it\n    is set, otherwise from the current working directory.\n\n    See \"BEST PRACTICES\" for advice on organising config files.\n\n  config_callback\n    Arguments: \\%options\n\n    If defined, the arguments are used to create a Data::Visitor::Callback\n    object during \"load_config_file\" which may be used to pre-process the\n    config before it is sent to \"populate\".\n\n    For example, the code below adds a callback to a form that will\n    dynamically alter any config value ending in \".yml\" to end in \".yaml\"\n    when you call \"load_config_file\":\n\n        $form-\u003econfig_callback({\n          plain_value =\u003e sub {\n            my( $visitor, $data ) = @_;\n            s/\\.yml/.yaml/;\n          }\n        });\n\n    Default Value: not defined\n\n    This method is a special 'inherited accessor', which means it can be set\n    on the form, a block element or a single element. When the value is\n    read, if no value is defined it automatically traverses the element's\n    hierarchy of parents, through any block elements and up to the form,\n    searching for a defined value.\n\n  populate\n    Arguments: \\%options\n\n    Return Value: $form\n\n    Each option key/value passed may be any HTML::FormFu method-name and\n    arguments.\n\n    Provides a simple way to set multiple values, or add multiple elements\n    to a form with a single method-call.\n\n    Attempts to call the method-names in a semi-intelligent order (see the\n    source of populate() in \"HTML::FormFu::ObjectUtil\" for details).\n\n  default_values\n    Arguments: \\%defaults\n\n    Return Value: $form\n\n    Set multiple field's default values from a single hash-ref.\n\n    The hash-ref's keys correspond to a form field's name, and the value is\n    passed to the field's default method.\n\n    This should be called after all fields have been added to the form, and\n    before \"process\" is called (otherwise, call \"process\" again before\n    rendering the form).\n\n  config_file_path\n    Arguments: $directory_name\n\n    \"config_file_path\" defines where configuration files will be searched\n    for, if an absolute path is not given to \"load_config_file\".\n\n    Default Value: not defined\n\n    This method is a special 'inherited accessor', which means it can be set\n    on the form, a block element or a single element. When the value is\n    read, if no value is defined it automatically traverses the element's\n    hierarchy of parents, through any block elements and up to the form,\n    searching for a defined value.\n\n  indicator\n    Arguments: $field_name\n\n    Arguments: \\\u0026coderef\n\n    If \"indicator\" is set to a fieldname, \"submitted\" will return true if a\n    value for that fieldname was submitted.\n\n    If \"indicator\" is set to a code-ref, it will be called as a subroutine\n    with the two arguments $form and $query, and its return value will be\n    used as the return value for \"submitted\".\n\n    If \"indicator\" is not set, \"submitted\" will return true if a value for\n    any known fieldname was submitted.\n\n  auto_fieldset\n    Arguments: 1\n\n    Arguments: \\%options\n\n    Return Value: $fieldset\n\n    This setting is suitable for most basic forms, and means you can\n    generally ignore adding fieldsets yourself.\n\n    Calling \"$form-\u003eauto_fieldset(1)\" immediately adds a fieldset element to\n    the form. Thereafter, \"$form-\u003eelements()\" will add all elements (except\n    fieldsets) to that fieldset, rather than directly to the form.\n\n    To be specific, the elements are added to the last fieldset on the form,\n    so if you add another fieldset, any further elements will be added to\n    that fieldset.\n\n    Also, you may pass a hashref to auto_fieldset(), and this will be used\n    to set defaults for the first fieldset created.\n\n    A few examples and their output, to demonstrate:\n\n    2 elements with no fieldset.\n\n        ---\n        elements:\n          - type: Text\n            name: foo\n          - type: Text\n            name: bar\n\n        \u003cform action=\"\" method=\"post\"\u003e\n          \u003cdiv class=\"text\"\u003e\n            \u003cinput name=\"foo\" type=\"text\" /\u003e\n          \u003c/div\u003e\n          \u003cdiv class=\"text\"\u003e\n            \u003cinput name=\"bar\" type=\"text\" /\u003e\n          \u003c/div\u003e\n        \u003c/form\u003e\n\n    2 elements with an \"auto_fieldset\".\n\n        ---\n        auto_fieldset: 1\n        elements:\n          - type: Text\n            name: foo\n          - type: Text\n            name: bar\n\n        \u003cform action=\"\" method=\"post\"\u003e\n          \u003cfieldset\u003e\n            \u003cdiv class=\"text\"\u003e\n              \u003cinput name=\"foo\" type=\"text\" /\u003e\n            \u003c/div\u003e\n            \u003cdiv class=\"text\"\u003e\n              \u003cinput name=\"bar\" type=\"text\" /\u003e\n            \u003c/div\u003e\n          \u003c/fieldset\u003e\n        \u003c/form\u003e\n\n    The 3rd element is within a new fieldset\n\n        ---\n        auto_fieldset: { id: fs }\n        elements:\n          - type: Text\n            name: foo\n          - type: Text\n            name: bar\n          - type: Fieldset\n          - type: Text\n            name: baz\n\n        \u003cform action=\"\" method=\"post\"\u003e\n          \u003cfieldset id=\"fs\"\u003e\n            \u003cdiv class=\"text\"\u003e\n              \u003cinput name=\"foo\" type=\"text\" /\u003e\n            \u003c/div\u003e\n            \u003cdiv class=\"text\"\u003e\n              \u003cinput name=\"bar\" type=\"text\" /\u003e\n            \u003c/div\u003e\n          \u003c/fieldset\u003e\n          \u003cfieldset\u003e\n            \u003cdiv class=\"text\"\u003e\n              \u003cinput name=\"baz\" type=\"text\" /\u003e\n            \u003c/div\u003e\n          \u003c/fieldset\u003e\n        \u003c/form\u003e\n\n    Because of this behaviour, if you want nested fieldsets you will have to\n    add each nested fieldset directly to its intended parent.\n\n        my $parent = $form-\u003eget_element({ type =\u003e 'Fieldset' });\n\n        $parent-\u003eelement('fieldset');\n\n  form_error_message\n    Arguments: $string\n\n    Normally, input errors cause an error message to be displayed alongside\n    the appropriate form field. If you'd also like a general error message\n    to be displayed at the top of the form, you can set the message with\n    \"form_error_message\".\n\n    To change the markup used to display the message, edit the\n    \"form_error_message\" template file.\n\n  form_error_message_xml\n    Arguments: $string\n\n    If you don't want your error message to be XML-escaped, use the\n    \"form_error_message_xml\" method instead.\n\n  form_error_message_loc\n    Arguments: $localization_key\n\n    For ease of use, if you'd like to use the provided localized error\n    message, set \"form_error_message_loc\" to the value \"form_error_message\".\n\n    You can, of course, set \"form_error_message_loc\" to any key in your I18N\n    file.\n\n  force_error_message\n    If true, forces the \"form_error_message\" to be displayed even if there\n    are no field errors.\n\n  default_args\n    Arguments: \\%defaults\n\n    Set defaults which will be added to every element, constraint, etc. of\n    the listed type which is added to the form.\n\n    For example, to make every \"Text\" element automatically have a size of\n    10, and make every \"Strftime\" deflator automatically get its strftime\n    set to \"%d/%m/%Y\":\n\n        default_args:\n            elements:\n                Text:\n                    size: 10\n            deflators:\n                Strftime:\n                    strftime: '%d/%m/%Y'\n\n    To take it even further, you can even make all DateTime elements\n    automatically get an appropriate Strftime deflator and a DateTime\n    inflator:\n\n        default_args:\n            elements:\n                DateTime:\n                    deflators:\n                        type: Strftime\n                        strftime: '%d-%m-%Y'\n                    inflators:\n                        type: DateTime\n                        parser:\n                            strptime: '%d-%m-%Y'\n\n    Note: Unlike the proper methods which have aliases, for example\n    \"elements\" which is an alias for \"element\" - the keys given to\n    \"default_args\" must be of the plural form, e.g.:\n\n        default_args:\n            elements:          {}\n            deflators:         {}\n            filters:           {}\n            constraints:       {}\n            inflators:         {}\n            validators:        {}\n            transformers:      {}\n            output_processors: {}\n\n  javascript\n    Arguments: [$javascript]\n\n    If set, the contents will be rendered within a \"script\" tag, inside the\n    top of the form.\n\n  stash\n    Arguments: [\\%private_stash]\n\n    Return Value: \\%stash\n\n    Provides a hash-ref in which you can store any data you might want to\n    associate with the form.\n\n        ---\n        stash:\n          foo: value\n          bar: value\n\n  elements\n  element\n    Arguments: $type\n\n    Arguments: \\%options\n\n    Return Value: $element\n\n    Arguments: \\@arrayref_of_types_or_options\n\n    Return Value: @elements\n\n    Adds a new element to the form. See \"CORE ELEMENTS\" in\n    HTML::FormFu::Element for a list of core elements.\n\n    If you want to load an element from a namespace other than\n    \"HTML::FormFu::Element::\", you can use a fully qualified package-name by\n    prefixing it with \"+\".\n\n        ---\n        elements:\n          - type: +MyApp::CustomElement\n            name: foo\n\n    If a \"type\" is not provided in the \"\\%options\", the default \"Text\" will\n    be used.\n\n    \"element\" is an alias for \"elements\".\n\n  deflators\n  deflator\n    Arguments: $type\n\n    Arguments: \\%options\n\n    Return Value: $deflator\n\n    Arguments: \\@arrayref_of_types_or_options\n\n    Return Value: @deflators\n\n    A deflator may be associated with any form field, and allows you to\n    provide \u003c$field-\u003edefault\u003e with a value which may be an object.\n\n    If an object doesn't stringify to a suitable value for display, the\n    deflator can ensure that the form field receives a suitable string value\n    instead.\n\n    See \"CORE DEFLATORS\" in HTML::FormFu::Deflator for a list of core\n    deflators.\n\n    If a \"name\" attribute isn't provided, a new deflator is created for and\n    added to every field on the form.\n\n    If you want to load a deflator in a namespace other than\n    \"HTML::FormFu::Deflator::\", you can use a fully qualified package-name\n    by prefixing it with \"+\".\n\n    \"deflator\" is an alias for \"deflators\".\n\n  insert_before\n    Arguments: $new_element, $existing_element\n\n    Return Value: $new_element\n\n    The 1st argument must be the element you want added, the 2nd argument\n    must be the existing element that the new element should be placed\n    before.\n\n        my $new = $form-\u003eelement(\\%specs);\n\n        my $position = $form-\u003eget_element({ type =\u003e $type, name =\u003e $name });\n\n        $form-\u003einsert_before( $new, $position );\n\n    In the first line of the above example, the $new element is initially\n    added to the end of the form. However, the \"insert_before\" method\n    reparents the $new element, so it will no longer be on the end of the\n    form. Because of this, if you try to copy an element from one form to\n    another, it will 'steal' the element, instead of copying it. In this\n    case, you must use \"clone\":\n\n        my $new = $form1-\u003eget_element({ type =\u003e $type1, name =\u003e $name1 })\n                        -\u003eclone;\n\n        my $position = $form2-\u003eget_element({ type =\u003e $type2, name =\u003e $name2 });\n\n        $form2-\u003einsert_before( $new, $position );\n\n  insert_after\n    Arguments: $new_element, $existing_element\n\n    Return Value: $new_element\n\n    The 1st argument must be the element you want added, the 2nd argument\n    must be the existing element that the new element should be placed\n    after.\n\n        my $new = $form-\u003eelement(\\%specs);\n\n        my $position = $form-\u003eget_element({ type =\u003e $type, name =\u003e $name });\n\n        $form-\u003einsert_after( $new, $position );\n\n    In the first line of the above example, the $new element is initially\n    added to the end of the form. However, the \"insert_after\" method\n    reparents the $new element, so it will no longer be on the end of the\n    form. Because of this, if you try to copy an element from one form to\n    another, it will 'steal' the element, instead of copying it. In this\n    case, you must use \"clone\":\n\n        my $new = $form1-\u003eget_element({ type =\u003e $type1, name =\u003e $name1 })\n                        -\u003eclone;\n\n        my $position = $form2-\u003eget_element({ type =\u003e $type2, name =\u003e $name2 });\n\n        $form2-\u003einsert_after( $new, $position );\n\n  remove_element\n    Arguments: $element\n\n    Return Value: $element\n\n    Removes the $element from the form or block's array of children.\n\n        $form-\u003eremove_element( $element );\n\n    The orphaned element cannot be usefully used for anything until it is\n    re-attached to a form or block with \"insert_before\" or \"insert_after\".\n\nFORM LOGIC AND VALIDATION\n    HTML::FormFu provides several stages for what is traditionally described\n    as *validation*. These are:\n\n    HTML::FormFu::Filter\n    HTML::FormFu::Constraint\n    HTML::FormFu::Inflator\n    HTML::FormFu::Validator\n    HTML::FormFu::Transformer\n\n    The first stage, the filters, allow for cleanup of user-input, such as\n    encoding, or removing leading/trailing whitespace, or removing non-digit\n    characters from a creditcard number.\n\n    All of the following stages allow for more complex processing, and each\n    of them have a mechanism to allow exceptions to be thrown, to represent\n    input errors. In each stage, all form fields must be processed without\n    error for the next stage to proceed. If there were any errors, the form\n    should be re-displayed to the user, to allow them to input correct\n    values.\n\n    Constraints are intended for low-level validation of values, such as \"is\n    this an integer?\", \"is this value within bounds?\" or \"is this a valid\n    email address?\".\n\n    Inflators are intended to allow a value to be turned into an appropriate\n    object. The resulting object will be passed to subsequent Validators and\n    Transformers, and will also be returned by \"params\" and \"param\".\n\n    Validators are intended for higher-level validation, such as\n    business-logic and database constraints such as \"is this username\n    unique?\". Validators are only run if all Constraints and Inflators have\n    run without errors. It is expected that most Validators will be\n    application-specific, and so each will be implemented as a separate\n    class written by the HTML::FormFu user.\n\n  filters\n  filter\n    Arguments: $type\n\n    Arguments: \\%options\n\n    Return Value: $filter\n\n    Arguments: \\@arrayref_of_types_or_options\n\n    Return Value: @filters\n\n    If you provide a \"name\" or \"names\" value, the filter will be added to\n    just that named field. If you do not provide a \"name\" or \"names\" value,\n    the filter will be added to all fields already attached to the form.\n\n    See \"CORE FILTERS\" in HTML::FormFu::Filter for a list of core filters.\n\n    If you want to load a filter in a namespace other than\n    \"HTML::FormFu::Filter::\", you can use a fully qualified package-name by\n    prefixing it with \"+\".\n\n    \"filter\" is an alias for \"filters\".\n\n  constraints\n  constraint\n    Arguments: $type\n\n    Arguments: \\%options\n\n    Return Value: $constraint\n\n    Arguments: \\@arrayref_of_types_or_options\n\n    Return Value: @constraints\n\n    See \"CORE CONSTRAINTS\" in HTML::FormFu::Constraint for a list of core\n    constraints.\n\n    If a \"name\" attribute isn't provided, a new constraint is created for\n    and added to every field on the form.\n\n    If you want to load a constraint in a namespace other than\n    \"HTML::FormFu::Constraint::\", you can use a fully qualified package-name\n    by prefixing it with \"+\".\n\n    \"constraint\" is an alias for \"constraints\".\n\n  inflators\n  inflator\n    Arguments: $type\n\n    Arguments: \\%options\n\n    Return Value: $inflator\n\n    Arguments: \\@arrayref_of_types_or_options\n\n    Return Value: @inflators\n\n    See \"CORE INFLATORS\" in HTML::FormFu::Inflator for a list of core\n    inflators.\n\n    If a \"name\" attribute isn't provided, a new inflator is created for and\n    added to every field on the form.\n\n    If you want to load an inflator in a namespace other than\n    \"HTML::FormFu::Inflator::\", you can use a fully qualified package-name\n    by prefixing it with \"+\".\n\n    \"inflator\" is an alias for \"inflators\".\n\n  validators\n  validator\n    Arguments: $type\n\n    Arguments: \\%options\n\n    Return Value: $validator\n\n    Arguments: \\@arrayref_of_types_or_options\n\n    Return Value: @validators\n\n    See \"CORE VALIDATORS\" in HTML::FormFu::Validator for a list of core\n    validators.\n\n    If a \"name\" attribute isn't provided, a new validator is created for and\n    added to every field on the form.\n\n    If you want to load a validator in a namespace other than\n    \"HTML::FormFu::Validator::\", you can use a fully qualified package-name\n    by prefixing it with \"+\".\n\n    \"validator\" is an alias for \"validators\".\n\n  transformers\n  transformer\n    Arguments: $type\n\n    Arguments: \\%options\n\n    Return Value: $transformer\n\n    Arguments: \\@arrayref_of_types_or_options\n\n    Return Value: @transformers\n\n    See \"CORE TRANSFORMERS\" in HTML::FormFu::Transformer for a list of core\n    transformers.\n\n    If a \"name\" attribute isn't provided, a new transformer is created for\n    and added to every field on the form.\n\n    If you want to load a transformer in a namespace other than\n    \"HTML::FormFu::Transformer::\", you can use a fully qualified\n    package-name by prefixing it with \"+\".\n\n    \"transformer\" is an alias for \"transformers\".\n\nCHANGING DEFAULT BEHAVIOUR\n  render_processed_value\n    The default behaviour when re-displaying a form after a submission, is\n    that the field contains the original unchanged user-submitted value.\n\n    If \"render_processed_value\" is true, the field value will be the final\n    result after all Filters, Inflators and Transformers have been run.\n    Deflators will also be run on the value.\n\n    If you set this on a field with an Inflator, but without an equivalent\n    Deflator, you should ensure that the Inflators stringify back to a\n    useable value, so as not to confuse / annoy the user.\n\n    Default Value: false\n\n    This method is a special 'inherited accessor', which means it can be set\n    on the form, a block element or a single element. When the value is\n    read, if no value is defined it automatically traverses the element's\n    hierarchy of parents, through any block elements and up to the form,\n    searching for a defined value.\n\n  force_errors\n    Force a constraint to fail, regardless of user input.\n\n    If this is called at runtime, after the form has already been processed,\n    you must called \"process\" in HTML::FormFu again before redisplaying the\n    form to the user.\n\n    Default Value: false\n\n    This method is a special 'inherited accessor', which means it can be set\n    on the form, a block element, an element or a single constraint. When\n    the value is read, if no value is defined it automatically traverses the\n    element's hierarchy of parents, through any block elements and up to the\n    form, searching for a defined value.\n\n  params_ignore_underscore\n    If true, causes \"params\", \"param\" and \"valid\" to ignore any fields whose\n    name starts with an underscore \"_\".\n\n    The field is still processed as normal, and errors will cause\n    \"submitted_and_valid\" to return false.\n\n    Default Value: false\n\nFORM ATTRIBUTES\n    All attributes are added to the rendered form's start tag.\n\n  attributes\n  attrs\n    Arguments: [%attributes]\n\n    Arguments: [\\%attributes]\n\n    Return Value: $form\n\n    Accepts either a list of key/value pairs, or a hash-ref.\n\n        ---\n        attributes:\n          id: form\n          class: fancy_form\n\n    As a special case, if no arguments are passed, the attributes hash-ref\n    is returned. This allows the following idioms.\n\n        # set a value\n        $form-\u003eattributes-\u003e{id} = 'form';\n\n        # delete all attributes\n        %{ $form-\u003eattributes } = ();\n\n    \"attrs\" is an alias for \"attributes\".\n\n  attributes_xml\n  attrs_xml\n    Provides the same functionality as \"attributes\", but values won't be\n    XML-escaped.\n\n    \"attrs_xml\" is an alias for \"attributes_xml\".\n\n  add_attributes\n  add_attrs\n    Arguments: [%attributes]\n\n    Arguments: [\\%attributes]\n\n    Return Value: $form\n\n    Accepts either a list of key/value pairs, or a hash-ref.\n\n        $form-\u003eadd_attributes( $key =\u003e $value );\n        $form-\u003eadd_attributes( { $key =\u003e $value } );\n\n    All values are appended to existing values, with a preceding space\n    character. This is primarily to allow the easy addition of new names to\n    the class attribute.\n\n        $form-\u003eattributes({ class =\u003e 'foo' });\n\n        $form-\u003eadd_attributes({ class =\u003e 'bar' });\n\n        # class is now 'foo bar'\n\n    \"add_attrs\" is an alias for \"add_attributes\".\n\n  add_attributes_xml\n  add_attrs_xml\n    Provides the same functionality as \"add_attributes\", but values won't be\n    XML-escaped.\n\n    \"add_attrs_xml\" is an alias for \"add_attributes_xml\".\n\n  del_attributes\n  del_attrs\n    Arguments: [%attributes]\n\n    Arguments: [\\%attributes]\n\n    Return Value: $form\n\n    Accepts either a list of key/value pairs, or a hash-ref.\n\n        $form-\u003edel_attributes( $key =\u003e $value );\n        $form-\u003edel_attributes( { $key =\u003e $value } );\n\n    All values are removed from the attribute value.\n\n        $form-\u003eattributes({ class =\u003e 'foo bar' });\n\n        $form-\u003edel_attributes({ class =\u003e 'bar' });\n\n        # class is now 'foo'\n\n    \"del_attrs\" is an alias for \"del_attributes\".\n\n  del_attributes_xml\n  del_attrs_xml\n    Provides the same functionality as \"del_attributes\", but values won't be\n    XML-escaped.\n\n    \"del_attrs_xml\" is an alias for \"del_attributes_xml\".\n\n    The following methods are shortcuts for accessing \"attributes\" keys.\n\n  id\n    Arguments: [$id]\n\n    Return Value: $id\n\n    Get or set the form's DOM id.\n\n    Default Value: none\n\n  action\n    Arguments: [$uri]\n\n    Return Value: $uri\n\n    Get or set the action associated with the form. The default is no\n    action, which causes most browsers to submit to the current URI.\n\n    Default Value: \"\"\n\n  enctype\n    Arguments: [$enctype]\n\n    Return Value: $enctype\n\n    Get or set the encoding type of the form. Valid values are\n    \"application/x-www-form-urlencoded\" and \"multipart/form-data\".\n\n    If the form contains a File element, the enctype is automatically set to\n    \"multipart/form-data\".\n\n  method\n    Arguments: [$method]\n\n    Return Value: $method\n\n    Get or set the method used to submit the form. Can be set to either\n    \"post\" or \"get\".\n\n    Default Value: \"post\"\n\nCSS CLASSES\n  auto_id\n    Arguments: [$string]\n\n    If set, then all form fields will be given an auto-generated id\n    attribute, if it doesn't have one already.\n\n    The following character substitution will be performed: %f will be\n    replaced by $form-\u003eid, %n will be replaced by $field-\u003ename, %r will be\n    replaced by $block-\u003erepeatable_count.\n\n    Default Value: not defined\n\n    This method is a special 'inherited accessor', which means it can be set\n    on the form, a block element or a single element. When the value is\n    read, if no value is defined it automatically traverses the element's\n    hierarchy of parents, through any block elements and up to the form,\n    searching for a defined value.\n\n  auto_label\n    Arguments: [$string]\n\n    If set, then all form fields will be given an auto-generated name, if it\n    doesn't have one already.\n\n    The following character substitution will be performed: %f will be\n    replaced by $form-\u003eid, %n will be replaced by $field-\u003ename.\n\n    The generated string will be passed to \"localize\" to create the label.\n\n    Default Value: not defined\n\n    This method is a special 'inherited accessor', which means it can be set\n    on the form, a block element or a single element. When the value is\n    read, if no value is defined it automatically traverses the element's\n    hierarchy of parents, through any block elements and up to the form,\n    searching for a defined value.\n\n  auto_error_class\n    Arguments: [$string]\n\n    If set, then all form errors will be given an auto-generated class-name.\n\n    The following character substitution will be performed: %f will be\n    replaced by $form-\u003eid, %n will be replaced by $field-\u003ename, %t will be\n    replaced by lc( $field-\u003etype ), %s will be replaced by $error-\u003estage.\n\n    Default Value: 'error_%s_%t'\n\n    This method is a special 'inherited accessor', which means it can be set\n    on the form, a block element or a single element. When the value is\n    read, if no value is defined it automatically traverses the element's\n    hierarchy of parents, through any block elements and up to the form,\n    searching for a defined value.\n\n  auto_error_message\n    Arguments: [$string]\n\n    If set, then all form fields will be given an auto-generated message, if\n    it doesn't have one already.\n\n    The following character substitution will be performed: %f will be\n    replaced by $form-\u003eid, %n will be replaced by $field-\u003ename, %t will be\n    replaced by lc( $field-\u003etype ), %s will be replaced by $error-\u003estage.\n\n    The generated string will be passed to \"localize\" to create the message.\n\n    For example, a Required constraint will return the string\n    \"form_constraint_required\". Under the default localization behaviour,\n    the appropriate message for \"form_constraint_required\" will be used from\n    the default I18N package.\n\n    Default Value: 'form_%s_%t'\n\n    This method is a special 'inherited accessor', which means it can be set\n    on the form, a block element or a single element. When the value is\n    read, if no value is defined it automatically traverses the element's\n    hierarchy of parents, through any block elements and up to the form,\n    searching for a defined value.\n\n  auto_constraint_class\n    Arguments: [$string]\n\n    If set, then all form fields will be given an auto-generated class-name\n    for each associated constraint.\n\n    The following character substitution will be performed: %f will be\n    replaced by $form-\u003eid, %n will be replaced by $field-\u003ename, %t will be\n    replaced by lc( $field-\u003etype ).\n\n    Default Value: not defined\n\n    This method is a special 'inherited accessor', which means it can be set\n    on the form, a block element or a single element. When the value is\n    read, if no value is defined it automatically traverses the element's\n    hierarchy of parents, through any block elements and up to the form,\n    searching for a defined value.\n\n  auto_inflator_class\n    Arguments: [$string]\n\n    If set, then all form fields will be given an auto-generated class-name\n    for each associated inflator.\n\n    The following character substitution will be performed: %f will be\n    replaced by $form-\u003eid, %n will be replaced by $field-\u003ename, %t will be\n    replaced by lc( $field-\u003etype ).\n\n    Default Value: not defined\n\n    This method is a special 'inherited accessor', which means it can be set\n    on the form, a block element or a single element. When the value is\n    read, if no value is defined it automatically traverses the element's\n    hierarchy of parents, through any block elements and up to the form,\n    searching for a defined value.\n\n  auto_validator_class\n    Arguments: [$string]\n\n    If set, then all form fields will be given an auto-generated class-name\n    for each associated validator.\n\n    The following character substitution will be performed: %f will be\n    replaced by $form-\u003eid, %n will be replaced by $field-\u003ename, %t will be\n    replaced by lc( $field-\u003etype ).\n\n    Default Value: not defined\n\n    This method is a special 'inherited accessor', which means it can be set\n    on the form, a block element or a single element. When the value is\n    read, if no value is defined it automatically traverses the element's\n    hierarchy of parents, through any block elements and up to the form,\n    searching for a defined value.\n\n  auto_transformer_class\n    Arguments: [$string]\n\n    If set, then all form fields will be given an auto-generated class-name\n    for each associated validator.\n\n    The following character substitution will be performed: %f will be\n    replaced by $form-\u003eid, %n will be replaced by $field-\u003ename, %t will be\n    replaced by lc( $field-\u003etype ).\n\n    Default Value: not defined\n\n    This method is a special 'inherited accessor', which means it can be set\n    on the form, a block element or a single element. When the value is\n    read, if no value is defined it automatically traverses the element's\n    hierarchy of parents, through any block elements and up to the form,\n    searching for a defined value.\n\nLOCALIZATION\n  languages\n    Arguments: [\\@languages]\n\n    A list of languages which will be passed to the localization object.\n\n    Default Value: ['en']\n\n  localize_class\n    Arguments: [$class_name]\n\n    Classname to be used for the default localization object.\n\n    Default Value: 'HTML::FormFu::I18N'\n\n  localize\n  loc\n    Arguments: [$key, @arguments]\n\n    Compatible with the \"maketext\" method in Locale::Maketext.\n\n  locale\n    Arguments: $locale\n\n    Currently only used by HTML::FormFu::Deflator::FormatNumber and\n    HTML::FormFu::Filter::FormatNumber.\n\n    This method is a special 'inherited accessor', which means it can be set\n    on the form, a block element or a single element. When the value is\n    read, if no value is defined it automatically traverses the element's\n    hierarchy of parents, through any block elements and up to the form,\n    searching for a defined value.\n\nPROCESSING A FORM\n  query\n    Arguments: [$query_object]\n\n    Arguments: \\%params\n\n    Provide a CGI compatible query object or a hash-ref of submitted\n    names/values. Alternatively, the query object can be passed directly to\n    the \"process\" object.\n\n  query_type\n    Arguments: [$query_type]\n\n    Set which module is being used to provide the \"query\".\n\n    The Catalyst::Controller::HTML::FormFu automatically sets this to\n    \"Catalyst\".\n\n    Valid values are \"CGI\", \"Catalyst\" and \"CGI::Simple\".\n\n    Default Value: 'CGI'\n\n  process\n    Arguments: [$query_object]\n\n    Arguments: [\\%params]\n\n    Process the provided query object or input values. \"process\" must be\n    called before calling any of the methods listed under \"SUBMITTED FORM\n    VALUES AND ERRORS\" and \"MODIFYING A SUBMITTED FORM\".\n\n    \"process\" must also be called at least once before printing the form or\n    calling \"render\" or \"render_data\".\n\n    Note to users of Catalyst::Controller::HTML::FormFu: Because \"process\"\n    is automatically called for you by the Catalyst controller; if you make\n    any modifications to the form within your action method, such as adding\n    or changing elements, adding constraints, etc; you must call \"process\"\n    again yourself before using \"submitted_and_valid\", any of the methods\n    listed under \"SUBMITTED FORM VALUES AND ERRORS\" or \"MODIFYING A\n    SUBMITTED FORM\", or rendering the form.\n\nSUBMITTED FORM VALUES AND ERRORS\n  submitted\n    Returns true if the form has been submitted. See \"indicator\" for details\n    on how this is computed.\n\n  submitted_and_valid\n    Shorthand for \"$form-\u003esubmitted \u0026\u0026 !$form-\u003ehas_errors\"\n\n  params\n    Return Value: \\%params\n\n    Returns a hash-ref of all valid input for which there were no errors.\n\n  param_value\n    Arguments: $field_name\n\n    A more reliable, recommended version of \"param\". Guaranteed to always\n    return a single value, regardless of whether it's called in list context\n    or not. If multiple values were submitted, this only returns the first\n    value. If the value is invalid or the form was not submitted, it returns\n    \"undef\". This makes it suitable for use in list context, where a single\n    value is required.\n\n        $db-\u003eupdate({\n            name    =\u003e $form-\u003eparam_value('name'),\n            address =\u003e $form-\u003eparam_value('address),\n        });\n\n  param_array\n    Arguments: $field_name\n\n    Guaranteed to always return an array-ref of values, regardless of\n    context and regardless of whether multiple values were submitted or not.\n    If the value is invalid or the form was not submitted, it returns an\n    empty array-ref.\n\n  param_list\n    Arguments: $field_name\n\n    Guaranteed to always return a list of values, regardless of context. If\n    the value is invalid or the form was not submitted, it returns an empty\n    list.\n\n  param\n    Arguments: [$field_name]\n\n    Return Value: $input_value\n\n    Return Value: @valid_names\n\n    No longer recommended for use, as its behaviour is hard to predict. Use\n    param_value, param_array or param_list instead.\n\n    A (readonly) method similar to that of CGI's.\n\n    If a field name is given, in list-context returns any valid values\n    submitted for that field, and in scalar-context returns only the first\n    of any valid values submitted for that field.\n\n    If no argument is given, returns a list of all valid input field names\n    without errors.\n\n    Passing more than 1 argument is a fatal error.\n\n  valid\n    Arguments: [$field_name]\n\n    Return Value: @valid_names\n\n    Return Value: $bool\n\n    If a field name if given, returns \"true\" if that field had no errors and\n    \"false\" if there were errors.\n\n    If no argument is given, returns a list of all valid input field names\n    without errors.\n\n  has_errors\n    Arguments: [$field_name]\n\n    Return Value: @names\n\n    Return Value: $bool\n\n    If a field name if given, returns \"true\" if that field had errors and\n    \"false\" if there were no errors.\n\n    If no argument is given, returns a list of all input field names with\n    errors.\n\n  get_errors\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: \\@errors\n\n    Returns an array-ref of exception objects from all fields in the form.\n\n    Accepts both \"name\", \"type\" and \"stage\" arguments to narrow the returned\n    results.\n\n        $form-\u003eget_errors({\n            name  =\u003e 'foo',\n            type  =\u003e 'Regex',\n            stage =\u003e 'constraint'\n        });\n\n  get_error\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: $error\n\n    Accepts the same arguments as \"get_errors\", but only returns the first\n    error found.\n\nMODEL / DATABASE INTERACTION\n    See HTML::FormFu::Model for further details and available models.\n\n  default_model\n    Arguments: $model_name\n\n    Default Value: 'DBIC'\n\n  model\n    Arguments: [$model_name]\n\n    Return Value: $model\n\n  model_config\n    Arguments: \\%config\n\nMODIFYING A SUBMITTED FORM\n  add_valid\n    Arguments: $name, $value\n\n    Return Value: $value\n\n    The provided value replaces any current value for the named field. This\n    value will be returned in subsequent calls to \"params\" and \"param\" and\n    the named field will be included in calculations for \"valid\".\n\n  clear_errors\n    Deletes all errors from a submitted form.\n\nRENDERING A FORM\n  render\n    Return Value: $string\n\n    You must call \"process\" once after building the form, and before calling\n    \"render\".\n\n  start\n    Return Value: $string\n\n    Returns the form start tag, and any output of \"form_error_message\" and\n    \"javascript\".\n\n    Implicitly uses the \"tt\" \"render_method\".\n\n  end\n    Return Value: $string\n\n    Returns the form end tag.\n\n    Implicitly uses the \"tt\" \"render_method\".\n\n  hidden_fields\n    Return Value: $string\n\n    Returns all hidden form fields.\n\nPLUGIN SYSTEM\n    \"HTML::FormFu\" provides a plugin-system that allows plugins to be easily\n    added to a form or element, to change the default behaviour or output.\n\n    See HTML::FormFu::Plugin for details.\n\nADVANCED CUSTOMISATION\n    By default, formfu renders \"XHTML 1.0 Strict\" compliant markup, with as\n    little extra markup as possible, but with sufficient CSS class names to\n    allow for a wide-range of output styles to be generated by changing only\n    the CSS.\n\n    If you wish to customise the markup, you'll need to tell HTML::FormFu to\n    use an external rendering engine, such as Template Toolkit or\n    Template::Alloy. See \"render_method\" and \"tt_module\" for details.\n\n    Even if you set HTML::FormFu to use Template::Toolkit to render, the\n    forms, HTML::FormFu can still be used in conjunction with whichever\n    other templating system you prefer to use for your own page layouts,\n    whether it's HTML::Template: \"\u003cTMPL_VAR form\u003e\", Petal: \"\u003cform\n    tal:replace=\"form\"\u003e\u003c/form\u003e\" or Template::Magic: \"\u003c!-- {form} --\u003e\".\n\n  render_method\n    Default Value: \"string\"\n\n    Can be set to \"tt\" to generate the form with external template files.\n\n    To customise the markup, you'll need a copy of the template files, local\n    to your application. See \"Installing the TT templates\" in\n    HTML::FormFu::Manual::Cookbook for further details.\n\n    You can customise the markup for a single element by setting that\n    element's \"render_method\" to \"tt\", while the rest of the form uses the\n    default \"string\" render-method. Note though, that if you try setting the\n    form or a Block's \"render_method\" to \"tt\", and then set a child\n    element's \"render_method\" to \"string\", that setting will be ignored, and\n    the child elements will still use the \"tt\" render-method.\n\n        ---\n        elements:\n          - name: foo\n            render_method: tt\n            filename: custom_field\n\n          - name: bar\n\n        # in this example, 'foo' will use a custom template,\n        # while bar will use the default 'string' rendering method\n\n    This method is a special 'inherited accessor', which means it can be set\n    on the form, a block element or a single element. When the value is\n    read, if no value is defined it automatically traverses the element's\n    hierarchy of parents, through any block elements and up to the form,\n    searching for a defined value.\n\n  filename\n    Change the template filename used for the form.\n\n    Default Value: \"form\"\n\n  tt_args\n    Arguments: [\\%constructor_arguments]\n\n    Accepts a hash-ref of arguments passed to \"render_method\", which is\n    called internally by \"render\".\n\n    Within \"tt\", the keys \"RELATIVE\" and \"RECURSION\" are overridden to\n    always be true, as these are a basic requirement for the Template\n    engine.\n\n    The system directory containing HTML::FormFu's template files is always\n    added to the end of \"INCLUDE_PATH\", so that the core template files will\n    be found. You only need to set this yourself if you have your own copy\n    of the template files for customisation purposes.\n\n    This method is a special 'inherited accessor', which means it can be set\n    on the form, a block element or a single element. When the value is\n    read, if no value is defined it automatically traverses the element's\n    hierarchy of parents, through any block elements and up to the form,\n    searching for a defined value.\n\n  add_tt_args\n    Arguments: [\\%constructor_arguments]\n\n    Ensures that the hash-ref argument is merged with any existing hash-ref\n    value of \"tt_args\".\n\n  tt_module\n    Default Value: Template\n\n    The module used when \"render_method\" is set to \"tt\". Should provide an\n    interface compatible with Template.\n\n    This method is a special 'inherited accessor', which means it can be set\n    on the form, a block element or a single element. When the value is\n    read, if no value is defined it automatically traverses the element's\n    hierarchy of parents, through any block elements and up to the form,\n    searching for a defined value.\n\n  render_data\n    Usually called implicitly by \"render\". Returns the data structure that\n    would normally be passed onto the \"string\" or \"tt\" render-methods.\n\n    As with \"render\", you must call \"process\" once after building the form,\n    and before calling \"render_data\".\n\n  render_data_non_recursive\n    Like \"render_data\", but doesn't include the data for any child-elements.\n\nINTROSPECTION\n  get_fields\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: \\@elements\n\n    Returns all fields in the form (specifically, all elements which have a\n    true \"is_field\" in HTML::FormFu::Element value.\n\n    Accepts both \"name\" and \"type\" arguments to narrow the returned results.\n\n        $form-\u003eget_fields({\n            name =\u003e 'foo',\n            type =\u003e 'Radio',\n        });\n\n    Accepts also an Regexp to search for results.\n\n        $form-\u003eget_elements({\n            name =\u003e qr/oo/,\n        });\n\n  get_field\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: $element\n\n    Accepts the same arguments as \"get_fields\", but only returns the first\n    field found.\n\n  get_elements\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: \\@elements\n\n    Returns all top-level elements in the form (not recursive). See\n    \"get_all_elements\" for a recursive version.\n\n    Accepts both \"name\" and \"type\" arguments to narrow the returned results.\n\n        $form-\u003eget_elements({\n            name =\u003e 'foo',\n            type =\u003e 'Radio',\n        });\n\n    Accepts also an Regexp to search for results.\n\n        $form-\u003eget_elements({\n            name =\u003e qr/oo/,\n        });\n\n  get_element\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: $element\n\n    Accepts the same arguments as \"get_elements\", but only returns the first\n    element found.\n\n    See \"get_all_element\" for a recursive version.\n\n  get_all_elements\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: \\@elements\n\n    Returns all elements in the form recursively.\n\n    Optionally accepts both \"name\" and \"type\" arguments to narrow the\n    returned results.\n\n        # return all Text elements\n\n        $form-\u003eget_all_elements({\n            type =\u003e 'Text',\n        });\n\n    Accepts also an Regexp to search for results.\n\n        $form-\u003eget_elements({\n            name =\u003e qr/oo/,\n        });\n\n    See \"get_elements\" for a non-recursive version.\n\n  get_all_element\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: $element\n\n    Accepts the same arguments as \"get_all_elements\", but only returns the\n    first element found.\n\n        # return the first Text field found, regardless of whether it's\n        # within a fieldset or not\n\n        $form-\u003eget_all_element({\n            type =\u003e 'Text',\n        });\n\n    Accepts also an Regexp to search for results.\n\n        $form-\u003eget_elements({\n            name =\u003e qr/oo/,\n        });\n\n    See \"get_all_elements\" for a non-recursive version.\n\n  get_deflators\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: \\@deflators\n\n    Returns all top-level deflators from all fields.\n\n    Accepts both \"name\" and \"type\" arguments to narrow the returned results.\n\n        $form-\u003eget_deflators({\n            name =\u003e 'foo',\n            type =\u003e 'Strftime',\n        });\n\n  get_deflator\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: $element\n\n    Accepts the same arguments as \"get_deflators\", but only returns the\n    first deflator found.\n\n  get_filters\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: \\@filters\n\n    Returns all top-level filters from all fields.\n\n    Accepts both \"name\" and \"type\" arguments to narrow the returned results.\n\n        $form-\u003eget_filters({\n            name =\u003e 'foo',\n            type =\u003e 'LowerCase',\n        });\n\n  get_filter\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: $filter\n\n    Accepts the same arguments as \"get_filters\", but only returns the first\n    filter found.\n\n  get_constraints\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: \\@constraints\n\n    Returns all constraints from all fields.\n\n    Accepts both \"name\" and \"type\" arguments to narrow the returned results.\n\n        $form-\u003eget_constraints({\n            name =\u003e 'foo',\n            type =\u003e 'Equal',\n        });\n\n  get_constraint\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: $constraint\n\n    Accepts the same arguments as \"get_constraints\", but only returns the\n    first constraint found.\n\n  get_inflators\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: \\@inflators\n\n    Returns all inflators from all fields.\n\n    Accepts both \"name\" and \"type\" arguments to narrow the returned results.\n\n        $form-\u003eget_inflators({\n            name =\u003e 'foo',\n            type =\u003e 'DateTime',\n        });\n\n  get_inflator\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: $inflator\n\n    Accepts the same arguments as \"get_inflators\", but only returns the\n    first inflator found.\n\n  get_validators\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: \\@validators\n\n    Returns all validators from all fields.\n\n    Accepts both \"name\" and \"type\" arguments to narrow the returned results.\n\n        $form-\u003eget_validators({\n            name =\u003e 'foo',\n            type =\u003e 'Callback',\n        });\n\n  get_validator\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: $validator\n\n    Accepts the same arguments as \"get_validators\", but only returns the\n    first validator found.\n\n  get_transformers\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: \\@transformers\n\n    Returns all transformers from all fields.\n\n    Accepts both \"name\" and \"type\" arguments to narrow the returned results.\n\n        $form-\u003eget_transformers({\n            name =\u003e 'foo',\n            type =\u003e 'Callback',\n        });\n\n  get_transformer\n    Arguments: [%options]\n\n    Arguments: [\\%options]\n\n    Return Value: $transformer\n\n    Accepts the same arguments as \"get_transformers\", but only returns the\n    first transformer found.\n\n  clone\n    Returns a deep clone of the \u003c$form\u003e object.\n\n    Because of scoping issues, code references (such as in Callback\n    constraints) are copied instead of cloned.\n\nDEPRECATED METHODS\n  element_defaults\n    Is deprecated and provided only for backwards compatability. Will be\n    removed at some point in the future.\n\n    See \"default_args\" instead.\n\n  model_class\n    Is deprecated and provided only for backwards compatability. Will be\n    removed at some point in the future.\n\n    Use \"default_model\" instead.\n\n  defaults_from_model\n    Is deprecated and provided only for backwards compatability. Will be\n    removed at some point in the future.\n\n    Use \"default_values\" in HTML::FormFu::Model instead.\n\n        $form-\u003emodel-\u003edefault_values( $object, \\%config )\n\n  save_to_model\n    Is deprecated and provided only for backwards compatability. Will be\n    removed at some point in the future.\n\n    Use \"update\" in HTML::FormFu::Model instead.\n\n        $form-\u003emodel-\u003eupdate( $object, \\%config )\n\nDEPRECATION POLICY\n    We try our best to not make incompatable changes, but if they're\n    required we'll make every effort possible to provide backwards\n    compatibility for several release-cycles, issuing a warnings about the\n    changes, before removing the legacy features.\n\nBEST PRACTICES\n    It is advisable to keep application-wide (or global) settings in a\n    single config file, which should be loaded by each form.\n\n    See \"load_config_file\".\n\nCOOKBOOK\n    HTML::FormFu::Manual::Cookbook\n\n  UNICODE\n    HTML::FormFu::Manual::Unicode\n\nEXAMPLES\n  vertically-aligned CSS\n    The distribution directory \"examples/vertically-aligned\" contains a form\n    with example CSS for a \"vertically aligned\" theme.\n\n    This can be viewed by opening the file \"vertically-aligned.html\" in a\n    web-browser.\n\n    If you wish to experiment with making changes, the form is defined in\n    file \"vertically-aligned.yml\", and the HTML file can be updated with any\n    changes by running the following command (while in the distribution root\n    directory).\n\n        perl examples/vertically-aligned/vertically-aligned.pl\n\n    This uses the Template Toolkit file \"vertically-aligned.tt\", and the CSS\n    is defined in files \"vertically-aligned.css\" and\n    \"vertically-aligned-ie.css\".\n\nSUPPORT\n    Website:\n\n    \u003chttp://www.formfu.org\u003e\n\n    Project Page:\n\n    \u003chttp://code.google.com/p/html-formfu/\u003e\n\n    Mailing list:\n\n    \u003chttp://lists.scsys.co.uk/cgi-bin/mailman/listinfo/html-formfu\u003e\n\n    Mailing list archives:\n\n    \u003chttp://lists.scsys.co.uk/pipermail/html-formfu/\u003e\n\n    IRC:\n\n    \"irc.perl.org\", channel \"#formfu\"\n\n    The \u003cHTML::Widget archives\u003e between January and May 2007 also contain\n    discussion regarding HTML::FormFu.\n\nBUGS\n    Please submit bugs / feature requests to\n    \u003chttp://code.google.com/p/html-formfu/issues/list\u003e (preferred) or\n    \u003chttp://rt.perl.org\u003e.\n\nPATCHES\n    To help patches be applied quickly, please send them to the mailing\n    list; attached, rather than inline; against subversion, rather than a\n    cpan version (run \"svn diff \u003e patchfile\"); mention which svn version\n    it's against. Mailing list messages are limited to 256KB, so gzip the\n    patch if necessary.\n\nSUBVERSION REPOSITORY\n    The publicly viewable subversion code repository is at\n    \u003chttp://html-formfu.googlecode.com/svn/trunk/HTML-FormFu\u003e.\n\n    If you wish to contribute, you'll need a google account. Then just ask\n    on the mailing list for commit access, giving the email address your\n    account uses.\n\n    If you wish to contribute but for some reason really don't want to sign\n    up for a google account, please post patches to the mailing list\n    (although you'll have to wait for someone to commit them).\n\n    If you have commit permissions, use the HTTPS repository url:\n    \u003chttps://html-formfu.googlecode.com/svn/trunk/HTML-FormFu\u003e\n\nSEE ALSO\n    HTML::FormFu::Imager\n\n    Catalyst::Controller::HTML::FormFu\n\n    HTML::FormFu::Model::DBIC\n\nAUTHORS\n    Carl Franks\n\nCONTRIBUTORS\n    Brian Cassidy\n\n    Ozum Eldogan\n\n    Ruben Fonseca\n\n    Ronald Kimball\n\n    Daisuke Maki\n\n    Andreas Marienborg\n\n    Mario Minati\n\n    Steve Nolte\n\n    Moritz Onken\n\n    Doug Orleans\n\n    Based on the original source code of HTML::Widget, by Sebastian Riedel,\n    \"sri@oook.de\".\n\nLICENSE\n    This library is free software, you can redistribute it and/or modify it\n    under the same terms as Perl itself.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleto%2Fhtml-formfu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fleto%2Fhtml-formfu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fleto%2Fhtml-formfu/lists"}