FormBuilderPartialEntries::save()

Save a submitted pagination to a partial entry

Usage

// basic usage
$bool = $formBuilderPartialEntries->save(InputfieldForm $form);

// usage with all arguments
$bool = $formBuilderPartialEntries->save(InputfieldForm $form, array $data = [], bool $finish = false);

Arguments

NameType(s)Description
$formInputfieldForm
$data (optional)array

Entry data if already known, or omit to pull from form automatically

$finish (optional)bool

Submission of final pagination?

Return value

bool array

Returns full entry data or boolean false on fail


Hooking FormBuilderPartialEntries::save(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

The 'after' hooks are called immediately after each FormBuilderPartialEntries::save(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('FormBuilderPartialEntries::save', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FormBuilderPartialEntries = $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);
  $data = $event->arguments(1);
  $finish = $event->arguments(2);

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

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

FormBuilderPartialEntries methods and properties

API reference based on ProcessWire core version 3.0.257