CRM_Core_PseudoConstant

class CRM_Core_PseudoConstant

Stores all constants and pseudo constants for CRM application.

examples of constants are "Contact Type" which will always be either 'Individual', 'Household', 'Organization'.

pseudo constants are entities from the database whose values rarely change. examples are list of countries, states, location types, relationship types.

currently we're getting the data from the underlying database. this will be reworked to use caching.

Note: All pseudoconstants should be uninitialized or default to NULL. This provides greater consistency/predictability after flushing.

Methods

static array|bool
get(string $daoName, string $fieldName, array $params = [], string $context = NULL)

Low-level option getter, rarely accessed directly.

static bool|null|string
getLabel(string $baoName, string $fieldName, string|int $key)

Fetch the translated label for a field given its key.

static bool|null|string
getName(string $baoName, string $fieldName, string|int $key)

Fetch the machine name for a field given its key.

static bool|null|string|int
getKey(string $baoName, string $fieldName, string|int $value)

Fetch the key for a field option given its name.

static string|null
getOptionEditUrl($fieldSpec)

Lookup the admin page at which a field's option list can be edited

static array
populate(array $var, string $name, bool $all = FALSE, string $retrieve = 'name', string $filter = 'is_active', string $condition = NULL, bool $orderby = NULL, string $key = 'id', bool $force = NULL) deprecated

No description

static 
flush(bool|string $name = 'cache')

Flush given pseudoconstant so it can be reread from db.

static array
activityType() deprecated

No description

static array
stateProvince(bool|int $id = FALSE, bool $limit = TRUE)

Get all the State/Province from database.

static array
stateProvinceAbbreviation(bool|int $id = FALSE, bool $limit = TRUE)

Get all the State/Province abbreviations from the database.

static array
stateProvinceAbbreviationForCountry(int $countryID)

Get all the State/Province abbreviations from the database for the specified country.

static array
stateProvinceAbbreviationForDefaultCountry()

Get all the State/Province abbreviations from the database for the default country.

static array|null
country(bool|int $id = FALSE, bool $applyLimit = TRUE)

Get all the countries from database.

static array
countryIsoCode(bool $id = FALSE)

Get all the country ISO Code abbreviations from the database.

static array
allGroup(string $groupType = NULL, bool $excludeHidden = TRUE) deprecated

No description

static array
group(string $groupType = NULL, bool $excludeHidden = TRUE)

Get all permissioned groups from database.

static array
nestedGroup(bool $checkPermissions = TRUE, string|null $groupType = NULL, bool $excludeHidden = TRUE)

Fetch groups in a nested format suitable for use in select form element.

static array
staticGroup(bool $onlyPublic = FALSE, null $groupType = NULL, bool $excludeHidden = TRUE)

Get all permissioned groups from database.

static array
relationshipType(string $valueColumnName = 'label', bool $reset = FALSE, bool $isActive = 1)

Get all Relationship Types from database.

static array
currencyCode()

Get all the ISO 4217 currency codes

static array
county(bool|int $id = FALSE)

Get all the County from database.

static array
paymentProcessor(bool $all = FALSE, bool $test = FALSE, null $additionalCond = NULL) deprecated

No description

static array
paymentProcessorType(bool $all = FALSE, int $id = NULL, string $return = 'title') deprecated

No description

static array
worldRegion(bool $id = FALSE)

Get all the World Regions from Database.

static array
activityStatus(string $column = 'label') deprecated

No description

static array
visibility(string $column = 'label') deprecated

No description

static array
stateProvinceForCountry(int $countryID, string $field = 'name')

No description

static array
countyForState(int $stateID)

No description

static int|null
countryIDForStateID(int $stateID)

Given a state ID return the country ID, this allows us to populate forms and values for downstream code

static array
greeting($filter, string $columnName = 'label')

Get all types of Greetings.

static array
getExtensions()

Get all extensions.

static array
accountOptionValues(bool $optionGroupName, int $id = NULL, null $condition = NULL)

Get all options values.

static array
getModuleExtensions(bool $fresh = FALSE)

Fetch the list of active extensions of type 'module'

static array
getTaxRates()

Get all tax rates.

static array
emailOnHoldOptions()

Get participant status class options.

Details

at line 198
static array|bool get(string $daoName, string $fieldName, array $params = [], string $context = NULL)

Low-level option getter, rarely accessed directly.

NOTE: Rather than calling this function directly use CRM__BAO_::buildOptions()

Parameters

string $daoName
string $fieldName
array $params
  • name string name of the option group
  • flip boolean results are return in id => label format if false if true, the results are reversed
  • grouping boolean if true, return the value in 'grouping' column (currently unsupported for tables other than option_value)
  • localize boolean if true, localize the results before returning
  • condition string|array add condition(s) to the sql query - will be concatenated using 'AND'
  • keyColumn string the column to use for 'id'
  • labelColumn string the column to use for 'label'
  • orderColumn string the column to use for sorting, defaults to 'weight' column if one exists, else defaults to labelColumn
  • onlyActive boolean return only the action option values
  • fresh boolean ignore cache entries and go back to DB
string $context : Context string

Return Value

array|bool array on success, FALSE on error.

See also

https://docs.civicrm.org/dev/en/latest/framework/pseudoconstant/ NOTE: If someone undertakes a refactoring of this, please consider the use-case of the Setting.getoptions API. There is no DAO/field, but it would be nice to use the same 'pseudoconstant' struct in *.settings.php. This means loosening the coupling between $field lookup and the $pseudoconstant evaluation.
CRM_Core_DAO::buildOptionsContext

at line 411
static bool|null|string getLabel(string $baoName, string $fieldName, string|int $key)

Fetch the translated label for a field given its key.

Parameters

string $baoName
string $fieldName
string|int $key TODO: Accept multivalued input?

Return Value

bool|null|string FALSE if the given field has no associated option list NULL if the given key has no corresponding option String if label is found

at line 431
static bool|null|string getName(string $baoName, string $fieldName, string|int $key)

Fetch the machine name for a field given its key.

Parameters

string $baoName
string $fieldName
string|int $key

Return Value

bool|null|string FALSE if the given field has no associated option list NULL if the given key has no corresponding option String if label is found

at line 451
static bool|null|string|int getKey(string $baoName, string $fieldName, string|int $value)

Fetch the key for a field option given its name.

Parameters

string $baoName
string $fieldName
string|int $value

Return Value

bool|null|string|int FALSE if the given field has no associated option list NULL if the given key has no corresponding option String|Number if key is found

at line 464
static string|null getOptionEditUrl($fieldSpec)

Lookup the admin page at which a field's option list can be edited

Parameters

$fieldSpec

Return Value

string|null

at line 514
static array populate(array $var, string $name, bool $all = FALSE, string $retrieve = 'name', string $filter = 'is_active', string $condition = NULL, bool $orderby = NULL, string $key = 'id', bool $force = NULL) deprecated

deprecated generic populate method. All pseudoconstant functions that use this method are also @deprecated The static array $var is populated from the db using the $name DAO. Note: any database errors will be trapped by the DAO.

Parameters

array $var The associative array we will fill.
string $name The name of the DAO.
bool $all Get all objects. default is to get only active ones.
string $retrieve The field that we are interested in (normally name, differs in some objects).
string $filter The field that we want to filter the result set with.
string $condition The condition that gets passed to the final query as the WHERE clause.
bool $orderby
string $key
bool $force

Return Value

array

at line 571
static flush(bool|string $name = 'cache')

Flush given pseudoconstant so it can be reread from db.

nex time it's requested.

Parameters

bool|string $name pseudoconstant to be flushed

at line 594
static array activityType() deprecated

deprecated Please use the buildOptions() method in the appropriate BAO object. Get all Activty types. The static array activityType is returned

Return Value

array array reference of all activity types.

at line 672
static array stateProvince(bool|int $id = FALSE, bool $limit = TRUE)

Get all the State/Province from database.

The static array stateProvince is returned, and if it's called the first time, the State Province DAO is used to get all the States.

Note: any database errors will be trapped by the DAO.

Parameters

bool|int $id
  • Optional id to return
bool $limit

Return Value

array array reference of all State/Provinces.

at line 726
static array stateProvinceAbbreviation(bool|int $id = FALSE, bool $limit = TRUE)

Get all the State/Province abbreviations from the database.

Same as above, except gets the abbreviations instead of the names.

Parameters

bool|int $id
  • Optional id to return
bool $limit

Return Value

array array reference of all State/Province abbreviations.

at line 774
static array stateProvinceAbbreviationForCountry(int $countryID)

Get all the State/Province abbreviations from the database for the specified country.

Parameters

int $countryID

Return Value

array array of all State/Province abbreviations for the given country.

at line 788
static array stateProvinceAbbreviationForDefaultCountry()

Get all the State/Province abbreviations from the database for the default country.

Return Value

array array of all State/Province abbreviations for the given country.

at line 809
static array|null country(bool|int $id = FALSE, bool $applyLimit = TRUE)

Get all the countries from database.

The static array country is returned, and if it's called the first time, the Country DAO is used to get all the countries.

Note: any database errors will be trapped by the DAO.

Parameters

bool|int $id
  • Optional id to return
bool $applyLimit

Return Value

array|null array reference of all countries.

at line 884
static array countryIsoCode(bool $id = FALSE)

Get all the country ISO Code abbreviations from the database.

The static array countryIsoCode is returned, and if it's called the first time, the Country DAO is used to get all the countries' ISO codes.

Note: any database errors will be trapped by the DAO.

Parameters

bool $id

Return Value

array array reference of all country ISO codes.

at line 919
static array allGroup(string $groupType = NULL, bool $excludeHidden = TRUE) deprecated

deprecated Please use the buildOptions() method in the appropriate BAO object. Get all groups from database The static array group is returned, and if it's called the first time, the Group DAO is used to get all the groups. Note: any database errors will be trapped by the DAO.

Parameters

string $groupType Type of group(Access/Mailing).
bool $excludeHidden Exclude hidden groups.

Return Value

array array reference of all groups.

at line 952
static array group(string $groupType = NULL, bool $excludeHidden = TRUE)

Get all permissioned groups from database.

The static array group is returned, and if it's called the first time, the Group DAO is used to get all the groups.

Note: any database errors will be trapped by the DAO.

Parameters

string $groupType Type of group(Access/Mailing).
bool $excludeHidden Exclude hidden groups.

Return Value

array array reference of all groups.

at line 963
static array nestedGroup(bool $checkPermissions = TRUE, string|null $groupType = NULL, bool $excludeHidden = TRUE)

Fetch groups in a nested format suitable for use in select form element.

Parameters

bool $checkPermissions
string|null $groupType
bool $excludeHidden

Return Value

array

at line 985
static array staticGroup(bool $onlyPublic = FALSE, null $groupType = NULL, bool $excludeHidden = TRUE)

Get all permissioned groups from database.

The static array group is returned, and if it's called the first time, the Group DAO is used to get all the groups.

Note: any database errors will be trapped by the DAO.

Parameters

bool $onlyPublic
null $groupType
bool $excludeHidden

Return Value

array array reference of all groups.

at line 1025
static array relationshipType(string $valueColumnName = 'label', bool $reset = FALSE, bool $isActive = 1)

Get all Relationship Types from database.

The static array group is returned, and if it's called the first time, the RelationshipType DAO is used to get all the relationship types.

Note: any database errors will be trapped by the DAO.

Parameters

string $valueColumnName Db column name/label.
bool $reset Reset relationship types if true.
bool $isActive Filter by is_active. NULL to disable.

Return Value

array array reference of all relationship types.

at line 1067
static array currencyCode()

Get all the ISO 4217 currency codes

so far, we use this for validation only, so there's no point of putting this into the database

Return Value

array array reference of all currency codes

at line 1095
static array county(bool|int $id = FALSE)

Get all the County from database.

The static array county is returned, and if it's called the first time, the County DAO is used to get all the Counties.

Note: any database errors will be trapped by the DAO.

Parameters

bool|int $id
  • Optional id to return

Return Value

array array reference of all Counties

at line 1130
static array paymentProcessor(bool $all = FALSE, bool $test = FALSE, null $additionalCond = NULL) deprecated

deprecated Please use the buildOptions() method in the appropriate BAO object. Get all active payment processors The static array paymentProcessor is returned

Parameters

bool $all Get payment processors - default is to get only active ones.
bool $test Get test payment processors.
null $additionalCond

Return Value

array array of all payment processors

at line 1165
static array paymentProcessorType(bool $all = FALSE, int $id = NULL, string $return = 'title') deprecated

deprecated Please use the buildOptions() method in the appropriate BAO object. The static array paymentProcessorType is returned

Parameters

bool $all Get payment processors - default is to get only active ones.
int $id
string $return

Return Value

array array of all payment processor types

at line 1185
static array worldRegion(bool $id = FALSE)

Get all the World Regions from Database.

Parameters

bool $id

Return Value

array array reference of all World Regions

at line 1215
static array activityStatus(string $column = 'label') deprecated

deprecated Please use the buildOptions() method in the appropriate BAO object. Get all Activity Statuses. The static array activityStatus is returned

Parameters

string $column

Return Value

array array reference of all activity statuses

at line 1241
static array visibility(string $column = 'label') deprecated

deprecated Please use the buildOptions() method in the appropriate BAO object. Get all Visibility levels. The static array visibility is returned

Parameters

string $column

Return Value

array array reference of all Visibility levels.

at line 1259
static array stateProvinceForCountry(int $countryID, string $field = 'name')

Parameters

int $countryID
string $field

Return Value

array

at line 1313
static array countyForState(int $stateID)

Parameters

int $stateID

Return Value

array

at line 1375
static int|null countryIDForStateID(int $stateID)

Given a state ID return the country ID, this allows us to populate forms and values for downstream code

Parameters

int $stateID

Return Value

int|null the country id that the state belongs to

at line 1404
static array greeting($filter, string $columnName = 'label')

Get all types of Greetings.

The static array of greeting is returned

Parameters

$filter Get All Email Greetings - default is to get only active ones.
string $columnName

Return Value

array array reference of all greetings.

at line 1455
static array getExtensions()

Get all extensions.

The static array extensions

FIXME: This is called by civix but not by any core code. We should provide an API call which civix can use instead.

Return Value

array array($fullyQualifiedName => $label) list of extensions

at line 1491
static array accountOptionValues(bool $optionGroupName, int $id = NULL, null $condition = NULL)

Get all options values.

The static array option values is returned

Parameters

bool $optionGroupName Get All Option Group values- default is to get only active ones.
int $id
null $condition

Return Value

array array reference of all Option Group Name

at line 1512
static array getModuleExtensions(bool $fresh = FALSE)

Fetch the list of active extensions of type 'module'

Parameters

bool $fresh Whether to forcibly reload extensions list from canonical store.

Return Value

array array(array('prefix' => $, 'file' => $))

at line 1524
static array getTaxRates()

Get all tax rates.

The static array tax rates is returned

Return Value

array array list of tax rates with the financial type

at line 1568
static array emailOnHoldOptions()

Get participant status class options.

Return Value

array