BusinessValue
FinalYes
Table of Contents
Constants
- COMMON_DOMAIN = 'C'
- COMMON_PERSON_ID = 0
- ENTITY_DOMAIN = 'E'
- INDIVIDUAL_DOMAIN = 'I'
- MATCH_ALL = -1
- MATCH_COMMON = 2
- MATCH_DEFAULT = 4
- MATCH_EXACT = 1
Methods
- addConsumer() : mixed
- changeConsumer() : mixed
- changeConsumerKey() : mixed
- delete() : mixed
- get() : mixed
- Get business value.
- getConsumers() : array<string|int, mixed>
- Get all registered consumers.
- getGroups() : mixed
- getMapping() : array<string|int, mixed>
- Get mapping.
- getProviders() : array<string|int, mixed>
- Get all registered providers.
- getValueFromProvider() : mixed
- getValuesByCode() : array<string|int, string>
- install() : mixed
- isSetMapping() : bool
- Check if mapping has been set.
- redefineProviderField() : mixed
- setMapping() : Result
- Set mapping.
- updateMapping() : Result
Constants
COMMON_DOMAIN
public
mixed
COMMON_DOMAIN
= 'C'
COMMON_PERSON_ID
public
mixed
COMMON_PERSON_ID
= 0
ENTITY_DOMAIN
public
mixed
ENTITY_DOMAIN
= 'E'
INDIVIDUAL_DOMAIN
public
mixed
INDIVIDUAL_DOMAIN
= 'I'
MATCH_ALL
public
mixed
MATCH_ALL
= -1
MATCH_COMMON
public
mixed
MATCH_COMMON
= 2
MATCH_DEFAULT
public
mixed
MATCH_DEFAULT
= 4
MATCH_EXACT
public
mixed
MATCH_EXACT
= 1
Methods
addConsumer()
public
static addConsumer(mixed $consumerKey, array<string|int, mixed> $consumer) : mixed
Parameters
- $consumerKey : mixed
- $consumer : array<string|int, mixed>
changeConsumer()
public
static changeConsumer(mixed $consumerKey, array<string|int, mixed> $consumer) : mixed
Parameters
- $consumerKey : mixed
- $consumer : array<string|int, mixed>
changeConsumerKey()
public
static changeConsumerKey(mixed $fromConsumerKey, mixed $toConsumerKey) : mixed
Parameters
- $fromConsumerKey : mixed
- $toConsumerKey : mixed
delete()
public
static delete(mixed $consumerKey[, null $personTypeId = null ]) : mixed
Parameters
- $consumerKey : mixed
- $personTypeId : null = null
Tags
get()
Get business value.
public
static get(string $codeKey[, string|null $consumerKey = null ][, IBusinessValueProvider|string|int|null $personTypeId = null ][, mixed $providerInstance = null ]) : mixed
Parameters
- $codeKey : string
- $consumerKey : string|null = null
- $personTypeId : IBusinessValueProvider|string|int|null = null
- $providerInstance : mixed = null
getConsumers()
Get all registered consumers.
public
static getConsumers() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getGroups()
public
static getGroups() : mixed
getMapping()
Get mapping.
public
static getMapping(string $codeKey[, string|null $consumerKey = null ][, string|int|null $personTypeId = null ][, array<string|int, mixed> $options = array() ]) : array<string|int, mixed>
Parameters
- $codeKey : string
- $consumerKey : string|null = null
- $personTypeId : string|int|null = null
- $options : array<string|int, mixed> = array()
Return values
array<string|int, mixed> —with PROVIDER_KEY and PROVIDER_VALUE if mapping was found, or empty array
getProviders()
Get all registered providers.
public
static getProviders() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed>getValueFromProvider()
public
static getValueFromProvider([IBusinessValueProvider $provider = null ], mixed $codeKey, mixed $consumerKey) : mixed
Parameters
- $provider : IBusinessValueProvider = null
- $codeKey : mixed
- $consumerKey : mixed
getValuesByCode()
public
static getValuesByCode(string $consumerName, string $code) : array<string|int, string>
Parameters
- $consumerName : string
- $code : string
Return values
array<string|int, string>install()
public
static install(mixed $parentName, mixed $translationSource, mixed $data) : mixed
Parameters
- $parentName : mixed
- $translationSource : mixed
- $data : mixed
isSetMapping()
Check if mapping has been set.
public
static isSetMapping(string $codeKey[, string|null $consumerKey = null ][, string|int|null $personTypeId = null ]) : bool
Parameters
- $codeKey : string
- $consumerKey : string|null = null
- $personTypeId : string|int|null = null
Return values
boolredefineProviderField()
public
static redefineProviderField(array<string|int, mixed> $fields) : mixed
Parameters
- $fields : array<string|int, mixed>
setMapping()
Set mapping.
public
static setMapping(string $codeKey, string|null $consumerKey, string|int|null $personTypeId, array<string|int, mixed> $mapping[, bool $withCommon = false ]) : Result
Parameters
- $codeKey : string
- $consumerKey : string|null
- $personTypeId : string|int|null
- $mapping : array<string|int, mixed>
- $withCommon : bool = false
-
internal, do not use!
Tags
Return values
ResultupdateMapping()
public
static updateMapping(mixed $codeKey, array<string|int, mixed> $oldMapping, array<string|int, mixed> $newMapping[, null $consumerKey = null ][, null $personTypeId = null ]) : Result
Parameters
- $codeKey : mixed
- $oldMapping : array<string|int, mixed>
- $newMapping : array<string|int, mixed>
- $consumerKey : null = null
- $personTypeId : null = null