$fieldgroups->setImportData() method

Given an export data array, import it back to the class and return what happened

Changes are not committed until the item is saved

Usage

$array = $fieldgroups->setImportData(Fieldgroup $fieldgroup, array $data);

Arguments

Name	Type(s)	Description
`fieldgroup`	Fieldgroup
`data`	array

Return value

array

Returns array( [property_name] => array( 'old' => 'old value', // old value, always a string 'new' => 'new value', // new value, always a string 'error' => 'error message or blank if no error' )

Exceptions

Method can throw exceptions on error:

WireException - if given invalid data

Hooking $fieldgroups->setImportData(…)

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

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

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

  /* Your code here, perhaps modifying arguments */

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

Hooking after

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

$this->addHookAfter('Fieldgroups::setImportData', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $fieldgroups = $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)
  $fieldgroup = $event->arguments(0);
  $data = $event->arguments(1);

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

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

$fieldgroups methods and properties

API reference based on ProcessWire core version 3.0.236