Prep a value for storage
FieldtypeMulti::savePageField expects values as an array, so we convert the $value object to an array
Note that FieldtypeMulti is designed around potentially supporting more than just the 'data' field in the table, so other fieldtypes may want to override this and return an array of associative arrays containing a 'data' field and any other fields that map to the table. i.e. $values[] = array('data' => $data, 'description' => $description), etc. See FieldtypePagefiles module class for an example of this.
Usage
$array = $fieldtypePageTable->sleepValue(Page $page, $field, PageArray $value);Arguments
| Name | Type(s) | Description |
|---|---|---|
page | Page | |
field | Field, PageTableField | |
value | PageArray |
Return value
array
Exceptions
Method can throw exceptions on error:
WireException
Hooking FieldtypePageTable::sleepValue(…)
You can add your own hook events that are executed either before or after the Fieldtype 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 Fieldtype method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.
$this->addHookBefore('FieldtypePageTable::sleepValue', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$FieldtypePageTable = $event->object;
// Get values of arguments sent to hook (and optionally modify them)
$page = $event->arguments(0);
$field = $event->arguments(1);
$value = $event->arguments(2);
/* Your code here, perhaps modifying arguments */
// Populate back arguments (if you have modified them)
$event->arguments(0, $page);
$event->arguments(1, $field);
$event->arguments(2, $value);
}); Hooking after
The 'after' hooks are called immediately after each Fieldtype method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.
$this->addHookAfter('FieldtypePageTable::sleepValue', function(HookEvent $event) {
// Get the object the event occurred on, if needed
$FieldtypePageTable = $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)
$page = $event->arguments(0);
$field = $event->arguments(1);
$value = $event->arguments(2);
/* Your code here, perhaps modifying the return value */
// Populate back return value, if you have modified it
$event->return = $return;
}); See Also
FieldtypePageTable methods and properties
API reference based on ProcessWire core version 3.0.244