FormBuilderProcessor::formToEntry() method

Converts the submitted InputfieldForm object to an entry data array

Called by saveForm()

Usage

// basic usage
$array = $formBuilderProcessor->formToEntry(InputfieldForm $form);

// usage with all arguments
$array = $formBuilderProcessor->formToEntry(InputfieldForm $form, int $id = 0, bool $merge = false);

Arguments

Name	Type(s)	Description
`form`	InputfieldForm
`id` (optional)	int
`merge` (optional)	bool	Merge with any existing entry already loaded?

Return value

array

Hooking FormBuilderProcessor::formToEntry(…)

You can add your own hook events that are executed either before or after the FormBuilderProcessor::formToEntry(…) 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 FormBuilderProcessor::formToEntry(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('FormBuilderProcessor::formToEntry', 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);
  $id = $event->arguments(1);
  $merge = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each FormBuilderProcessor::formToEntry(…) 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::formToEntry', 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);
  $id = $event->arguments(1);
  $merge = $event->arguments(2);

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

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

FormBuilderProcessor methods and properties

API reference based on ProcessWire core version 3.0.236