FormBuilderProcessor::saveForm() method

Save the form to the database entry, page, or email(s) per form action settings

Usage

// basic usage
$int = $processor->saveForm(InputfieldForm $form);

// usage with all arguments
$int = $processor->saveForm(InputfieldForm $form, $entry = 0, $submitType = null);

Arguments

Name	Type(s)	Description
`$form`	`InputfieldForm`
`$entry` (optional)	`int` `array`	Optional id of entry (or entry array), if it already exists, 0 if not
`$submitType` (optional)	`int` `bool`	Submit type Default:null, which makes it ask from getSubmitType( method in this class)

Return value

int

ID of inserted entry (if saving to entries database) or boolean true if not.

Hooking $processor→saveForm(…)

You can add your own hook events that are executed either before or after the $processor->saveForm(…) method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each $processor->saveForm(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('FormBuilderProcessor::saveForm', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FormBuilderProcessor = $event->object;

  // Get values of arguments sent to hook (and optionally modify them)
  $form = $event->arguments(0);
  $entry = $event->arguments(1);
  $submitType = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $form);
  $event->arguments(1, $entry);
  $event->arguments(2, $submitType);
});

Hooking after

The 'after' hooks are called immediately after each $processor->saveForm(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('FormBuilderProcessor::saveForm', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FormBuilderProcessor = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  // Get values of arguments sent to hook (if needed)
  $form = $event->arguments(0);
  $entry = $event->arguments(1);
  $submitType = $event->arguments(2);

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

$processor methods and properties

API reference based on ProcessWire core version 3.0.251