SelectableOptionManager::setOptions()

Set current options for $field, identify and acting on added, deleted, updated options

Usage

// basic usage
$array = $selectableOptionManager->setOptions(Field $field, $options);

// usage with all arguments
$array = $selectableOptionManager->setOptions(Field $field, $options, bool $allowDelete = true);

Arguments

NameType(s)Description
$fieldField
$optionsarray SelectableOptionArray

Array of SelectableOption objects For new options specify 0 for the 'id' property.

$allowDelete (optional)bool

Allow options to be deleted? If false, the options marked for deletion can be retrieved via $this->getRemovedOptions($field);

Return value

array

containing ('added' => cnt, 'updated' => cnt, 'deleted' => cnt, 'marked' => cnt) note: 'marked' means marked for deletion

Exceptions

Method can throw exceptions on error:

  • WireException


SelectableOptionManager methods and properties

API reference based on ProcessWire core version 3.0.251