FormBuilderProcessor::processInput() method
Process the input for a submitted form
This protected method is for hooks to monitor and it is likely not intended to be called directly.
Internal usage
$bool = $processor->processInput(int $id, $submitType);
Arguments
Name | Type(s) | Description |
---|---|---|
$id | int | Optional id of entry, if it already exists |
$submitType | int bool | Type of submission (true: final submit, 1=next pagination, -1=previous pagination) |
Return value
bool
int
null
True on final submit success, false on errors preventing save, 0 on paginated submit, null on errors during save
Hooking $processor→processInput(…)
You can add your own hook events that are executed either before or after the $processor->processInput(…)
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->processInput(…)
method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('FormBuilderProcessor::processInput', 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)
$id = $event->arguments(0);
$submitType = $event->arguments(1);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $id);
$event->arguments(1, $submitType);
});
Hooking after
The 'after' hooks are called immediately after each $processor->processInput(…)
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::processInput', 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)
$id = $event->arguments(0);
$submitType = $event->arguments(1);
/* 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