CRM_Core_BAO_CustomOption

class CRM_Core_BAO_CustomOption

Business objects for managing custom data options.

Methods

static CRM_Core_BAO_CustomOption
retrieve(array $params, array $defaults)

Fetch object based on array of properties.

static array
getCustomOption(int $fieldID, bool $inactiveNeeded = FALSE)

Returns all active options ordered by weight for a given field.

static array
getOptionListSelector(array $params)

Wrapper for ajax option selector.

static 
del($optionId)

Delete Option.

static 
updateCustomValues(array $params)

No description

static 
updateValue(int $optionId, string $newValue)

When changing the value of an option this is called to update all corresponding custom data

Details

at line 52
static CRM_Core_BAO_CustomOption retrieve(array $params, array $defaults)

Fetch object based on array of properties.

Parameters

array $params (reference ) an assoc array of name/value pairs.
array $defaults (reference ) an assoc array to hold the flattened values.

Return Value

CRM_Core_BAO_CustomOption

at line 73
static array getCustomOption(int $fieldID, bool $inactiveNeeded = FALSE)

Returns all active options ordered by weight for a given field.

Parameters

int $fieldID Field whose options are needed.
bool $inactiveNeeded Do we need inactive options ?. Do we need inactive options ?.

Return Value

array all active options for fieldId

at line 105
static array getOptionListSelector(array $params)

Wrapper for ajax option selector.

Parameters

array $params Associated array for params record id.

Return Value

array associated array of option list -rp = rowcount -page= offset

at line 202
static del($optionId)

Delete Option.

Parameters

$optionId integer option id

at line 246
static updateCustomValues(array $params)

Parameters

array $params

Exceptions

Exception

at line 320
static updateValue(int $optionId, string $newValue)

When changing the value of an option this is called to update all corresponding custom data

Parameters

int $optionId
string $newValue