return CRM_Contribute_BAO_Contribution::contributionCount($contactId);
case 'membership':
- return CRM_Member_BAO_Membership::getContactMembershipCount($contactId, TRUE);
+ return CRM_Member_BAO_Membership::getContactMembershipCount((int) $contactId, TRUE);
case 'participant':
return CRM_Event_BAO_Participant::getContactParticipantCount($contactId);
if ($field['data_type'] == 'Money' && isset($value)) {
// $value can also be an array(while using IN operator from search builder or api).
foreach ((array) $value as $val) {
- $disp[] = CRM_Utils_Money::format($val, NULL, NULL, TRUE);
+ $disp[] = CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency($val);
}
$display = implode(', ', $disp);
}
elseif ($field['data_type'] == 'Money' &&
$field['html_type'] == 'Text'
) {
- $defaults[$elementName] = CRM_Utils_Money::format($value, NULL, '%a');
+ $defaults[$elementName] = CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency($value);
}
else {
$defaults[$elementName] = $value;
+--------------------------------------------------------------------+
*/
+use Civi\API\Exception\UnauthorizedException;
+use Civi\Api4\MembershipType;
+
/**
*
* @package CRM
* @param int $contactID
* @param bool $activeOnly
*
- * @return null|string
+ * @return int
+ * @throws \API_Exception
*/
- public static function getContactMembershipCount($contactID, $activeOnly = FALSE) {
- $membershipTypes = \Civi\Api4\MembershipType::get(TRUE)
- ->execute()
- ->indexBy('id')
- ->column('name');
- $addWhere = " AND membership_type_id IN (0)";
- if (!empty($membershipTypes)) {
- $addWhere = " AND membership_type_id IN (" . implode(',', array_keys($membershipTypes)) . ")";
- }
+ public static function getContactMembershipCount(int $contactID, $activeOnly = FALSE): int {
+ try {
+ $membershipTypes = MembershipType::get(TRUE)
+ ->execute()
+ ->indexBy('id')
+ ->column('name');
+ $addWhere = " AND membership_type_id IN (0)";
+ if (!empty($membershipTypes)) {
+ $addWhere = " AND membership_type_id IN (" . implode(',', array_keys($membershipTypes)) . ")";
+ }
- $select = "SELECT count(*) FROM civicrm_membership ";
- $where = "WHERE civicrm_membership.contact_id = {$contactID} AND civicrm_membership.is_test = 0 ";
+ $select = "SELECT COUNT(*) FROM civicrm_membership ";
+ $where = "WHERE civicrm_membership.contact_id = {$contactID} AND civicrm_membership.is_test = 0 ";
- // CRM-6627, all status below 3 (active, pending, grace) are considered active
- if ($activeOnly) {
- $select .= " INNER JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
- $where .= " and civicrm_membership_status.is_current_member = 1";
- }
+ // CRM-6627, all status below 3 (active, pending, grace) are considered active
+ if ($activeOnly) {
+ $select .= " INNER JOIN civicrm_membership_status ON civicrm_membership.status_id = civicrm_membership_status.id ";
+ $where .= " and civicrm_membership_status.is_current_member = 1";
+ }
- $query = $select . $where . $addWhere;
- return CRM_Core_DAO::singleValueQuery($query);
+ $query = $select . $where . $addWhere;
+ return (int) CRM_Core_DAO::singleValueQuery($query);
+ }
+ catch (UnauthorizedException $e) {
+ return 0;
+ }
}
/**
// - set the max related block
$allMembershipInfo[$key] = [
'financial_type_id' => $values['financial_type_id'] ?? NULL,
- 'total_amount' => CRM_Utils_Money::format($totalAmount, NULL, '%a'),
+ 'total_amount' => CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency($totalAmount),
'total_amount_numeric' => $totalAmount,
'auto_renew' => $values['auto_renew'] ?? NULL,
'has_related' => isset($values['relationship_type_id']),
}
if (isset($defaults['minimum_fee'])) {
- $defaults['minimum_fee'] = CRM_Utils_Money::format($defaults['minimum_fee'], NULL, '%a');
+ $defaults['minimum_fee'] = CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency($defaults['minimum_fee']);
}
if (isset($defaults['status'])) {
}
$details['total_amount_numeric'] = $details['total_amount'];
// fix the display of the monetary value, CRM-4038
- $details['total_amount'] = CRM_Utils_Money::format($details['total_amount'], NULL, '%a');
+ $details['total_amount'] = CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency($details['total_amount']);
$options = CRM_Core_SelectValues::memberAutoRenew();
$details['auto_renew'] = $options[$details]['auto_renew'] ?? NULL;
CRM_Utils_JSON::output($details);
$row->tokens($entity, $field, \CRM_Utils_Date::customFormat($actionSearchResult->$field));
}
elseif ($field == 'fee') {
- $row->tokens($entity, $field, \CRM_Utils_Money::format($actionSearchResult->$field, NULL, NULL, TRUE));
+ $row->tokens($entity, $field, \CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency($actionSearchResult->$field));
}
elseif (isset($actionSearchResult->$field)) {
$row->tokens($entity, $field, $actionSearchResult->$field);
}
// fix the display of the monetary value, CRM-4038
if (isset($defaults['goal_amount'])) {
- $defaults['goal_amount'] = CRM_Utils_Money::format($defaults['goal_amount'], NULL, '%a');
+ $defaults['goal_amount'] = CRM_Utils_Money::formatLocaleNumericRoundedForDefaultCurrency($defaults['goal_amount']);
}
$defaults['pcp_title'] = $defaults['title'] ?? NULL;
--- /dev/null
+<?php
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved. |
+ | |
+ | This work is published under the GNU AGPLv3 license with some |
+ | permitted exceptions and without any warranty. For full license |
+ | and copyright information, see https://civicrm.org/licensing |
+ +--------------------------------------------------------------------+
+ */
+
+/**
+ *
+ * @package CRM
+ * @copyright CiviCRM LLC https://civicrm.org/licensing
+ */
+class CRM_Utils_EchoLogger extends Psr\Log\AbstractLogger implements \Psr\Log\LoggerInterface {
+
+ /**
+ * Logs with an arbitrary level.
+ *
+ * @param mixed $level
+ * @param string $message
+ * @param array $context
+ */
+ public function log($level, $message, array $context = []) {
+ echo $message . "\n";
+ }
+
+}
--- /dev/null
+<?php
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\RequestInterface;
+
+/**
+ * Additional helpers/utilities for use as Guzzle middleware.
+ */
+class CRM_Utils_GuzzleMiddleware {
+
+ /**
+ * Add this as a Guzzle handler/middleware if you wish to simplify
+ * the construction of Civi-related URLs. It enables URL schemes for:
+ *
+ * - route://ROUTE_NAME (aka) route:ROUTE_NAME
+ * - var://PATH_EXPRESSION (aka) var:PATH_EXPRESSION
+ * - ext://EXTENSION/FILE (aka) ext:EXTENSION/FILE
+ * - assetBuilder://ASSET_NAME?PARAMS (aka) assetBuilder:ASSET_NAME?PARAMS
+ *
+ * Compare:
+ *
+ * $http->get(CRM_Utils_System::url('civicrm/dashboard', NULL, TRUE, NULL, FALSE))
+ * $http->get('route:civicrm/dashboard')
+ *
+ * $http->get(Civi::paths()->getUrl('[civicrm.files]/foo.txt'))
+ * $http->get('var:[civicrm.files]/foo.txt')
+ *
+ * $http->get(Civi::resources()->getUrl('my.other.ext', 'foo.js'))
+ * $http->get('ext:my.other.ext/foo.js')
+ *
+ * $http->get(Civi::service('asset_builder')->getUrl('my-asset.css', ['a'=>1, 'b'=>2]))
+ * $http->get('assetBuilder:my-asset.css?a=1&b=2')
+ *
+ * Note: To further simplify URL expressions, Guzzle allows you to set a 'base_uri'
+ * option (which is applied as a prefix to any relative URLs). Consider using
+ * `base_uri=auto:`. This allows you to implicitly use the most common types
+ * (routes+variables):
+ *
+ * $http->get('civicrm/dashboard')
+ * $http->get('[civicrm.files]/foo.txt')
+ *
+ * @return \Closure
+ */
+ public static function url() {
+ return function(callable $handler) {
+ return function (RequestInterface $request, array $options) use ($handler) {
+ $newUri = self::filterUri($request->getUri());
+ if ($newUri !== NULL) {
+ $request = $request->withUri(\CRM_Utils_Url::parseUrl($newUri));
+ }
+
+ return $handler($request, $options);
+ };
+ };
+ }
+
+ /**
+ * @param \Psr\Http\Message\UriInterface $oldUri
+ *
+ * @return string|null
+ * The string formation of the new URL, or NULL for unchanged URLs.
+ */
+ protected static function filterUri(\Psr\Http\Message\UriInterface $oldUri) {
+ // Copy the old ?query-params and #fragment-params on top of $newBase.
+ $copyParams = function ($newBase) use ($oldUri) {
+ if ($oldUri->getQuery()) {
+ $newBase .= strpos($newBase, '?') !== FALSE ? '&' : '?';
+ $newBase .= $oldUri->getQuery();
+ }
+ if ($oldUri->getFragment()) {
+ $newBase .= '#' . $oldUri->getFragment();
+ }
+ return $newBase;
+ };
+
+ $hostPath = urldecode($oldUri->getHost() . $oldUri->getPath());
+ $scheme = $oldUri->getScheme();
+ if ($scheme === 'auto') {
+ // Ex: 'auto:civicrm/my-page' ==> Router
+ // Ex: 'auto:[civicrm.root]/js/foo.js' ==> Resource file
+ $scheme = ($hostPath[0] === '[') ? 'var' : 'route';
+ }
+
+ switch ($scheme) {
+ case 'assetBuilder':
+ // Ex: 'assetBuilder:dynamic.css' or 'assetBuilder://dynamic.css?foo=bar'
+ // Note: It's more useful to pass params to the asset-builder than to the final HTTP request.
+ $assetParams = [];
+ parse_str('' . $oldUri->getQuery(), $assetParams);
+ return \Civi::service('asset_builder')->getUrl($hostPath, $assetParams);
+
+ case 'ext':
+ // Ex: 'ext:other.ext.name/file.js' or 'ext://other.ext.name/file.js'
+ [$ext, $file] = explode('/', $hostPath, 2);
+ return $copyParams(\Civi::resources()->getUrl($ext, $file));
+
+ case 'var':
+ // Ex: 'var:[civicrm.files]/foo.txt' or 'var://[civicrm.files]/foo.txt'
+ return $copyParams(\Civi::paths()->getUrl($hostPath, 'absolute'));
+
+ case 'route':
+ // Ex: 'route:civicrm/my-page' or 'route://civicrm/my-page'
+ return $copyParams(\CRM_Utils_System::url($hostPath, NULL, TRUE, NULL, FALSE));
+
+ default:
+ return NULL;
+ }
+ }
+
+ /**
+ * This logs the list of outgoing requests in curl format.
+ */
+ public static function curlLog(\Psr\Log\LoggerInterface $logger) {
+
+ $curlFmt = new class() extends \GuzzleHttp\MessageFormatter {
+
+ public function format(RequestInterface $request, ResponseInterface $response = NULL, \Exception $error = NULL) {
+ $cmd = '$ curl';
+ if ($request->getMethod() !== 'GET') {
+ $cmd .= ' -X ' . escapeshellarg($request->getMethod());
+ }
+ foreach ($request->getHeaders() as $header => $lines) {
+ foreach ($lines as $line) {
+ $cmd .= ' -H ' . escapeshellarg("$header: $line");
+ }
+ }
+ $body = (string) $request->getBody();
+ if ($body !== '') {
+ $cmd .= ' -d ' . escapeshellarg($body);
+ }
+ $cmd .= ' ' . escapeshellarg((string) $request->getUri());
+ return $cmd;
+ }
+
+ };
+
+ return \GuzzleHttp\Middleware::log($logger, $curlFmt);
+ }
+
+}
[
'name' => 'data_type',
'data_type' => 'String',
+ 'options' => [
+ 'Integer' => ts('Integer'),
+ 'Boolean' => ts('Boolean'),
+ 'String' => ts('String'),
+ 'Text' => ts('Text'),
+ 'Date' => ts('Date'),
+ 'Timestamp' => ts('Timestamp'),
+ 'Array' => ts('Array'),
+ ],
],
[
'name' => 'input_type',
'data_type' => 'String',
+ 'options' => [
+ 'Text' => ts('Text'),
+ 'Number' => ts('Number'),
+ 'Select' => ts('Select'),
+ 'CheckBox' => ts('CheckBox'),
+ 'Radio' => ts('Radio'),
+ 'Date' => ts('Date'),
+ 'File' => ts('File'),
+ 'EntityRef' => ts('EntityRef'),
+ 'ChainSelect' => ts('ChainSelect'),
+ ],
],
[
'name' => 'input_attrs',
/**
* Class GuzzleTestTrait
*
- * This trait defines a number of helper functions for testing guzzle.
+ * This trait defines a number of helper functions for testing Guzzle-based logic,
+ * such as a payment-processing gateway.
+ *
+ * Use this in a headless test for which you need to mock outbound HTTP requests from Civi.
+ * Alternatively, to write an E2E test with inbound HTTP requests to Civi, see HttpTestTrait.
*/
trait GuzzleTestTrait {
/**
--- /dev/null
+<?php
+
+namespace Civi\Test;
+
+use GuzzleHttp\HandlerStack;
+use GuzzleHttp\MessageFormatter;
+use GuzzleHttp\Middleware;
+
+/**
+ * Class HttpTestTrait
+ *
+ * @package Civi\Test
+ *
+ * This trait provides helpers/assertions for testing Civi's HTTP interfaces, eg
+ *
+ * - createGuzzle() - Create HTTP client for sending requests to Civi.
+ * - callApi4AjaxSuccess() - Use an HTTP client to send an AJAX-style request to APIv4
+ * - callApi4AjaxError() - Use an HTTP client to send an AJAX-style request to APIv4
+ * - assertStatusCode() - Check the status code. If it fails, output detailed information.
+ * - assertContentType() - Check the content-type. If it fails, output detailed information.
+ *
+ * Use this in an E2E test for which you need to send inbound HTTP requests to Civi.
+ * Alternatively, for a headless test which mocks outbound HTTP, see GuzzleTestTrait.
+ */
+trait HttpTestTrait {
+
+ /**
+ * List of HTTP requests that have been made by this test.
+ *
+ * @var array
+ */
+ protected $httpHistory = [];
+
+ /**
+ * Create an HTTP client suitable for simulating AJAX requests.
+ *
+ * @param array $options
+ * @return \GuzzleHttp\Client
+ */
+ protected function createGuzzle($options = []) {
+ $handler = HandlerStack::create();
+ $handler->unshift(\CRM_Utils_GuzzleMiddleware::url(), 'civi_url');
+ $handler->push(Middleware::history($this->httpHistory), 'history');
+
+ if (getenv('DEBUG') >= 2) {
+ $handler->push(Middleware::log(new \CRM_Utils_EchoLogger(), new MessageFormatter(MessageFormatter::DEBUG)), 'log');
+ }
+ elseif (getenv('DEBUG') >= 1) {
+ $handler->push(\CRM_Utils_GuzzleMiddleware::curlLog(new \CRM_Utils_EchoLogger()), 'curl_log');
+ }
+
+ $defaults = [
+ 'handler' => $handler,
+ 'base_uri' => 'auto:',
+ ];
+
+ $options = array_merge($defaults, $options);
+ return new \GuzzleHttp\Client($options);
+ }
+
+ /**
+ * @param string $entity
+ * @param string $action
+ * @param array $params
+ *
+ * @return mixed
+ */
+ protected function callApi4AjaxSuccess(string $entity, string $action, $params = []) {
+ $method = \CRM_Utils_String::startsWith($action, 'get') ? 'GET' : 'POST';
+ $response = $this->createGuzzle()->request($method, "civicrm/ajax/api4/$entity/$action", [
+ 'headers' => ['X-Requested-With' => 'XMLHttpRequest'],
+ // This should probably be 'form_params', but 'query' is more representative of frontend.
+ 'query' => ['params' => json_encode($params)],
+ 'http_errors' => FALSE,
+ ]);
+ $this->assertContentType('application/json', $response);
+ $this->assertStatusCode(200, $response);
+ $result = json_decode((string) $response->getBody(), 1);
+ if (json_last_error() !== JSON_ERROR_NONE) {
+ $this->fail("Failed to decode APIv4 JSON.\n" . $this->formatFailure($response));
+ }
+ return $result;
+ }
+
+ /**
+ * @param string $entity
+ * @param string $action
+ * @param array $params
+ *
+ * @return mixed
+ */
+ protected function callApi4AjaxError(string $entity, string $action, $params = []) {
+ $method = \CRM_Utils_String::startsWith($action, 'get') ? 'GET' : 'POST';
+ $response = $this->createGuzzle()->request($method, "civicrm/ajax/api4/$entity/$action", [
+ 'headers' => ['X-Requested-With' => 'XMLHttpRequest'],
+ // This should probably be 'form_params', but 'query' is more representative of frontend.
+ 'query' => ['params' => json_encode($params)],
+ 'http_errors' => FALSE,
+ ]);
+ $this->assertContentType('application/json', $response);
+ $this->assertTrue($response->getStatusCode() >= 400, 'Should return an error' . $this->formatFailure($response));
+ $result = json_decode((string) $response->getBody(), 1);
+ if (json_last_error() !== JSON_ERROR_NONE) {
+ $this->fail("Failed to decode APIv4 JSON.\n" . $this->formatFailure($response));
+ }
+ return $result;
+ }
+
+ /**
+ * @param $expectCode
+ * @param \Psr\Http\Message\ResponseInterface|NULL $response
+ * If NULL, then it uses the last response.
+ *
+ * @return $this
+ */
+ protected function assertStatusCode($expectCode, $response = NULL) {
+ $response = $this->resolveResponse($response);
+ $actualCode = $response->getStatusCode();
+ $fmt = $actualCode === $expectCode ? '' : $this->formatFailure($response);
+ $this->assertEquals($expectCode, $actualCode, "Expected HTTP response $expectCode. Received HTTP response $actualCode.\n$fmt");
+ return $this;
+ }
+
+ /**
+ * @param $expectType
+ * @param \Psr\Http\Message\ResponseInterface|NULL $response
+ * If NULL, then it uses the last response.
+ *
+ * @return $this
+ */
+ protected function assertContentType($expectType, $response = NULL) {
+ $response = $this->resolveResponse($response);
+ list($actualType) = explode(';', $response->getHeader('Content-Type')[0]);
+ $fmt = $actualType === $expectType ? '' : $this->formatFailure($response);
+ $this->assertEquals($expectType, $actualType, "Expected content-type $expectType. Received content-type $actualType.\n$fmt");
+ return $this;
+ }
+
+ /**
+ * @param \Psr\Http\Message\ResponseInterface|NULL $response
+ * @return \Psr\Http\Message\ResponseInterface
+ */
+ protected function resolveResponse($response) {
+ return $response ?: $this->httpHistory[count($this->httpHistory) - 1]['response'];
+ }
+
+ /**
+ * Given that an HTTP request has yielded a failed response, format a blurb
+ * to summarize the details of the request+response.
+ *
+ * @param \Psr\Http\Message\ResponseInterface $response
+ *
+ * @return false|string
+ */
+ protected function formatFailure(\Psr\Http\Message\ResponseInterface $response) {
+ $details = [];
+
+ $condenseArray = function($v) {
+ if (is_array($v) && count($v) === 1 && isset($v[0])) {
+ return $v[0];
+ }
+ else {
+ return $v;
+ }
+ };
+
+ /** @var \Psr\Http\Message\RequestInterface $request */
+ $request = NULL;
+ foreach ($this->httpHistory as $item) {
+ if ($item['response'] === $response) {
+ $request = $item['request'];
+ break;
+ }
+ }
+
+ if ($request) {
+ $details['request'] = [
+ 'uri' => (string) $request->getUri(),
+ 'method' => $request->getMethod(),
+ // Most headers only have one item. JSON pretty-printer adds several newlines. This output is meant for dev's reading the error-log.
+ 'headers' => array_map($condenseArray, $request->getHeaders()),
+ 'body' => (string) $request->getBody(),
+ ];
+ }
+
+ $details['response'] = [
+ 'status' => $response->getStatusCode() . ' ' . $response->getReasonPhrase(),
+ // Most headers only have one item. JSON pretty-printer adds several newlines. This output is meant for dev's reading the error-log.
+ 'headers' => array_map($condenseArray, $response->getHeaders()),
+ 'body' => (string) $response->getBody(),
+ ];
+
+ // If we get a full HTML document, then it'll be hard to read the error messages. Give an alternate rendition.
+ if (preg_match(';\<(!DOCTYPE|HTML);', $details['response']['body'])) {
+ // $details['bodyText'] = strip_tags($details['body']); // too much <style> noise
+ $details['response']['body'] = \CRM_Utils_String::htmlToText($details['response']['body']);
+ }
+
+ return json_encode($details, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES);
+ }
+
+}
userModifiedAmount = cj(this).val();
userModifiedAmount = Number(userModifiedAmount.replace(/[^0-9\.]+/g,""));
if (userModifiedAmount < feeAmount) {
- cj('#status_id').val(partiallyPaidStatusId).change();
+ cj('.crm-participant-form-block-status_id #status_id').val(partiallyPaidStatusId).change();
}
}
);
return true;
}
}
- var userSubmittedStatus = cj('#status_id').val();
- var statusLabel = cj('#status_id option:selected').text();
+ var userSubmittedStatus = cj('.crm-participant-form-block-status_id #status_id').val();
+ var statusLabel = cj('.crm-participant-form-block-status_id #status_id option:selected').text();
if (userModifiedAmount < feeAmount && userSubmittedStatus != partiallyPaidStatusId) {
var msg = "{/literal}{ts escape="js" 1="%1"}Payment amount is less than the amount owed. Expected participant status is 'Partially paid'. Are you sure you want to set the participant status to %1? Click OK to continue, Cancel to change your entries.{/ts}{literal}";
var result = confirm(ts(msg, {1: statusLabel}));
function sendNotification() {
var notificationStatusIds = {/literal}"{$notificationStatusIds}"{literal};
notificationStatusIds = notificationStatusIds.split(',');
- if (cj.inArray(cj('select#status_id option:selected').val(), notificationStatusIds) > -1) {
+ if (cj.inArray(cj('.crm-participant-form-block-status_id select#status_id option:selected').val(), notificationStatusIds) > -1) {
cj("#notify").show();
cj("#is_notify").prop('checked', false);
}
projects / civicrm-core.git / commitdiff