* Class to abstract token replacement.
*/
class CRM_Utils_Token {
- static $_requiredTokens = NULL;
+ public static $_requiredTokens = NULL;
- static $_tokens = array(
- 'action' => array(
+ public static $_tokens = [
+ 'action' => [
'forward',
'optOut',
'optOutUrl',
'resubscribe',
'resubscribeUrl',
'subscribeUrl',
- ),
- 'mailing' => array(
+ ],
+ 'mailing' => [
'id',
'name',
'group',
'approveUrl',
'creator',
'creatorEmail',
- ),
- 'user' => array(
+ ],
+ 'user' => [
// we extract the stuff after the role / permission and return the
// civicrm email addresses of all users with that role / permission
// useful with rules integration
'permission:',
'role:',
- ),
+ ],
// populate this dynamically
'contact' => NULL,
// populate this dynamically
'contribution' => NULL,
- 'domain' => array(
+ 'domain' => [
'name',
'phone',
'address',
'email',
'id',
'description',
- ),
- 'subscribe' => array('group'),
- 'unsubscribe' => array('group'),
- 'resubscribe' => array('group'),
- 'welcome' => array('group'),
- );
-
+ ],
+ 'subscribe' => ['group'],
+ 'unsubscribe' => ['group'],
+ 'resubscribe' => ['group'],
+ 'welcome' => ['group'],
+ ];
/**
* @deprecated
*/
public static function getRequiredTokens() {
if (self::$_requiredTokens == NULL) {
- self::$_requiredTokens = array(
+ self::$_requiredTokens = [
'domain.address' => ts("Domain address - displays your organization's postal address."),
- 'action.optOutUrl or action.unsubscribeUrl' => array(
+ 'action.optOutUrl or action.unsubscribeUrl' => [
'action.optOut' => ts("'Opt out via email' - displays an email address for recipients to opt out of receiving emails from your organization."),
'action.optOutUrl' => ts("'Opt out via web page' - creates a link for recipients to click if they want to opt out of receiving emails from your organization. Alternatively, you can include the 'Opt out via email' token."),
'action.unsubscribe' => ts("'Unsubscribe via email' - displays an email address for recipients to unsubscribe from the specific mailing list used to send this message."),
'action.unsubscribeUrl' => ts("'Unsubscribe via web page' - creates a link for recipients to unsubscribe from the specific mailing list used to send this message. Alternatively, you can include the 'Unsubscribe via email' token or one of the Opt-out tokens."),
- ),
- );
+ ],
+ ];
}
return self::$_requiredTokens;
}
* The message.
*
* @return bool|array
- * true if all required tokens are found,
+ * true if all required tokens are found,
* else an array of the missing tokens
*/
public static function requiredTokens(&$str) {
// FlexMailer is a refactoring of CiviMail which provides new hooks/APIs/docs. If the sysadmin has opted to enable it, then use that instead of CiviMail.
- $requiredTokens = defined('CIVICRM_FLEXMAILER_HACK_REQUIRED_TOKENS') ? Civi\Core\Resolver::singleton()->call(CIVICRM_FLEXMAILER_HACK_REQUIRED_TOKENS, array()) : CRM_Utils_Token::getRequiredTokens();
+ $requiredTokens = defined('CIVICRM_FLEXMAILER_HACK_REQUIRED_TOKENS') ? Civi\Core\Resolver::singleton()->call(CIVICRM_FLEXMAILER_HACK_REQUIRED_TOKENS, []) : CRM_Utils_Token::getRequiredTokens();
- $missing = array();
+ $missing = [];
foreach ($requiredTokens as $token => $value) {
if (!is_array($value)) {
if (!preg_match('/(^|[^\{])' . preg_quote('{' . $token . '}') . '/', $str)) {
* The token variable.
* @param string $value
* The value to substitute for the token.
- * @param string (reference) $str The string to replace in
+ * @param string $str (reference) The string to replace in
*
* @param bool $escapeSmarty
*
*/
public static function tokenEscapeSmarty($string) {
// need to use negative look-behind, as both str_replace() and preg_replace() are sequential
- return preg_replace(array('/{/', '/(?<!{ldelim)}/'), array('{ldelim}', '{rdelim}'), $string);
+ return preg_replace(['/{/', '/(?<!{ldelim)}/'], ['{ldelim}', '{rdelim}'], $string);
}
/**
$value = "{domain.$token}";
}
elseif ($token == 'address') {
- static $addressCache = array();
+ static $addressCache = [];
$cache_key = $html ? 'address-html' : 'address-text';
if (array_key_exists($cache_key, $addressCache)) {
self::$_tokens['org']
= array_merge(
array_keys(CRM_Contact_BAO_Contact::importableFields('Organization')),
- array('address', 'display_name', 'checksum', 'contact_id')
+ ['address', 'display_name', 'checksum', 'contact_id']
);
$cv = NULL;
elseif ($token == 'address') {
// Build the location values array
- $loc = array();
+ $loc = [];
$loc['display_name'] = CRM_Utils_Array::retrieveValueRecursive($org, 'display_name');
$loc['street_address'] = CRM_Utils_Array::retrieveValueRecursive($org, 'street_address');
$loc['city'] = CRM_Utils_Array::retrieveValueRecursive($org, 'city');
break;
case 'group':
- $groups = $mailing ? $mailing->getGroupNames() : array('Mailing Groups');
+ $groups = $mailing ? $mailing->getGroupNames() : ['Mailing Groups'];
$value = implode(', ', $groups);
break;
// in exportable fields so there is no benefit in doing this conditionally.
self::$_tokens['contact'] = array_merge(
array_keys(CRM_Contact_BAO_Contact::exportableFields('All')),
- array('checksum', 'contact_id')
+ ['checksum', 'contact_id']
);
$key = 'contact';
$str
);
- $str = preg_replace('/\\\\|\{(\s*)?\}/', ' ', $str);
+ //$str = preg_replace('/\\\\|\{(\s*)?\}/', ' ', $str); //WHY you do this?
return $str;
}
self::$_tokens['contact']
= array_merge(
array_keys(CRM_Contact_BAO_Contact::exportableFields('All')),
- array('checksum', 'contact_id')
+ ['checksum', 'contact_id']
);
}
* @param $str ref to the string that will be scanned and modified
*/
public static function unescapeTokens(&$str) {
- $str = preg_replace('/\\\\|\{(\{\w+\.\w+\})\}/', '\\1', $str);
+ //$str = preg_replace('/\\\\|\{(\{\w+\.\w+\})\}/', '\\1', $str);
}
/**
* array of tokens mentioned in field
*/
public static function getTokens($string) {
- $matches = array();
- $tokens = array();
+ $matches = [];
+ $tokens = [];
preg_match_all('/(?<!\{|\\\\)\{(\w+\.\w+)\}(?!\})/',
$string,
$matches,
list($type, $name) = preg_split('/\./', $token, 2);
if ($name && $type) {
if (!isset($tokens[$type])) {
- $tokens[$type] = array();
+ $tokens[$type] = [];
}
$tokens[$type][] = $name;
}
* fields to pass in as return properties when populating token
*/
public static function getReturnProperties(&$string) {
- $returnProperties = array();
- $matches = array();
+ $returnProperties = [];
+ $matches = [];
preg_match_all('/(?<!\{|\\\\)\{(\w+\.\w+)\}(?!\})/',
$string,
$matches,
$skipOnHold = TRUE,
$skipDeceased = TRUE,
$extraParams = NULL,
- $tokens = array(),
+ $tokens = [],
$className = NULL,
$jobID = NULL
) {
- $params = array();
+ $params = [];
foreach ($contactIDs as $contactID) {
- $params[] = array(
+ $params[] = [
CRM_Core_Form::CB_PREFIX . $contactID,
'=',
1,
0,
0,
- );
+ ];
}
// fix for CRM-2613
if ($skipDeceased) {
- $params[] = array('is_deceased', '=', 0, 0, 0);
+ $params[] = ['is_deceased', '=', 0, 0, 0];
}
//fix for CRM-3798
if ($skipOnHold) {
- $params[] = array('on_hold', '=', 0, 0, 0);
+ $params[] = ['on_hold', '=', 0, 0, 0];
}
if ($extraParams) {
// if return properties are not passed then get all return properties
if (empty($returnProperties)) {
$fields = array_merge(array_keys(CRM_Contact_BAO_Contact::exportableFields()),
- array('display_name', 'checksum', 'contact_id')
+ ['display_name', 'checksum', 'contact_id']
);
foreach ($fields as $val) {
// The unavailable fields are not available as tokens, do not have a one-2-one relationship
// with contacts and are expensive to resolve.
// @todo see CRM-17253 - there are some other fields (e.g note) that should be excluded
// and upstream calls to this should populate return properties.
- $unavailableFields = array('group', 'tag');
+ $unavailableFields = ['group', 'tag'];
if (!in_array($val, $unavailableFields)) {
$returnProperties[$val] = 1;
}
}
}
- $custom = array();
+ $custom = [];
foreach ($returnProperties as $name => $dontCare) {
$cfID = CRM_Core_BAO_CustomField::getKeyID($name);
if ($cfID) {
if (array_key_exists($contactID, $contactDetails)) {
if (!empty($contactDetails[$contactID]['preferred_communication_method'])
) {
- $communicationPreferences = array();
+ $communicationPreferences = [];
foreach ($contactDetails[$contactID]['preferred_communication_method'] as $val) {
if ($val) {
$communicationPreferences[$val] = CRM_Core_PseudoConstant::getLabel('CRM_Contact_DAO_Contact', 'preferred_communication_method', $val);
}
// special case for greeting replacement
- foreach (array(
- 'email_greeting',
- 'postal_greeting',
- 'addressee',
- ) as $val) {
+ foreach ([
+ 'email_greeting',
+ 'postal_greeting',
+ 'addressee',
+ ] as $val) {
if (!empty($contactDetails[$contactID][$val])) {
$contactDetails[$contactID][$val] = $contactDetails[$contactID]["{$val}_display"];
}
* @return array
* contactDetails with hooks swapped out
*/
- public static function getAnonymousTokenDetails($contactIDs = array(
- 0,
- ),
+ public static function getAnonymousTokenDetails($contactIDs = [
+ 0,
+ ],
$returnProperties = NULL,
$skipOnHold = TRUE,
$skipDeceased = TRUE,
$extraParams = NULL,
- $tokens = array(),
+ $tokens = [],
$className = NULL,
$jobID = NULL) {
- $details = array(0 => array());
+ $details = [0 => []];
// also call a hook and get token details
CRM_Utils_Hook::tokenValues($details[0],
$contactIDs,
* Array of membership IDS.
*/
public static function getMembershipTokenDetails($membershipIDs) {
- $memberships = civicrm_api3('membership', 'get', array(
- 'options' => array('limit' => 0),
- 'membership_id' => array('IN' => (array) $membershipIDs),
- ));
+ $memberships = civicrm_api3('membership', 'get', [
+ 'options' => ['limit' => 0],
+ 'membership_id' => ['IN' => (array) $membershipIDs],
+ ]);
return $memberships['values'];
}
if (!empty($greetingTokens) && array_key_exists('contact', $greetingTokens)) {
$greetingsReturnProperties = array_flip(CRM_Utils_Array::value('contact', $greetingTokens));
$greetingsReturnProperties = array_fill_keys(array_keys($greetingsReturnProperties), 1);
- $contactParams = array('contact_id' => $contactId);
+ $contactParams = ['contact_id' => $contactId];
$greetingDetails = self::getTokenDetails($contactParams,
$greetingsReturnProperties,
// Fill the return properties array
$greetingTokens = $remainingTokens;
reset($greetingTokens);
- $greetingsReturnProperties = array();
+ $greetingsReturnProperties = [];
foreach ($greetingTokens as $value) {
$props = array_flip($value);
$props = array_fill_keys(array_keys($props), 1);
$greetingsReturnProperties = $greetingsReturnProperties + $props;
}
- $contactParams = array('contact_id' => $contactId);
+ $contactParams = ['contact_id' => $contactId];
$greetingDetails = self::getTokenDetails($contactParams,
$greetingsReturnProperties,
FALSE, FALSE, NULL,
*
* @param string $tokenString
* @param array $contactDetails
+ * @param array $greetingTokens
*/
private static function removeNullContactTokens(&$tokenString, $contactDetails, &$greetingTokens) {
+
+ // Only applies to contact tokens
+ if (!array_key_exists('contact', $greetingTokens)) {
+ return;
+ }
+
$greetingTokensOriginal = $greetingTokens;
$contactFieldList = CRM_Contact_DAO_Contact::fields();
// Sometimes contactDetails are in a multidemensional array, sometimes a
* @return array
*/
public static function flattenTokens(&$tokens) {
- $flattenTokens = array();
+ $flattenTokens = [];
- foreach (array(
- 'html',
- 'text',
- 'subject',
- ) as $prop) {
+ foreach ([
+ 'html',
+ 'text',
+ 'subject',
+ ] as $prop) {
if (!isset($tokens[$prop])) {
continue;
}
foreach ($tokens[$prop] as $type => $names) {
if (!isset($flattenTokens[$type])) {
- $flattenTokens[$type] = array();
+ $flattenTokens[$type] = [];
}
foreach ($names as $name) {
$flattenTokens[$type][$name] = 1;
$key = 'contribution';
if (self::$_tokens[$key] == NULL) {
self::$_tokens[$key] = array_keys(array_merge(CRM_Contribute_BAO_Contribution::exportableFields('All'),
- array('campaign', 'financial_type'),
+ ['campaign', 'financial_type'],
self::getCustomFieldTokens('Contribution')
));
}
protected static function _buildMembershipTokens() {
$key = 'membership';
if (!isset(self::$_tokens[$key]) || self::$_tokens[$key] == NULL) {
- $membershipTokens = array();
+ $membershipTokens = [];
$tokens = CRM_Core_SelectValues::membershipTokens();
foreach ($tokens as $token => $dontCare) {
$membershipTokens[] = substr($token, (strpos($token, '.') + 1), -1);
* @return string
* string with replacements made
*/
- public static function replaceEntityTokens($entity, $entityArray, $str, $knownTokens = array(), $escapeSmarty = FALSE) {
+ public static function replaceEntityTokens($entity, $entityArray, $str, $knownTokens = [], $escapeSmarty = FALSE) {
if (!$knownTokens || empty($knownTokens[$entity])) {
return $str;
}
$fn = 'get' . ucfirst($entity) . 'TokenReplacement';
- $fn = is_callable(array('CRM_Utils_Token', $fn)) ? $fn : 'getApiTokenReplacement';
+ $fn = is_callable(['CRM_Utils_Token', $fn]) ? $fn : 'getApiTokenReplacement';
// since we already know the tokens lets just use them & do str_replace which is faster & simpler than preg_replace
foreach ($knownTokens[$entity] as $token) {
$replacement = self::$fn($entity, $token, $entityArray);
* @return string
* @throws \CiviCRM_API3_Exception
*/
- public static function replaceCaseTokens($caseId, $str, $knownTokens = array(), $escapeSmarty = FALSE) {
+ public static function replaceCaseTokens($caseId, $str, $knownTokens = [], $escapeSmarty = FALSE) {
if (!$knownTokens || empty($knownTokens['case'])) {
return $str;
}
- $case = civicrm_api3('case', 'getsingle', array('id' => $caseId));
+ $case = civicrm_api3('case', 'getsingle', ['id' => $caseId]);
return self::replaceEntityTokens('case', $case, $str, $knownTokens, $escapeSmarty);
}
if (!isset($entityArray[$token])) {
return '';
}
- $field = civicrm_api3($entity, 'getfield', array('action' => 'get', 'name' => $token, 'get_options' => 'get'));
+ $field = civicrm_api3($entity, 'getfield', ['action' => 'get', 'name' => $token, 'get_options' => 'get']);
$field = $field['values'];
$fieldType = CRM_Utils_Array::value('type', $field);
// Boolean fields
if ($fieldType == CRM_Utils_Type::T_BOOLEAN && empty($field['options'])) {
- $field['options'] = array(ts('No'), ts('Yes'));
+ $field['options'] = [ts('No'), ts('Yes')];
}
// Match pseudoconstants
if (!empty($field['options'])) {
- $ret = array();
+ $ret = [];
foreach ((array) $entityArray[$token] as $val) {
$ret[] = $field['options'][$val];
}
public static function replaceContributionTokens($str, &$contribution, $html = FALSE, $knownTokens = NULL, $escapeSmarty = FALSE) {
$key = 'contribution';
if (!$knownTokens || !CRM_Utils_Array::value($key, $knownTokens)) {
- return $str; //early return
+ //early return
+ return $str;
}
self::_buildContributionTokens();
}
if (in_array('receive_date', $knownTokens['contribution'])) {
- $formattedDates = array();
+ $formattedDates = [];
$dates = explode($separator, $contribution['receive_date']);
foreach ($dates as $date) {
- $formattedDates[] = CRM_Utils_Date::customFormat($date, NULL, array('j', 'm', 'Y'));
+ $formattedDates[] = CRM_Utils_Date::customFormat($date, NULL, ['j', 'm', 'Y']);
}
$str = str_replace("{contribution.receive_date}", implode($separator, $formattedDates), $str);
unset($knownTokens['contribution']['receive_date']);
case 'fee':
try {
- $value = civicrm_api3('membership_type', 'getvalue', array(
- 'id' => $membership['membership_type_id'],
- 'return' => 'minimum_fee',
- ));
+ $value = civicrm_api3('membership_type', 'getvalue', [
+ 'id' => $membership['membership_type_id'],
+ 'return' => 'minimum_fee',
+ ]);
$value = CRM_Utils_Money::format($value, NULL, NULL, TRUE);
}
catch (CiviCRM_API3_Exception $e) {
case 'receive_date':
$value = CRM_Utils_Array::retrieveValueRecursive($contribution, $token);
- $value = CRM_Utils_Date::customFormat($value, NULL, array('j', 'm', 'Y'));
+ $value = CRM_Utils_Date::customFormat($value, NULL, ['j', 'm', 'Y']);
break;
default:
* [legacy_token => new_token]
*/
public static function legacyContactTokens() {
- return array(
+ return [
'individual_prefix' => 'prefix_id',
'individual_suffix' => 'suffix_id',
'gender' => 'gender_id',
'communication_style' => 'communication_style_id',
- );
+ ];
}
/**
* @param string $entity
* @param bool $usedForTokenWidget
*
- * @return array $customTokens
+ * @return array
* return custom field tokens in array('custom_N' => 'label') format
*/
public static function getCustomFieldTokens($entity, $usedForTokenWidget = FALSE) {
- $customTokens = array();
+ $customTokens = [];
$tokenName = $usedForTokenWidget ? "{contribution.custom_%d}" : "custom_%d";
foreach (CRM_Core_BAO_CustomField::getFields($entity) as $id => $info) {
$customTokens[sprintf($tokenName, $id)] = $info['label'];
* @return array
*/
public static function formatTokensForDisplay($tokens) {
- $sorted = $output = array();
+ $sorted = $output = [];
// Sort in ascending order by ignoring word case
natcasesort($tokens);
// Check to see if this token is already in a group e.g. for custom fields
$split = explode(' :: ', $v);
if (!empty($split[1])) {
- $sorted[$split[1]][] = array('id' => $k, 'text' => $split[0]);
+ $sorted[$split[1]][] = ['id' => $k, 'text' => $split[0]];
}
// Group by entity
else {
else {
$entity = 'Contact';
}
- $sorted[ts($entity)][] = array('id' => $k, 'text' => $v);
+ $sorted[ts($entity)][] = ['id' => $k, 'text' => $v];
}
}
ksort($sorted);
foreach ($sorted as $k => $v) {
- $output[] = array('text' => $k, 'children' => $v);
+ $output[] = ['text' => $k, 'children' => $v];
}
return $output;
projects / civicrm-core.git / blobdiff