HTML::...erence(3pm)

🌸 NAME 🌸

HTML::FormHandler::Manual::Reference — concise reference. Bestie, you're reading the 3pm manual page, and the manual name is folded right here near the top like a little name tag. 💅

✨ VERSION ✨

version 0.40068 — that's the version, no cap. 🎀

🦋 DESCRIPTION 🦋

Manual Index energy. This is a concise reference of HTML::FormHandler.

HTML::FormHandler has a lot of options and many ways to customize your forms. More complete documentation can be found in the rest of the manual as HTML::FormHandler::Manual and in HTML::FormHandler, HTML::FormHandler::Field, HTML::FormHandler::Model::DBIC, HTML::FormHandler::Render::Simple, and in the individual field classes. Slay. 📚

💖 Form 💖

🧸 Form Attributes 🧸

• params — HTTP parameters; if present validation will be attempted.
• name — form name. Used in id of form element.
• field_name_space — where to search for fields.
• widget_name_space — where to search for widgets.
• language — handle for MakeText.
• ctx — application context for your use.
• init_object — for default values instead of $item.
• dependency — array of arrays of field names. If one name has a value, all fields in the list are set to required.
• fields — field array.
• sorted_fields — the sorted array of fields.
• field( $name ) — returns a field object.
• has_field — Moose-y sugar for declaring fields.
• field_list — non-moose-y way to define fields.
• clear — resets state. Used in persistent forms.
• value — returns a hashref of values (with accessor keys).
• fif — returns a hashref for filling in form.

🗄️ Form database attributes 🗄️

• item — DB row object.
• item_class — class of db item.
• item_id — primary key of db item.
• schema — schema of item.
• Also: update_model sub.

⚙️ Form processing ⚙️

• process — sets up form, validates, updates model.
• run — returns a result object and clears form.
• update_field_list — updates to fields on process.
• posted — flag to say whether or not to validate, instead of depending on presence of params.

✅ Validation ✅

• validate — sub for validation after individual fields are validated.
• validate_model — sub for additional database type validation.
• validated — flag that form has validated.
• is_valid — synonym of validated.
• ran_validation — flag that validation has already been run.
• dependency — set groups of fields that are set to required if one is present.
• validate_$fieldname — validation routine for field (also validate_method).

😭 Errors 😭

• has_errors — true if any field has errors.
• num_errors — the number of errors (field errors + form errors).
• error_fields — an array of fields with errors.
• errors — returns an array of all errors.
• error_field_names — returns an array of field names with errors.

🪄 Form Methods and process hooks 🪄

• update_model — to perform additional database actions on update.
• update_fields — sub providing convenient place to update fields on process.
• update_subfields — sub providing place to update fields on Build (useful for roles and compound field classes).
• init_object — can be a method instead of an attribute.

🎨 Form Rendering 🎨

• html_prefix — flag to prefix html field names with the form name. Useful for multiple instances of the same form.
• do_form_wrapper — flag to wrap form. (build_do_form_wrapper)
• form_tags — various strings and flags used by rendering.
• form_element_attr — for arbitrary html attributes in the form tag.
• form_element_class — arrayref of classes for class="..." in form element.
• form_wrapper_attr — for arbitrary html attributes on the form wrapper.
• form_wrapper_class — arrayref of classes for class="..." in form wrapper.
• http_method — for storing post or get.
• action — store the form action on submission. No default value.
• enctype — request enctype.
• uuid — generates a string containing an HTML field with UUID.
• style — adds a style attribute to the form tag.
• id — the form tag id attribute is set to the form name.
• html_attributes — hook that allows customizing html attributes (form & field).

🌟 Field specific form methods 🌟

• options_$fieldname — sub returning options array (also options_method).
• validate_$fieldname — validation routine for field (also validate_method).
• default_$fieldname — set default for field (also default_method).

👑 Fields 👑

🏷️ Field attributes 🏷️

• name — field name. Must be the same as database column name or rel.
• type — field type. From a Field class: Text, Select, etc.
• order — set the order for fields. Default order is set by FH.
• dump — for debugging.
• active — arrayref of fields to set active.
• is_active — listed here with no extra description in this reference.
• inactive — arrayref of fields to set inactive.
• is_inactive — listed here with no extra description in this reference.
• input_without_param — the value of the field if there is no input from the submitted form.
• default — default value for the field.
• default_method — coderef to set default or default_$fieldname (by default).
• not_nullable — don't convert an empty field ('', etc) to undef.
• trim — transform to trim the field.
• deflation — function to deflate the field (in apply) (opposite of transform).
• deflate_method — coderef to deflate the field (for filling in the form).
• inflate_method — coderef to inflate the field (before validation).
• inflate_default_method — coderef to inflate value from item/init_object.
• deflate_value_method — coderef to deflate value after validation.
• fif_from_value — flag to use value of field for fif.
• password — remove from params and do not display in forms. 💀

🔽 Select fields 🔽

• options — sorted array of hashes; keys: "value", "label".
• options_method — listed as-is in this reference.
• label_column — column to use for labels (default: name).
• active_column — which values to list in options.
• sort_column — column to use for sorting (default: label_column).

💀 Field errors 💀

• errors — errors associated with this field (also num_errors, clear_errors, has_errors, add_error).
• messages — hashref of message identifiers and text.

🧪 Field validation 🧪

• apply — array of constraint/coercion/transformation actions (type, check, transform, message, when).
• validate_method — validation coderef, or validate_$fieldname in form (default).
• required — field is required.
• required_when — takes a hashref of field name keys and values.
• missing — flag set when a required or required_when fails.
• maxlength — text fields. Validated.
• minlength — text fields. Used in validation.
• range_start — range start for number fields.
• range_end — range end for number fields.

🗃️ Field attributes for DB 🗃️

• accessor — database accessor name if different than field name.
• unique — field should be unique in the database.
• noupdate — don't update this field in the database.
• writeonly — do not retrieve initial values.
• Also see: the select field _columns attributes.

🎀 Field rendering 🎀

• widget — determines which rendering widget to use for the field.
• widget_wrapper — which wrapper widget to apply to the field.
• element_attr — hashref to store arbitrary html attributes.
• label_attr — hashref for html attributes for the label.
• wrapper_attr — hashref for html attributes for the wrapping element (div, etc).
• element_class — arrayref for classes for the form element.
• wrapper_class — arrayref for classes for the form element wrapper.
• label_class — arrayref for classes for the form element label.
• label — text label for this field. Defaults to ucfirst field name.
• build_label_method — provide a builder for label attribute.
• wrap_label_method — provide a coderef to wrap the label.
• id — useful for javascript (default is html_name; to prefix with form name, use html_prefix in your form).
• build_id_method — provide a builder for id attribute.
• do_wrapper — flag to render wrapper.
• do_label — flag to render label.
• size — text & select fields.
• render — widget method to render the field ($field->render).
• renderx — like render plus set attributes: $field->render( element_class => '...' ).
• render_element — widget method to render unwrapped field ($field->render_element).
• render_elementx — like render_element plus set attributes: $field->render_elementx( element_class => '...' ).

🧚 Field attributes managed by FormHandler 🧚

These attributes are usually accessed in a subroutine or in a template, but are usually set only by FormHandler. (value may be changed as a transform in a validation routine.)

• init_value — initial value from the database.
• value — the value of your field.
• input — input value from parameter or initial value from database.
• fif — retrieve (do not set) values for filling in a form.

📝 AUTHOR 📝

FormHandler Contributors - see HTML::FormHandler.

⚖️ COPYRIGHT AND LICENSE ⚖️

This software is copyright (c) 2017 by Gerda Shank.

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

---

💖 That's the whole page, bestie! Sign-off vibes: source/version perl v5.34.0, date 2022-03-25. Byeee! 🎀