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

Thanks. So to be flexible I'll loop through all fields and get as needed.

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

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Recently Browsing   0 members

    No registered users viewing this page.

  • Similar Content

    • By d'Hinnisdaël
      Happy new year, everybody 🥬
      I've been sitting on this Dashboard module I made for a client and finally came around to cleaning it up and releasing it to the wider public. This is how it looks.
      ProcessWire Dashboard

      If anyone is interested in trying this out, please go ahead! I'd love to get some feedback on it. If this proves useful and survives some real-world testing, I'll add this to the module directory.
      Download
      You can find the latest release on Github.
      Documentation
      Check out the documentation to get started. This is where you'll find information about included panel types and configuration options.
      Custom Panels
      My goal was to make it really simple to create custom panels. The easiest way to do that is to use the panel type template and have it render a file in your templates folder. This might be enough for 80% of all use cases. For anything more complex (FormBuilder submissions? Comments? Live chat?), you can add new panel types by creating modules that extend the DashboardPanel base class. Check out the documentation on custom panels or take a look at the HelloWorld panel to get started. I'm happy to merge any user-created modules into the main repo if they might be useful to more than a few people.
       Disclaimer
      This is a pre-release version. Please treat it as such — don't install it on production sites. Just making sure 🍇
      Roadmap
      These are the things I'm looking to implement myself at some point. The wishlist is a lot longer, but those are the 80/20 items that I probably won't regret spending time on.
      Improve documentation & add examples ⚙️ Panel types Google Analytics ⚙️ Add new page  🔥 Drafts 🔥 At a glance / Page counter 404s  Layout options Render multiple tabs per panel panel groups with heading and spacing between ✅ panel wrappers as grid item (e.g. stacked notices) ✅ Admin themes support AdminThemeReno and AdminThemeDefault ✅ Shortcuts panel add a table layout with icon, title & summary ✅ Chart panel add default styles for common chart types ✅ load chart data from JS file (currently passed as PHP array) Collection panel support image columns ✅ add buttons: view all & add new ✅
    • By Pip
      Hi everyone!
      I'm trying out the Login/Register module for my site. Noted that the module assigns the newly registered user to login-register role. 
      Once you modify the login-register role's permissions, particularly adding page-edit, the new member role will be set to guest. 
      Thing is I'd like to grant my new users the power to create their own pages. Any advice? 
      Thanks. 
    • By Gadgetto
      SnipWire - Snipcart integration for ProcessWire
      Snipcart is a powerful 3rd party, developer-first HTML/JavaScript shopping cart platform. SnipWire is the missing link between Snipcart and the content management framework ProcessWire.
      With SnipWire, you can quickly turn any ProcessWire site into a Snipcart online shop. The SnipWire plugin helps you to get your store up and running in no time. Detailed knowledge of the Snipcart system is not required.
      SnipWire is free and open source licensed under Mozilla Public License 2.0! A lot of work and effort has gone into development. It would be nice if you could donate an amount to support further development:

      Status update links (inside this thread) for SnipWire development
      2020-07-03 -- SnipWire 0.8.7 (beta) released! Fixes some small bugs and adds an indicator for TEST mode 2020-04-06 -- SnipWire 0.8.6 (beta) released! Adds support for Snipcart subscriptions and also fixes some problems 2020-03-21 -- SnipWire 0.8.5 (beta) released! Improves SnipWires webhooks interface and provides some other fixes and additions 2020-03-03 -- SnipWire 0.8.4 (beta) released! Improves compatibility for Windows based Systems. 2020-03-01 -- SnipWire 0.8.3 (beta) released! The installation and uninstallation process has been heavily revised. 2020-02-08 -- SnipWire 0.8.2 (beta) released! Added a feature to change the cart and catalogue currency by GET, POST or SESSION param 2020-02-03 -- SnipWire 0.8.1 (beta) released! All custom classes moved into their own namespaces. 2020-02-01 -- SnipWire is now available via ProcessWire's module directory! 2020-01-30 -- SnipWire 0.8.0 (beta) first public release! (module just submitted to the PW modules directory) 2020-01-28 -- added Custom Order Fields feature (first SnipWire release version is near!) 2020-01-21 -- Snipcart v3 - when will the new cart system be implemented? 2020-01-19 -- integrated taxes provider finished (+ very flexible shipping taxes handling) 2020-01-14 -- new date range picker, discount editor, order notifiactions, order statuses, and more ... 2019-11-15 -- orders filter, order details, download + resend invoices, refunds 2019-10-18 -- list filters, REST API improvements, new docs platform, and more ... 2019-08-08 -- dashboard interface, currency selector, managing Orders, Customers and Products, Added a WireTabs, refinded caching behavior 2019-06-15 -- taxes provider, shop templates update, multiCURL implementation, and more ... 2019-06-02 -- FieldtypeSnipWireTaxSelector 2019-05-25 -- SnipWire will be free and open source Plugin Key Features
      Fast and simple store setup Full integration of the Snipcart dashboard into the ProcessWire backend (no need to leave the ProcessWire admin area) Browse and manage orders, customers, discounts, abandoned carts, and more Multi currency support Custom order and cart fields Process refunds and send customer notifications from within the ProcessWire backend Process Abandoned Carts + sending messages to customers from within the ProcessWire backend Complete Snipcart webhooks integration (all events are hookable via ProcessWire hooks) Integrated taxes provider (which is more flexible then Snipcart own provider) Useful Links
      SnipWire in PW modules directory SnipWire Docs (please note that the documentation is a work in progress) SnipWire @GitHub (feature requests and suggestions for improvement are welcome - I also accept pull requests) Snipcart Website  

       
      ---- INITIAL POST FROM 2019-05-25 ----
       
    • By Sten
      Hello
      Till now I hacked something with the twig template but it works no more with new PW versions so I look forward to create a module. I am working on a site in multiple languages : French, English, Italian, German, Spanish, Portuguese, Hebrew, Russian. The new posts are entered in any language with a field for language. Till now, I got twig files to get the translations with constants defined for each part of the pages.
      So I'd like to create a module to include theses files added according to the url /fr/en/...
      Have you some observations to do before I begin about the direction to take ?
      Thank you
    • By ukyo
      Mystique Module for ProcessWire CMS/CMF
      Github repo : https://github.com/trk/Mystique
      Mystique module allow you to create dynamic fields and store dynamic fields data on database by using a config file.
      Requirements
      ProcessWire 3.0 or newer PHP 7.0 or newer FieldtypeMystique InputfieldMystique Installation
      Install the module from the modules directory:
      Via Composer:
      composer require trk/mystique Via git clone:
      cd your-processwire-project-folder/ cd site/modules/ git clone https://github.com/trk/Mystique.git Module in live reaction with your Mystique config file
      This mean if you remove a field from your config file, field will be removed from edit screen. As you see on youtube video.
      Using Mystique with your module or use different configs path, autoload need to be true for modules
      Default configs path is site/templates/configs/, and your config file name need to start with Mystique. and need to end with .php extension.
      Adding custom path not supporting anymore !
      // Add your custom path inside your module class`init` function, didn't tested outside public function init() { $path = __DIR__ . DIRECTORY_SEPARATOR . 'configs' . DIRECTORY_SEPARATOR; Mystique::add($path); } Mystique module will search site/modules/**/configs/Mystique.*.php and site/templates/Mystique.*.php paths for Mystique config files.
      All config files need to return a PHP ARRAY like examples.
      Usage almost same with ProcessWire Inputfield Api, only difference is set and showIf usage like on example.
      <?php namespace ProcessWire; /** * Resource : testing-mystique */ return [ 'title' => __('Testing Mystique'), 'fields' => [ 'text_field' => [ 'label' => __('You can use short named types'), 'description' => __('In file showIf working like example'), 'notes' => __('Also you can use $input->set() method'), 'type' => 'text', 'showIf' => [ 'another_text' => "=''" ], 'set' => [ 'showCount' => InputfieldText::showCountChars, 'maxlength' => 255 ], 'attr' => [ 'attr-foo' => 'bar', 'attr-bar' => 'foo' ] ], 'another_text' => [ 'label' => __('Another text field (default type is text)') ] ] ]; Example:
      site/templates/configs/Mystique.seo-fields.php <?php namespace ProcessWire; /** * Resource : seo-fields */ return [ 'title' => __('Seo fields'), 'fields' => [ 'window_title' => [ 'label' => __('Window title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'attr' => [ 'placeholder' => __('Enter a window title') ] ], 'navigation_title' => [ 'label' => __('Navigation title'), 'type' => Mystique::TEXT, // or InputfieldText 'useLanguages' => true, 'showIf' => [ 'window_title' => "!=''" ], 'attr' => [ 'placeholder' => __('Enter a navigation title') ] ], 'description' => [ 'label' => __('Description for search engines'), 'type' => Mystique::TEXTAREA, 'useLanguages' => true ], 'page_tpye' => [ 'label' => __('Type'), 'type' => Mystique::SELECT, 'options' => [ 'basic' => __('Basic page'), 'gallery' => __('Gallery'), 'blog' => __('Blog') ] ], 'show_on_nav' => [ 'label' => __('Display this page on navigation'), 'type' => Mystique::CHECKBOX ] ] ]; Searching data on Mystique field is limited. Because, Mystique saving data to database in json format. When you make search for Mystique field, operator not important. Operator will be changed with %= operator.
      Search example
      $navigationPages = pages()->find('my_mystique_field.show_on_nav=1'); $navigationPages = pages()->find('my_mystique_field.page_tpye=gallery');
×
×
  • Create New...