OptionsSpecTrait
Describe what values are allowed to be stored in this field.
Tags
Table of Contents
Properties
- $options : array<string|int, mixed>|bool
- $optionsCallback : callable
- $optionsCallbackParams : array<string|int, mixed>
- $suffixes : array<string|int, mixed>|null
Methods
- setOptions() : $this
- setOptionsCallback() : $this
- setSuffixes() : $this
Properties
$options
public
array<string|int, mixed>|bool
$options
$optionsCallback
public
callable
$optionsCallback
$optionsCallbackParams
public
array<string|int, mixed>
$optionsCallbackParams
= []
$suffixes
public
array<string|int, mixed>|null
$suffixes
Methods
setOptions()
public
setOptions(array<string|int, mixed>|bool $options) : $this
Parameters
- $options : array<string|int, mixed>|bool
Return values
$thissetOptionsCallback()
public
setOptionsCallback(callable $callback[, array<string|int, mixed> $params = [] ]) : $this
Parameters
- $callback : callable
-
Function to be called, will receive the following arguments: ($this, $values, $returnFormat, $checkPermissions, $params)
- $params : array<string|int, mixed> = []
-
Array of optional extra data; sent as 5th argument to the callback
Return values
$thissetSuffixes()
public
setSuffixes(array<string|int, mixed> $suffixes) : $this
Parameters
- $suffixes : array<string|int, mixed>