Jump to content
pwFoo

Module: FormHelper

Recommended Posts

FormHelper

The redesigned FormHelper extends the InputfieldForm object with additional features. 

Features

The FormHelper module extends the PW form object and simplifies the form handling.

  • create basic PW form object with submit button
  • add form field value handling and sanitizing
  • take care about form submit / error state and processing
  • CKEditor pwImagePlugin field, jsConfig, load form admin styles

FormHelperExtra is a submodule to handle additional features.

  • create a form object with fields based on Template, Page, Form objects or field data array
  • form file upload handling (temp page uploads, creation of a hidden storage page)

Usage

Repository

 

ToDo / Issues

Edited by pwFoo
  • Like 9

Share this post


Link to post
Share on other sites

I'll release some simple example / unstable dev modules which use FormHelper (login, register, profile, edit & add content)...

  • Like 2

Share this post


Link to post
Share on other sites

Can't wait to try your modules out. This looks very promising for community related stuff.

Share this post


Link to post
Share on other sites

My goal is to build a community site with a integrated forum. ;)

It's a "small" (the community, not to write the modules *g*) hobby project.

Share this post


Link to post
Share on other sites

Module updated to 0.0.5

Changed formProcess return values. Example at initial post is updated.

if ($process === NULL) {
     // form not sent
}
elseif ($process == true) {
     // form sent... without or also with errors! Check with "$fh->form->getErrors()"    
}
elseif ($process && $fh->form->getErrors()) {
     // form sent, but with errors!
}
elseif ($process && !$fh->form->getErrors()) {
    // form sent without errors! 
    // Do something...    
}

Because I need to return TRUE if form is sent without and also with errors...

Share this post


Link to post
Share on other sites

Thanks for answer.

At the moment I do some tests with FormHelper and FrontendContentManager (rewritten yesterday).

Bug reports or suggestions are welcome :)

Share this post


Link to post
Share on other sites

Module need some improvements to work with inputtype (ckeditor, tinymce) and textformatters (TextformatterTextile, ...).

In a earlier version it loads ckeditor or tinymce. But not tested with textformatters which need to load the textformatter module and call formatValue() method I think...

Share this post


Link to post
Share on other sites

To handle textformatter I'll add an option to get the fields or some fields unformatted if needed (maybe difficult to decide...).

At the moment I use $pageObj->getInputfields() to get all fields. Maybe should be changed to a loop through all fields to get it formatted or unformatted

// unformatted, for example to get textile source for edit instead of parsed html code
$pageObj->getUnformatted("field");
// or formatted
$field->getInputfield($pageObj); 

Haven't found an way to "convert" a formatted field to an unformatted.

Share this post


Link to post
Share on other sites

You can't convert a formatted field to a unformatted. 

$page->of(false)  // turn off outputformatting
$page->body // unformatted
$page->of(true) // turn outputformatting on
$page->body // formatted

or directly as you already have

$page->getUnformatted("body");

Share this post


Link to post
Share on other sites

Updated version with improved clearValues and added unformattedFields (true = all || array with field names) option.

The unformattedFields option is needed by FrontendContentManager for editing pages with textformatter active fields (for example TextformatterTextile).

Share this post


Link to post
Share on other sites

New FormHelper dev branch 0.0.7

  • removed hardcoded allowed file extensions (forgotten test string...)
  • changed jsconfig handling (now js-code is prepended to $config->scripts

I thinking about a honeypot feature to make forms (more) "secure" against bots...

What do you think? Would it be a good idea?

  • Like 1

Share this post


Link to post
Share on other sites

This looks promising. So basically this will allow us to easily create front-end forms for editing content, posting content etc? I'm looking for something that will allow me to use my own markup on the front-end for my members to use.

Honeypot seems a good idea as an option as Ryan suggests with his comments field.

Will this work with a Fancybox modal window? I'd like to be able to click on an edit button on a front-end page, have a form pop up via something like Fancybox or Foundation and then for it to process the form and redirect to a page of my choice etc.

Share this post


Link to post
Share on other sites

Hi GuruMeditation,

haven't tested it inside a modal yet. But I think it should be work / possible.

FormHelper is needed by my FrontendContentManager (frontend edit / add pages ;) ).

But both modules are work in progress and (I think) unstable!

Share this post


Link to post
Share on other sites

FormHelper care about form handling (build form, process input, upload files,...).

FrontendContendManaget (FCM) requires FormHelper to create a form based on an existing page or template and provide update / save methode.

My login and register modules also based on FormHelper and create the form from array data.

Share this post


Link to post
Share on other sites

I try to simplify FormHelper to not duplicate simple form api features (add, remove and modify form fields via form object). FormHelper should help to create fields based on a data array, handle file upload and also sanitizing form values.

So I remove some features (move field, ...) could easily done by form api.

Share this post


Link to post
Share on other sites

Initial post updated after release FormHelper 0.1.0.

Many changes done and so it's not compatible to earlier versions!

  • create form from page, template or array data
  • Added possibility to update form fields (values, attributes) and field options (skip, unformatted, value, sanitizer) before render()

    -> "skip" a field have to be added by options() method before(!) createForm()

    -> use "value" to overwrite or clear the field value

    -> "unformatted" prefill the form with the unformatted page field value

    -> "sanitizer" defines the sanitizer to use. If isn't set You'll get the raw value!

  • get field values sanitized if a sanitizer is set via value() method
  • It's possible to chain createForm(), add(), update(), options() and render(), but this could be removed in future versions again...
  • ckeditor regular and inline mode (requires JqueryCore and JqueryUI modules!)
  • file / image upload / delete

Example login from with modified submit button

$formSubmit = array('vars' => array('name' => 'submit'), 'attr' => array('value' => 'Login'));
$formFields = array(
    'username' => array(
        'module'    => 'InputfieldText',
        'options'   => array('sanitizer' => 'username'),    // possible options are sanitizer, value, skip and unformatted
        'vars'      => array('name' => 'username', 'label' => 'Username', 'required' => true),
        'attr'      => array('id+name' => 'username'),
    ),
    'password' => array(
        'module'    => 'InputfieldText',
        'options'   => array('value' => ''),    // set field to empty
        'vars'      => array('name' => 'password', 'label' => 'Password', 'required' => true, 'type' => 'password'),
        'attr'      => array('id+name' => 'password', 'type' => 'password'),
    ),
);
$fh->createForm($this->formFields);
$fh->update('submit', $this->formSubmit);
New method value() to get sanitized values
    // get sanitized field value if a sanitizer is set via field options
    $sanitizedUsername = $fh->value('username');
    
    // get raw value without sanitized (skip sanitizer is set!)
    $rawUsername = $fh->value('username', false);

Share this post


Link to post
Share on other sites

Thinking about getField($fieldname) and getForm() instead of public Form variable...

Maybe the next small update...

Share this post


Link to post
Share on other sites

Version 0.3.0 released with bug fixes and improvements.

I try to get closer to a final release...

Added 

  • getForm()
  • getField($fieldname)
  • getInput()

and changed class variables to protected.

ToDo:

  • file handling if form was send with form errors (file changes won't saved during next try...)

Ideas, feedback and also pull requests are welcome ;)

Share this post


Link to post
Share on other sites

Version 0.3.2

  • changed formProcess() return values to simply true, false or null (get input values via getInput() instead)
  • Bug fix with getField() variable name

Share this post


Link to post
Share on other sites

After some reading about honeypot I tested simple implementations. It should be quite simple.

Define the fields

        $this->honeypot['text'] = array(
            'module'    => 'InputfieldText',
            'options'   => array('sanitizer' => 'text', 'value' => 'http://'),
            'vars'      => array('name' => 'hp_website', 'label' => __('Do not change if you\'re human!')),
            'attr'      => array ('id+name' => 'hp_website', 'value' => 'http://'),
        );
        $this->honeypot['checkbox'] = array(
            'module'    => 'InputfieldCheckbox',
            'options'   => array('sanitizer' => 'text', 'value' => ''),
            'vars'      => array('name' => 'hp_sendmail', 'label' => __('Do not check if you\'re human!')),
            'attr'      => array ('id+name' => 'hp_sendmail', 'value' => ''),
        );

Add the fields to the form (for testing added to createForm before adding the submit button).

$this->add($this->honeypot['text']);
$this->add($this->honeypot['checkbox']);

And check the values during processForm method.

        if ($this->value('hp_website') != 'http://') {
            $honeypot = $this->getField('hp_website');
            $honeypot->error(__('Value was changed! Are you a spam bot?!'));
        }
        if ($this->value('hp_sendmail') == 1) {
            $honeypot = $this->getField('hp_sendmail');
            $honeypot->error(__('Value was changed! Are you a spam bot?!'));
        }

So if the text field modified or the checkbox was checked, you'll get an error and form process stops.

Last step is to add css / js to hide the form fields to human visitors.

What do you think about a honeypot feature? Should it be added to FormHelper module? Which fields (website or better email?) or types of honeypot should be added?

Share this post


Link to post
Share on other sites

I rewrite FormHelper to use the native array support of form api and noticed that form based on a template won't work with newer PW dev version. I get an error message from PagefilesManager.

Fatal error: Exception: New page '/pw//' must be saved before files can be accessed from it (in /volume1/web/pw/wire/core/PagefilesManager.php line 260) #0 /volume1/web/pw/wire/core/PagefilesManager.php(251): PagefilesManager->___path() #1 /volume1/web/pw/wire/core/PagefilesManager.php(211): PagefilesManager->path() #2 /volume1/web/pw/wire/core/PagefilesManager.php(67): PagefilesManager->createPath() #3 /volume1/web/pw/wire/core/PagefilesManager.php(55): PagefilesManager->init(Object(Page)) #4 /volume1/web/pw/wire/core/Page.php(1752): PagefilesManager->__construct(Object(Page)) #5 /volume1/web/pw/wire/core/Pagefiles.php(74): Page->filesManager() #6 /volume1/web/pw/wire/core/Pagefiles.php(58): Pagefiles->setPage(Object(Page)) #7 /volume1/web/pw/wire/modules/Fieldtype/FieldtypeImage.module(33): Pagefiles->__construct(Object(Page)) #8 /volume1/web/pw/wire/core/Fieldtype.php(390): FieldtypeImage->getBlankValue(Object(Page), Object(Field)) #9 /volume1/web/pw/wire/core/Page.php(817): Fieldtype->getDefaultValue(Object(Page), Ob in /volume1/web/pw/index.php on line 243
Error: Exception: New page '/pw//' must be saved before files can be accessed from it (in /volume1/web/pw/wire/core/PagefilesManager.php line 260)

#0 /volume1/web/pw/wire/core/PagefilesManager.php(251): PagefilesManager->___path()
#1 /volume1/web/pw/wire/core/PagefilesManager.php(211): PagefilesManager->path()
#2 /volume1/web/pw/wire/core/PagefilesManager.php(67): PagefilesManager->createPath()
#3 /volume1/web/pw/wire/core/PagefilesManager.php(55): PagefilesManager->init(Object(Page))
#4 /volume1/web/pw/wire/core/Page.php(1752): PagefilesManager->__construct(Object(Page))
#5 /volume1/web/pw/wire/core/Pagefiles.php(74): Page->filesManager()
#6 /volume1/web/pw/wire/core/Pagefiles.php(58): Pagefiles->setPage(Object(Page))
#7 /volume1/web/pw/wire/modules/Fieldtype/FieldtypeImage.module(33): Pagefiles->__construct(Object(Page))
#8 /volume1/web/pw/wire/core/Fieldtype.php(390): FieldtypeImage->getBlankValue(Object(Page), Object(Field))
#9 /volume1/web/pw/wire/core/Page.php(817): Fieldtype->getDefaultValue(Object(Page), Ob
This error message was shown because site is in debug mode ($config->debug = true; in /site/config.php). Error has been logged.

In the past it was possible to work with a "fake Page object" to get a working form and take care about page save later...

        $fakePage = new Page();
        $fakePage->template = $tpl;

So maybe form based on a template won't work and so won't implemented in future versions :(

Or is there a solution to get it working again without an existing page?

I used template based forms to create new pages, but page is saved after form is processed and data is checked...

Share this post


Link to post
Share on other sites

Join the conversation

You can post now and register later. If you have an account, sign in now to post with your account.

Guest
Reply to this topic...

×   Pasted as rich text.   Paste as plain text instead

  Only 75 emoji are allowed.

×   Your link has been automatically embedded.   Display as a link instead

×   Your previous content has been restored.   Clear editor

×   You cannot paste images directly. Upload or insert images from URL.


  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By gebeer
      Although the PW backend is really intuitive, ever so often my clients need some assistance. Be it they are not so tech savvy or they are not working in the backend often.
      For those cases it is nice to make some help videos available to editors. This is what this module does.
      ProcessHelpVideos Module
      A Process module to display help videos for the ProcessWire CMS. It can be used to make help videos (screencasts) available to content editors.
      This module adds a 'Help Videos" section to the ProcessWire backend. The help videos are accessible through an automatically created page in the Admin page tree. You can add your help videos as pages in the page tree. The module adds a hidden page to the page tree that acts as parent page for the help video pages. All necessary fields and templates will be installed automatically. If there are already a CKEditor field and/or a file field for mp4 files installed in the system, the module will use those. Otherwise it will create the necessary fields. Also the necessary templates for the parent help videos page and it's children are created on module install. The module installs a permission process-helpvideos. Every user role that should have access to the help video section, needs this permission. I use the help video approach on quite a few production sites. It is stable so far and well received by site owners/editors. Up until now I installed required fields, templates and pages manually and then added the module. Now I added all this logic to the install method of the module and it should be ready to share.
      The module and further description on how to use it is available on github: https://github.com/gebeer/ProcessHelpVideos
      If you like to give it a try, I am happy to receive your comments/suggestions here.
    • By Robin S
      A module created in response to the topic here:
      Page List Select Multiple Quickly
      Modifies PageListSelectMultiple to allow you to select multiple pages without the tree closing every time you select a page.
      The screencast says it all:

       
      https://github.com/Toutouwai/PageListSelectMultipleQuickly
      https://modules.processwire.com/modules/page-list-select-multiple-quickly/
    • By gebeer
      Hello all,
      sharing my new module FieldtypeImagePicker. It provides a configurable input field for choosing any type of image from a predefined folder.
      The need for it came up because a client had a custom SVG icon set and I wanted the editors to be able to choose an icon in the page editor.
      It can also be used to offer a choice of images that are used site-wide without having to upload them to individual pages.
      There are no image manipulation methods like with the native PW image field.
      Module and full description can be found on github https://github.com/gebeer/FieldtypeImagePicker
      Kudos to @Martijn Geerts. I used his module FieldTypeSelectFile as a base to build upon.
      Here's how the input field looks like in the page editor:

      Hope it can be of use to someone.
      If you like to give it a try, I'm happy to hear your comments or suggestions for improvement. Eventually this will go in the module directory soon, too.
    • By bernhard
      @Sergio asked about the pdf creation process in the showcase thread about my 360° feedback/survey tool and so I went ahead and set my little pdf helper module to public.
      Description from PW Weekly:
       
      Modules Directory: https://modules.processwire.com/modules/rock-pdf/
      Download & Docs: https://github.com/BernhardBaumrock/RockPDF
       
      You can combine it easily with RockReplacer: 
      See also a little showcase of the RockPdf module in this thread:
       
    • By ukyo
      FieldtypeFontIconPicker
      Supported Icon Libraries
      FontAwesome 4.7.0 Uikit 3.0.34 IonicIcons 2.0.1 Cahangelog
      NOTE: Module store data without prefix, you need to add "prefix" when you want to show your icon on front-end, because some of front-end frameworks using font-awesome with different "prefix".
      Module will search site/modules/**/configs/IconPicker.*.php and site/templates/IconPicker.*.php paths for FieldtypeFontIconPicker config files.
      All config files need to return a PHP ARRAY like examples.
      Example config file : create your own icon set.
      File location is site/configs/IconPicker.example.php
      <?php namespace ProcessWire; /** * IconPicker : Custom Icons */ return [ "name" => "my-custom-icons", "title" => "My Custom Icon Set", "version" => "1.0.0", "styles" => array( wire("config")->urls->templates . "dist/css/my-custom-icons.css" ), "scripts" => array( wire("config")->urls->templates . "dist/js/my-custom-icons.js" ), "categorized" => true, "attributes" => array(), "icons" => array( "brand-icons" => array( "title" => "Brand Icons", "icons" => array( "google", "facebook", "twitter", "instagram" ) ), "flag-icons" => array( "title" => "Flag Icons", "icons" => array( "tr", "gb", "us", "it", "de", "nl", "fr" ) ) ) ]; Example config file : use existing and extend it.
      File location is site/configs/IconPicker.altivebir.php
      <?php namespace ProcessWire; /** * IconPicker : Existing & Extend */ $resource = include wire("config")->paths->siteModules . "FieldtypeFontIconPicker/configs/IconPicker.uikit.php"; $url = wire("config")->urls->templates . "dist"; $resource["scripts"] = array_merge($resource["scripts"], ["{$url}/js/Altivebir.Icon.min.js"]); $resource["icons"]["flag-icons"] = [ "title" => "Flag Icons", "icons" => array("tr", "en", "fr", "us", "it", "de") ]; $resource["icons"]["brand-icons"]["icons"] = array_merge($resource["icons"]["brand-icons"]["icons"], array( "altivebir" )); return $resource; After you add your custom config file, you will see your config file on library select box. Library Title (Location Folder Name).

      If your library categorized and if you have categorized icons set like uikit and fontawesome libraries, you will have category limitation options per icon field or leave it empty for allow all categories (default).

      Example : output
      if ($icon = $page->get("iconField")) { echo "<i class='prefix-{$icon}' />"; } MarkupFontIconPicker Usage
      // MarkupFontIconPicker::render(YourIconField=string, Options=array) echo MarkupFontIconPicker::render($page->YourIconField, [ 'prefix' => 'uk-icon-', // Icon class prefix, if you have different prefix, default is : "fa fa-" 'tag' => 'span', // Icon tag default is : "i" 'class' => 'fa-lg', // If you have extra cutom classes, for example : icons sizes, Array or Sting value 'style' => 'your custom styles if you have' // Array or String Value ]); Theme support

      Search support

      Category support

       
×
×
  • Create New...