Documentation

OptionsSpecTrait

Describe what values are allowed to be stored in this field.

Tags
copyright

CiviCRM LLC https://civicrm.org/licensing

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

$optionsCallbackParams

public array<string|int, mixed> $optionsCallbackParams = []

Methods

setOptions()

public setOptions(array<string|int, mixed>|bool $options) : $this
Parameters
$options : array<string|int, mixed>|bool
Return values
$this

setOptionsCallback()

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
$this

setSuffixes()

public setSuffixes(array<string|int, mixed> $suffixes) : $this
Parameters
$suffixes : array<string|int, mixed>
Return values
$this

        
On this page

Search results