Constant.php
CiviCRM APIv3 pseudoconstants
The Constant api is deprecated as of CiviCRM 4.4. Please use the getoptions api action instead.
Table of Contents
Functions
- _civicrm_api3_constant_deprecation() : string
- Declare deprecated api entity.
- civicrm_api3_constant_get() : array<string|int, mixed>
- Get constant values (deprecated).
- _civicrm_api3_constant_get_spec() : mixed
- Adjust metadata for constant get action.
Functions
_civicrm_api3_constant_deprecation()
Declare deprecated api entity.
api notice
_civicrm_api3_constant_deprecation() : string
Return values
string —to indicate this entire api entity is deprecated
civicrm_api3_constant_get()
Get constant values (deprecated).
as of CiviCRM 4.4. It's recommended to use the api getoptions action instead
civicrm_api3_constant_get(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Name of a public static method of CRM_Core_PseudoConstant: one of activityStatus activityType addressee allGroup country countryIsoCode county currencyCode currencySymbols customGroup emailGreeting fromEmailAddress gender group groupIterator honor IMProvider individualPrefix individualSuffix locationType locationVcardName mailProtocol mappingTypes paymentProcessor paymentProcessorType pcm phoneType postalGreeting priority relationshipType stateProvince stateProvinceAbbreviation stateProvinceForCountry staticGroup tag tasks ufGroup visibility worldRegion wysiwygEditor
Return values
array<string|int, mixed>_civicrm_api3_constant_get_spec()
Adjust metadata for constant get action.
_civicrm_api3_constant_get_spec(array<string|int, mixed> &$params) : mixed
Parameters
- $params : array<string|int, mixed>