<?php
/*
+--------------------------------------------------------------------+
- | CiviCRM version 4.4 |
+ | CiviCRM version 4.5 |
+--------------------------------------------------------------------+
- | Copyright CiviCRM LLC (c) 2004-2013 |
+ | Copyright CiviCRM LLC (c) 2004-2014 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
/**
*
* @package CRM
- * @copyright CiviCRM LLC (c) 2004-2013
+ * @copyright CiviCRM LLC (c) 2004-2014
* $Id: $
*
*/
/**
* Wrapper for token replacing
*
- * @param string $type The token type
- * @param string $var The token variable
- * @param string $value The value to substitute for the token
- * @param string (reference) $str The string to replace in
+ * @param string $type The token type
+ * @param string $var The token variable
+ * @param string $value The value to substitute for the token
+ * @param string (reference) $str The string to replace in
+ *
+ * @param bool $escapeSmarty
*
* @return string The processed string
* @access public
/**
* get< the regex for token replacement
*
- * @param string $key a string indicating the the type of token to be used in the expression
+ * @param $token_type
+ *
+ * @internal param string $key a string indicating the the type of token to be used in the expression
*
* @return string regular expression sutiable for using in preg_replace
* @access private
return preg_replace(array('/{/', '/(?<!{ldelim)}/'), array('{ldelim}', '{rdelim}'), $string);
}
- /**
/**
* Replace all the domain-level tokens in $str
*
- * @param string $str The string with tokens to be replaced
- * @param object $domain The domain BAO
- * @param boolean $html Replace tokens with HTML or plain text
+ * @param string $str The string with tokens to be replaced
+ * @param object $domain The domain BAO
+ * @param boolean $html Replace tokens with HTML or plain text
+ *
+ * @param null $knownTokens
+ * @param bool $escapeSmarty
*
* @return string The processed string
* @access public
) {
$key = 'domain';
if (
- !$knownTokens ||
- !CRM_Utils_Array::value($key, $knownTokens)
- ) {
+ !$knownTokens || empty($knownTokens[$key])) {
return $str;
}
return $str;
}
+ /**
+ * @param $token
+ * @param $domain
+ * @param bool $html
+ * @param bool $escapeSmarty
+ *
+ * @return mixed|null|string
+ */
public static function getDomainTokenReplacement($token, &$domain, $html = FALSE, $escapeSmarty = FALSE) {
// check if the token we were passed is valid
// we have to do this because this function is
$value = NULL;
/* Construct the address token */
- if (CRM_Utils_Array::value($token, $loc)) {
+ if (!empty($loc[$token])) {
if ($html) {
$value = $loc[$token][1]['display'];
$value = str_replace("\n", '<br />', $value);
/* Construct the phone and email tokens */
$value = NULL;
- if (CRM_Utils_Array::value($token, $loc)) {
+ if (!empty($loc[$token])) {
foreach ($loc[$token] as $index => $entity) {
$value = $entity[$token];
break;
/**
* Replace all the org-level tokens in $str
*
- * @param string $str The string with tokens to be replaced
- * @param object $org Associative array of org properties
- * @param boolean $html Replace tokens with HTML or plain text
+ * @param string $str The string with tokens to be replaced
+ * @param object $org Associative array of org properties
+ * @param boolean $html Replace tokens with HTML or plain text
+ *
+ * @param bool $escapeSmarty
*
* @return string The processed string
* @access public
/**
* Replace all mailing tokens in $str
*
- * @param string $str The string with tokens to be replaced
- * @param object $mailing The mailing BAO, or null for validation
- * @param boolean $html Replace tokens with HTML or plain text
+ * @param string $str The string with tokens to be replaced
+ * @param object $mailing The mailing BAO, or null for validation
+ * @param boolean $html Replace tokens with HTML or plain text
+ *
+ * @param null $knownTokens
+ * @param bool $escapeSmarty
*
* @return string The processed sstring
* @access public
return $str;
}
+ /**
+ * @param $token
+ * @param $mailing
+ * @param bool $escapeSmarty
+ *
+ * @return string
+ */
public static function getMailingTokenReplacement($token, &$mailing, $escapeSmarty = FALSE) {
$value = '';
switch ($token) {
break;
case 'viewUrl':
+ $mailingKey = $mailing->id;
+ if ($hash = CRM_Mailing_BAO_Mailing::getMailingHash($mailingKey)) {
+ $mailingKey = $hash;
+ }
$value = CRM_Utils_System::url('civicrm/mailing/view',
- "reset=1&id={$mailing->id}",
+ "reset=1&id={$mailingKey}",
TRUE, NULL, FALSE, TRUE
);
break;
case 'html':
$page = new CRM_Mailing_Page_View();
- $value = $page->run($mailing->id, NULL, FALSE);
+ $value = $page->run($mailing->id, NULL, FALSE, TRUE);
break;
case 'approvalStatus':
/**
* Replace all action tokens in $str
*
- * @param string $str The string with tokens to be replaced
- * @param array $addresses Assoc. array of VERP event addresses
- * @param array $urls Assoc. array of action URLs
- * @param boolean $html Replace tokens with HTML or plain text
- * @param array $knownTokens A list of tokens that are known to exist in the email body
+ * @param string $str The string with tokens to be replaced
+ * @param array $addresses Assoc. array of VERP event addresses
+ * @param array $urls Assoc. array of action URLs
+ * @param boolean $html Replace tokens with HTML or plain text
+ * @param array $knownTokens A list of tokens that are known to exist in the email body
+ *
+ * @param bool $escapeSmarty
*
* @return string The processed string
* @access public
// so that we remove anything we do not recognize
// I hope to move this step out of here soon and
// then we will just iterate on a list of tokens that are passed to us
- if (!$knownTokens || !CRM_Utils_Array::value($key, $knownTokens)) {
+ if (!$knownTokens || empty($knownTokens[$key])) {
return $str;
}
return $str;
}
+ /**
+ * @param $token
+ * @param $addresses
+ * @param $urls
+ * @param bool $html
+ * @param bool $escapeSmarty
+ *
+ * @return mixed|string
+ */
public static function getActionTokenReplacement(
$token,
&$addresses,
* Replace all the contact-level tokens in $str with information from
* $contact.
*
- * @param string $str The string with tokens to be replaced
- * @param array $contact Associative array of contact properties
- * @param boolean $html Replace tokens with HTML or plain text
- * @param array $knownTokens A list of tokens that are known to exist in the email body
- * @param boolean $returnBlankToken return unevaluated token if value is null
+ * @param string $str The string with tokens to be replaced
+ * @param array $contact Associative array of contact properties
+ * @param boolean $html Replace tokens with HTML or plain text
+ * @param array $knownTokens A list of tokens that are known to exist in the email body
+ * @param boolean $returnBlankToken return unevaluated token if value is null
+ *
+ * @param bool $escapeSmarty
*
* @return string The processed string
* @access public
// so that we remove anything we do not recognize
// I hope to move this step out of here soon and
// then we will just iterate on a list of tokens that are passed to us
- if (!$knownTokens || !CRM_Utils_Array::value($key, $knownTokens)) {
+ if (!$knownTokens || empty($knownTokens[$key])) {
return $str;
}
return $str;
}
+ /**
+ * @param $token
+ * @param $contact
+ * @param bool $html
+ * @param bool $returnBlankToken
+ * @param bool $escapeSmarty
+ *
+ * @return bool|mixed|null|string
+ */
public static function getContactTokenReplacement(
$token,
&$contact,
/* Construct value from $token and $contact */
$value = NULL;
+ $noReplace = FALSE;
// Support legacy tokens
$token = CRM_Utils_Array::value($token, self::legacyContactTokens(), $token);
// called only when we find a token in the string
if (!in_array($token, self::$_tokens['contact'])) {
- $value = "{contact.$token}";
+ $noReplace = TRUE;
}
elseif ($token == 'checksum') {
$hash = CRM_Utils_Array::value('hash', $contact);
// if null then return actual token
if ($returnBlankToken && !$value) {
+ $noReplace = TRUE;
+ }
+
+ if ($noReplace) {
$value = "{contact.$token}";
}
- if ($escapeSmarty) {
+ if ($escapeSmarty
+ && !($returnBlankToken && $noReplace)) { // $returnBlankToken means the caller wants to do further attempts at processing unreplaced tokens -- so don't escape them yet in this case.
$value = self::tokenEscapeSmarty($value);
}
* Replace all the hook tokens in $str with information from
* $contact.
*
- * @param string $str The string with tokens to be replaced
- * @param array $contact Associative array of contact properties (including hook token values)
- * @param boolean $html Replace tokens with HTML or plain text
+ * @param string $str The string with tokens to be replaced
+ * @param array $contact Associative array of contact properties (including hook token values)
+ * @param $categories
+ * @param boolean $html Replace tokens with HTML or plain text
+ *
+ * @param bool $escapeSmarty
*
* @return string The processed string
* @access public
}
return $tokenHtml;
}
- public static function getHookTokenReplacement(
+
+ /**
+ * @param $token
+ * @param $contact
+ * @param $category
+ * @param bool $html
+ * @param bool $escapeSmarty
+ *
+ * @return mixed|string
+ */public static function getHookTokenReplacement(
$token,
&$contact,
$category,
/**
* Replace subscription-confirmation-request tokens
*
- * @param string $str The string with tokens to be replaced
- * @param string $group The name of the group being subscribed
- * @param boolean $html Replace tokens with html or plain text
+ * @param string $str The string with tokens to be replaced
+ * @param string $group The name of the group being subscribed
+ * @param $url
+ * @param boolean $html Replace tokens with html or plain text
*
* @return string The processed string
* @access public
/**
* Find and replace tokens for each component
*
- * @param string $str The string to search
- * @param array $contact Associative array of contact properties
+ * @param string $str The string to search
+ * @param array $contact Associative array of contact properties
* @param array $components A list of tokens that are known to exist in the email body
*
+ * @param bool $escapeSmarty
+ * @param bool $returnEmptyToken
+ *
* @return string The processed string
* @access public
* @static
*
* @param $string the input string to parse for tokens
*
- * @return $tokens array of tokens mentioned in field
- * @access public
+ * @return array $tokens array of tokens mentioned in field@access public
* @static
*/
static function getTokens($string) {
* gives required details of contacts in an indexed array format so we
* can iterate in a nice loop and do token evaluation
*
- * @param array $contactIds of contacts
- * @param array $returnProperties of required properties
- * @param boolean $skipOnHold don't return on_hold contact info also.
- * @param boolean $skipDeceased don't return deceased contact info.
- * @param array $extraParams extra params
- * @param array $tokens the list of tokens we've extracted from the content
- * @param int $jobID the mailing list jobID - this is a legacy param
+ * @param $contactIDs
+ * @param array $returnProperties of required properties
+ * @param boolean $skipOnHold don't return on_hold contact info also.
+ * @param boolean $skipDeceased don't return deceased contact info.
+ * @param array $extraParams extra params
+ * @param array $tokens the list of tokens we've extracted from the content
+ * @param null $className
+ * @param int $jobID the mailing list jobID - this is a legacy param
*
+ * @internal param array $contactIds of contacts
* @return array
* @access public
* @static
//special case for greeting replacement
foreach (array(
'email_greeting', 'postal_greeting', 'addressee') as $val) {
- if (CRM_Utils_Array::value($val, $contactDetails[$contactID])) {
+ if (!empty($contactDetails[$contactID][$val])) {
$contactDetails[$contactID][$val] = $contactDetails[$contactID]["{$val}_display"];
}
}
);
return $details;
}
+
/**
* gives required details of contribuion in an indexed array format so we
* can iterate in a nice loop and do token evaluation
*
- * @param array $contributionId one contribution id
- * @param array $returnProperties of required properties
- * @param boolean $skipOnHold don't return on_hold contact info.
- * @param boolean $skipDeceased don't return deceased contact info.
- * @param array $extraParams extra params
- * @param array $tokens the list of tokens we've extracted from the content
+ * @param $contributionIDs
+ * @param array $returnProperties of required properties
+ * @param array $extraParams extra params
+ * @param array $tokens the list of tokens we've extracted from the content
+ *
+ * @param null $className
*
+ * @internal param array $contributionId one contribution id
+ * @internal param bool $skipOnHold don't return on_hold contact info.
+ * @internal param bool $skipDeceased don't return deceased contact info.
* @return array
* @access public
* @static
$tokens = array(),
$className = NULL
) {
+ //@todo - this function basically replications calling civicrm_api3('contribution', 'get', array('id' => array('IN' => array())
if (empty($contributionIDs)) {
// putting a fatal here so we can track if/when this happens
CRM_Core_Error::fatal();
CRM_Core_DAO::storeValues($dao, $details[$dao->id]);
// do the necessary transformation
- if (CRM_Utils_Array::value('payment_instrument_id', $details[$dao->id])) {
+ if (!empty($details[$dao->id]['payment_instrument_id'])) {
$piId = $details[$dao->id]['payment_instrument_id'];
$pis = CRM_Contribute_PseudoConstant::paymentInstrument();
$details[$dao->id]['payment_instrument'] = $pis[$piId];
}
- if (CRM_Utils_Array::value('campaign_id', $details[$dao->id])) {
+ if (!empty($details[$dao->id]['campaign_id'])) {
$campaignId = $details[$dao->id]['campaign_id'];
$campaigns = CRM_Campaign_BAO_Campaign::getCampaigns($campaignId);
$details[$dao->id]['campaign'] = $campaigns[$campaignId];
}
- if (CRM_Utils_Array::value('financial_type_id', $details[$dao->id])) {
+ if (!empty($details[$dao->id]['financial_type_id'])) {
$financialtypeId = $details[$dao->id]['financial_type_id'];
$ftis = CRM_Contribute_PseudoConstant::financialType();
$details[$dao->id]['financial_type'] = $ftis[$financialtypeId];
*
* @access public
*/
- static function replaceGreetingTokens(&$tokenString, $contactDetails = NULL, $contactId = NULL, $className = NULL) {
+ static function replaceGreetingTokens(&$tokenString, $contactDetails = NULL, $contactId = NULL, $className = NULL, $escapeSmarty = FALSE) {
if (!$contactDetails && !$contactId) {
return;
if (!empty($greetingTokens)) {
// first use the existing contact object for token replacement
if (!empty($contactDetails)) {
- $tokenString = CRM_Utils_Token::replaceContactTokens($tokenString, $contactDetails, TRUE, $greetingTokens, TRUE);
+ $tokenString = CRM_Utils_Token::replaceContactTokens($tokenString, $contactDetails, TRUE, $greetingTokens, TRUE, $escapeSmarty);
}
// check if there are any unevaluated tokens
$tokenString = CRM_Utils_Token::replaceContactTokens($tokenString,
$greetingDetails,
TRUE,
- $greetingTokens
+ $greetingTokens,
+ FALSE,
+ $escapeSmarty
);
}
}
}
+ /**
+ * @param $tokens
+ *
+ * @return array
+ */
static function flattenTokens(&$tokens) {
$flattenTokens = array();
/**
* Replace all user tokens in $str
*
- * @param string $str The string with tokens to be replaced
+ * @param string $str The string with tokens to be replaced
+ *
+ * @param null $knownTokens
+ * @param bool $escapeSmarty
*
* @return string The processed string
* @access public
return $str;
}
+ /**
+ * @param $token
+ * @param bool $escapeSmarty
+ *
+ * @return string
+ */
public static function getUserTokenReplacement($token, $escapeSmarty = FALSE) {
$value = '';
return $value;
}
-
+ /**
+ *
+ */
protected static function _buildContributionTokens() {
$key = 'contribution';
if (self::$_tokens[$key] == NULL) {
* @return string string with replacements made
*/
public static function replaceEntityTokens($entity, $entityArray, $str, $knownTokens = array(), $escapeSmarty = FALSE) {
- if (!$knownTokens || !CRM_Utils_Array::value($entity, $knownTokens)) {
+ if (!$knownTokens || empty($knownTokens[$entity])) {
return $str;
}
return $str;
}
- public static function &replaceContributionTokens($str, &$contribution, $html = FALSE, $knownTokens = NULL, $escapeSmarty = FALSE) {
+ /**
+ * Replace Contribution tokens in html
+ *
+ * @param string $str
+ * @param array $contribution
+ * @param bool|string $html
+ * @param string $knownTokens
+ * @param bool|string $escapeSmarty
+ *
+ * @return unknown|Ambigous <string, mixed>|mixed
+ */
+ 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
+ }
self::_buildContributionTokens();
// here we intersect with the list of pre-configured valid tokens
// so that we remove anything we do not recognize
// I hope to move this step out of here soon and
// then we will just iterate on a list of tokens that are passed to us
- $key = 'contribution';
- if (!$knownTokens || !CRM_Utils_Array::value($key, $knownTokens)) {
- return $str;
- }
$str = preg_replace_callback(
self::tokenRegex($key),
return $str;
}
+ /**
+ * We have a situation where we are rendering more than one token in each field because we are combining
+ * tokens from more than one contribution when pdf thank you letters are grouped (CRM-14367)
+ *
+ * The replaceContributionToken doesn't handle receive_date correctly in this scenario because of the formatting
+ * it applies (other tokens are OK including date fields)
+ *
+ * So we sort this out & then call the main function. Note that we are not escaping smarty on this fields like the main function
+ * does - but the fields is already being formatted through a date function
+ *
+ * @param string $separator
+ * @param string $str
+ * @param array $contribution
+ * @param bool|string $html
+ * @param string $knownTokens
+ * @param bool|string $escapeSmarty
+ *
+ * @return \Ambigous|mixed|string|\unknown
+ */
+ public static function replaceMultipleContributionTokens($separator, $str, &$contribution, $html = FALSE, $knownTokens = NULL, $escapeSmarty = FALSE) {
+ if(empty($knownTokens['contribution'])) {
+ return $str;
+ }
+
+ if(in_array('receive_date', $knownTokens['contribution'])) {
+ $formattedDates = array();
+ $dates = explode($separator, $contribution['receive_date']);
+ foreach ($dates as $date) {
+ $formattedDates[] = CRM_Utils_Date::customFormat($date, NULL, array('j', 'm', 'Y'));
+ }
+ $str = str_replace("{contribution.receive_date}", implode($separator, $formattedDates), $str);
+ unset($knownTokens['contribution']['receive_date']);
+ }
+ return self::replaceContributionTokens($str, $contribution, $html, $knownTokens, $escapeSmarty);
+ }
+
/**
* Get replacement strings for any membership tokens (only a small number of tokens are implemnted in the first instance
* - this is used by the pdfLetter task from membership search
return $value;
}
+ /**
+ * @param $token
+ * @param $contribution
+ * @param bool $html
+ * @param bool $escapeSmarty
+ *
+ * @return mixed|string
+ */
public static function getContributionTokenReplacement($token, &$contribution, $html = FALSE, $escapeSmarty = FALSE) {
self::_buildContributionTokens();
return $value;
}
- function getPermissionEmails($permissionName) {}
-
- function getRoleEmails($roleName) {}
-
/**
* @return array: legacy_token => new_token
*/
'individual_prefix' => 'prefix_id',
'individual_suffix' => 'suffix_id',
'gender' => 'gender_id',
+ 'communication_style' => 'communication_style_id',
);
}
+ /**
+ * Formats a token list for the select2 widget
+ * @param $tokens
+ * @return array
+ */
+ static function formatTokensForDisplay($tokens) {
+ $sorted = $output = array();
+
+ // Sort in ascending order by ignoring word case
+ natcasesort($tokens);
+
+ // Attempt to place tokens into optgroups
+ // TODO: These groupings could be better and less hackish. Getting them pre-grouped from upstream would be nice.
+ foreach ($tokens as $k => $v) {
+ // 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]);
+ }
+ // Group by entity
+ else {
+ $split = explode('.', trim($k, '{}'));
+ $entity = isset($split[1]) ? ucfirst($split[0]) : 'Contact';
+ $sorted[ts($entity)][] = array('id' => $k, 'text' => $v);
+ }
+ }
+
+ ksort($sorted);
+ foreach ($sorted as $k => $v) {
+ $output[] = array('text' => $k, 'children' => $v);
+ }
+
+ return $output;
+ }
}
projects / civicrm-core.git / blobdiff