3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
15 * @copyright CiviCRM LLC https://civicrm.org/licensing
19 * System wide utilities.
21 * Provides a collection of Civi utilities + access to the CMS-dependant utilities
23 * FIXME: This is a massive and random collection that could be split into smaller services
25 * @method static mixed permissionDenied() Show access denied screen.
26 * @method static mixed logout() Log out the current user.
27 * @method static mixed updateCategories() Clear CMS caches related to the user registration/profile forms.
28 * @method static appendBreadCrumb(array $breadCrumbs) Append an additional breadcrumb tag to the existing breadcrumbs.
29 * @method static resetBreadCrumb() Reset an additional breadcrumb tag to the existing breadcrumb.
30 * @method static addHTMLHead(string $bc) Append a string to the head of the HTML file.
31 * @method static string postURL(int $action) Determine the post URL for a form.
32 * @method static string|null getUFLocale() Get the locale of the CMS.
33 * @method static bool setUFLocale(string $civicrm_language) Set the locale of the CMS.
34 * @method static bool isUserLoggedIn() Check if user is logged in.
35 * @method static int getLoggedInUfID() Get current logged in user id.
36 * @method static setHttpHeader(string $name, string $value) Set http header.
37 * @method static array synchronizeUsers() Create CRM contacts for all existing CMS users.
38 * @method static appendCoreResources(\Civi\Core\Event\GenericHookEvent $e) Callback for hook_civicrm_coreResourceList.
39 * @method static alterAssetUrl(\Civi\Core\Event\GenericHookEvent $e) Callback for hook_civicrm_getAssetUrl.
41 class CRM_Utils_System
{
43 public static $_callbacks = NULL;
49 public static $title = '';
52 * Access methods in the appropriate CMS class
58 public static function __callStatic($name, $arguments) {
59 $userSystem = CRM_Core_Config
::singleton()->userSystem
;
60 return call_user_func_array([$userSystem, $name], $arguments);
64 * Compose a new URL string from the current URL string.
66 * Used by all the framework components, specifically,
69 * @param string $urlVar
70 * The url variable being considered (i.e. crmPageID, crmSortID etc).
71 * @param bool $includeReset
72 * (optional) Whether to include the reset GET string (if present).
73 * @param bool $includeForce
74 * (optional) Whether to include the force GET string (if present).
76 * (optional) The path to use for the new url.
77 * @param bool|string $absolute
78 * (optional) Whether to return an absolute URL.
83 public static function makeURL($urlVar, $includeReset = FALSE, $includeForce = TRUE, $path = NULL, $absolute = FALSE) {
84 $path = $path ?
: CRM_Utils_System
::currentPath();
91 CRM_Utils_System
::getLinksUrl($urlVar, $includeReset, $includeForce),
97 * Get the query string and clean it up.
99 * Strips some variables that should not be propagated, specifically variables
100 * like 'reset'. Also strips any side-affect actions (e.g. export).
102 * This function is copied mostly verbatim from Pager.php (_getLinksUrl)
104 * @param string $urlVar
105 * The URL variable being considered (e.g. crmPageID, crmSortID etc).
106 * @param bool $includeReset
107 * (optional) By default this is FALSE, meaning that the reset parameter
108 * is skipped. Set to TRUE to leave the reset parameter as-is.
109 * @param bool $includeForce
111 * @param bool $skipUFVar
116 public static function getLinksUrl($urlVar, $includeReset = FALSE, $includeForce = TRUE, $skipUFVar = TRUE) {
117 // Sort out query string to prevent messy urls
122 if (!empty($_SERVER['QUERY_STRING'])) {
123 $qs = explode('&', str_replace('&', '&', $_SERVER['QUERY_STRING']));
124 for ($i = 0, $cnt = count($qs); $i < $cnt; $i++
) {
125 // check first if exist a pair
126 if (strstr($qs[$i], '=') !== FALSE) {
127 list($name, $value) = explode('=', $qs[$i]);
128 if ($name != $urlVar) {
129 $name = rawurldecode($name);
130 // check for arrays in parameters: site.php?foo[]=1&foo[]=2&foo[]=3
131 if ((strpos($name, '[') !== FALSE) &&
132 (strpos($name, ']') !== FALSE)
152 // Ok this is a big assumption but usually works
153 // If we are in snippet mode, retain the 'section' param, if not, get rid
155 if (!empty($qs['snippet'])) {
156 unset($qs['snippet']);
159 unset($qs['section']);
163 $config = CRM_Core_Config
::singleton();
164 unset($qs[$config->userFrameworkURLVar
]);
167 foreach ($qs as $name => $value) {
168 if ($name != 'reset' ||
$includeReset) {
169 $querystring[] = $name . '=' . $value;
173 $querystring = array_merge($querystring, array_unique($arrays));
175 $url = implode('&', $querystring);
177 $url .= (!empty($querystring) ?
'&' : '') . $urlVar . '=';
184 * If we are using a theming system, invoke theme, else just print the content.
186 * @param string $content
187 * The content that will be themed.
189 * (optional) Are we displaying to the screen or bypassing theming?
190 * @param bool $maintenance
191 * (optional) For maintenance mode.
195 public static function theme(
200 return CRM_Core_Config
::singleton()->userSystem
->theme($content, $print, $maintenance);
204 * Generate a query string if input is an array.
206 * @param array|string $query
210 public static function makeQueryString($query) {
211 if (is_array($query)) {
213 foreach ($query as $key => $value) {
214 $buf .= ($buf ?
'&' : '') . urlencode($key) . '=' . urlencode($value);
222 * Generate an internal CiviCRM URL.
224 * @param string $path
225 * The path being linked to, such as "civicrm/add".
226 * @param array|string $query
227 * A query string to append to the link, or an array of key-value pairs.
228 * @param bool $absolute
229 * Whether to force the output to be an absolute link (beginning with a
230 * URI-scheme such as 'http:'). Useful for links that will be displayed
231 * outside the site, such as in an RSS feed.
232 * @param string $fragment
233 * A fragment identifier (named anchor) to append to the link.
234 * @param bool $htmlize
235 * Whether to encode special html characters such as &.
236 * @param bool $frontend
237 * This link should be to the CMS front end (applies to WP & Joomla).
238 * @param bool $forceBackend
239 * This link should be to the CMS back end (applies to WP & Joomla).
242 * An HTML string containing a link to the given path.
244 public static function url(
251 $forceBackend = FALSE
253 $query = self
::makeQueryString($query);
255 // Legacy handling for when the system passes around html escaped strings
256 if (strstr($query, '&')) {
257 $query = html_entity_decode($query);
260 // Extract fragment from path or query if munged together
261 if ($query && strstr($query, '#')) {
262 list($path, $fragment) = explode('#', $query);
264 if ($path && strstr($path, '#')) {
265 list($path, $fragment) = explode('#', $path);
268 // Extract query from path if munged together
269 if ($path && strstr($path, '?')) {
270 list($path, $extraQuery) = explode('?', $path);
271 $query = $extraQuery . ($query ?
"&$query" : '');
274 $config = CRM_Core_Config
::singleton();
275 $url = $config->userSystem
->url($path, $query, $absolute, $fragment, $frontend, $forceBackend, $htmlize);
278 $url = htmlentities($url);
285 * Generates an extern url.
287 * @param string $path
288 * The extern path, such as "extern/url".
289 * @param string $query
290 * A query string to append to the link.
291 * @param string $fragment
292 * A fragment identifier (named anchor) to append to the link.
293 * @param bool $absolute
294 * Whether to force the output to be an absolute link (beginning with a
295 * URI-scheme such as 'http:').
297 * NULL to autodetect. TRUE to force to SSL.
299 * @return string rawencoded URL.
301 public static function externUrl($path = NULL, $query = NULL, $fragment = NULL, $absolute = TRUE, $isSSL = NULL) {
302 $query = self
::makeQueryString($query);
304 $url = Civi
::paths()->getUrl("[civicrm.root]/{$path}.php", $absolute ?
'absolute' : 'relative', $isSSL)
305 . ($query ?
"?$query" : "")
306 . ($fragment ?
"#$fragment" : "");
308 $parsedUrl = CRM_Utils_Url
::parseUrl($url);
309 $event = \Civi\Core\Event\GenericHookEvent
::create([
310 'url' => &$parsedUrl,
313 'fragment' => $fragment,
314 'absolute' => $absolute,
317 Civi
::dispatcher()->dispatch('hook_civicrm_alterExternUrl', $event);
318 return urldecode(CRM_Utils_Url
::unparseUrl($event->url
));
322 * Perform any current conversions/migrations on the extern URL.
324 * @param \Civi\Core\Event\GenericHookEvent $e
325 * @see CRM_Utils_Hook::alterExternUrl
327 public static function migrateExternUrl(\Civi\Core\Event\GenericHookEvent
$e) {
330 * $mkRouteUri is a small adapter to return generated URL as a "UriInterface".
331 * @param string $path
332 * @param string $query
333 * @return \Psr\Http\Message\UriInterface
335 $mkRouteUri = function ($path, $query) use ($e) {
336 $urlTxt = CRM_Utils_System
::url($path, $query, $e->absolute
, $e->fragment
, FALSE, TRUE);
337 if ($e->isSSL ||
($e->isSSL
=== NULL && \CRM_Utils_System
::isSSL())) {
338 $urlTxt = str_replace('http://', 'https://', $urlTxt);
340 return CRM_Utils_Url
::parseUrl($urlTxt);
343 switch (Civi
::settings()->get('defaultExternUrl') . ':' . $e->path
) {
344 case 'router:extern/open':
345 $e->url
= $mkRouteUri('civicrm/mailing/open', preg_replace('/(^|&)q=/', '\1qid=', $e->query
));
348 case 'router:extern/url':
349 $e->url
= $mkRouteUri('civicrm/mailing/url', $e->query
);
352 // Otherwise, keep the default.
358 * @see \CRM_Utils_System::currentPath
360 * @return string|null
362 public static function getUrlPath() {
363 CRM_Core_Error
::deprecatedFunctionWarning('CRM_Utils_System::currentPath');
364 return self
::currentPath();
370 * @param string $text
371 * @param string $path
372 * @param string|array $query
373 * @param bool $absolute
374 * @param string $fragment
375 * @param bool $htmlize
376 * @param bool $frontend
377 * @param bool $forceBackend
381 public static function href(
382 $text, $path = NULL, $query = NULL, $absolute = TRUE,
383 $fragment = NULL, $htmlize = TRUE, $frontend = FALSE, $forceBackend = FALSE
385 $url = self
::url($path, $query, $absolute, $fragment, $htmlize, $frontend, $forceBackend);
386 return "<a href=\"$url\">$text</a>";
390 * Path of the current page e.g. 'civicrm/contact/view'
392 * @return string|null
393 * the current menu path
395 public static function currentPath() {
396 $config = CRM_Core_Config
::singleton();
397 return isset($_GET[$config->userFrameworkURLVar
]) ?
trim($_GET[$config->userFrameworkURLVar
], '/') : NULL;
401 * Called from a template to compose a url.
403 * @param array $params
404 * List of parameters.
409 public static function crmURL($params) {
410 $p = $params['p'] ??
NULL;
412 $p = self
::currentPath();
417 CRM_Utils_Array
::value('q', $params),
418 CRM_Utils_Array
::value('a', $params, FALSE),
419 CRM_Utils_Array
::value('f', $params),
420 CRM_Utils_Array
::value('h', $params, TRUE),
421 CRM_Utils_Array
::value('fe', $params, FALSE),
422 CRM_Utils_Array
::value('fb', $params, FALSE)
427 * Sets the title of the page.
429 * @param string $title
430 * Document title - plain text only
431 * @param string $pageTitle
432 * Page title (if different) - may include html
434 public static function setTitle($title, $pageTitle = NULL) {
435 self
::$title = $title;
436 $config = CRM_Core_Config
::singleton();
437 return $config->userSystem
->setTitle($title, $pageTitle);
441 * Figures and sets the userContext.
443 * Uses the referrer if valid else uses the default.
445 * @param array $names
446 * Referrer should match any str in this array.
447 * @param string $default
448 * (optional) The default userContext if no match found.
450 public static function setUserContext($names, $default = NULL) {
453 $session = CRM_Core_Session
::singleton();
454 $referer = $_SERVER['HTTP_REFERER'] ??
NULL;
456 if ($referer && !empty($names)) {
457 foreach ($names as $name) {
458 if (strstr($referer, $name)) {
466 $session->pushUserContext($url);
471 * Gets a class name for an object.
473 * @param object $object
474 * Object whose class name is needed.
477 * The class name of the object.
479 public static function getClassName($object) {
480 return get_class($object);
484 * Redirect to another URL.
487 * The URL to provide to the browser via the Location header.
488 * @param array $context
489 * Optional additional information for the hook.
491 public static function redirect($url = NULL, $context = []) {
493 $url = self
::url('civicrm/dashboard', 'reset=1');
495 // replace the & characters with &
496 // this is kinda hackish but not sure how to do it right
497 $url = str_replace('&', '&', $url);
499 $context['output'] = $_GET['snippet'] ??
NULL;
501 $parsedUrl = CRM_Utils_Url
::parseUrl($url);
502 CRM_Utils_Hook
::alterRedirect($parsedUrl, $context);
503 $url = CRM_Utils_Url
::unparseUrl($parsedUrl);
505 // If we are in a json context, respond appropriately
506 if ($context['output'] === 'json') {
507 CRM_Core_Page_AJAX
::returnJsonResponse([
508 'status' => 'redirect',
509 'userContext' => $url,
513 self
::setHttpHeader('Location', $url);
518 * Redirect to another URL using JavaScript.
520 * Use an html based file with javascript embedded to redirect to another url
521 * This prevent the too many redirect errors emitted by various browsers
524 * (optional) The destination URL.
525 * @param string $title
526 * (optional) The page title to use for the redirect page.
527 * @param string $message
528 * (optional) The message to provide in the body of the redirect page.
530 public static function jsRedirect(
536 $url = self
::url('civicrm/dashboard', 'reset=1');
540 $title = ts('CiviCRM task in progress');
544 $message = ts('A long running CiviCRM task is currently in progress. This message will be refreshed till the task is completed');
547 // replace the & characters with &
548 // this is kinda hackish but not sure how to do it right
549 $url = str_replace('&', '&', $url);
551 $template = CRM_Core_Smarty
::singleton();
552 $template->assign('redirectURL', $url);
553 $template->assign('title', $title);
554 $template->assign('message', $message);
556 $html = $template->fetch('CRM/common/redirectJS.tpl');
564 * Get the base URL of the system.
568 public static function baseURL() {
569 $config = CRM_Core_Config
::singleton();
570 return $config->userFrameworkBaseURL
;
574 * Authenticate or abort.
576 * @param string $message
581 public static function authenticateAbort($message, $abort) {
595 * (optional) Whether to exit; defaults to true.
599 public static function authenticateKey($abort = TRUE) {
600 // also make sure the key is sent and is valid
601 $key = trim(CRM_Utils_Array
::value('key', $_REQUEST));
603 $docAdd = "More info at: " . CRM_Utils_System
::docURL2('sysadmin/setup/jobs', TRUE);
606 return self
::authenticateAbort(
607 "ERROR: You need to send a valid key to execute this file. " . $docAdd . "\n",
612 $siteKey = defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY
: NULL;
614 if (!$siteKey ||
empty($siteKey)) {
615 return self
::authenticateAbort(
616 "ERROR: You need to set a valid site key in civicrm.settings.php. " . $docAdd . "\n",
621 if (strlen($siteKey) < 8) {
622 return self
::authenticateAbort(
623 "ERROR: Site key needs to be greater than 7 characters in civicrm.settings.php. " . $docAdd . "\n",
628 if ($key !== $siteKey) {
629 return self
::authenticateAbort(
630 "ERROR: Invalid key value sent. " . $docAdd . "\n",
639 * Authenticate script.
642 * @param string $name
643 * @param string $pass
644 * @param bool $storeInSession
645 * @param bool $loadCMSBootstrap
646 * @param bool $requireKey
650 public static function authenticateScript($abort = TRUE, $name = NULL, $pass = NULL, $storeInSession = TRUE, $loadCMSBootstrap = TRUE, $requireKey = TRUE) {
651 // auth to make sure the user has a login/password to do a shell operation
652 // later on we'll link this to acl's
654 $name = trim(CRM_Utils_Array
::value('name', $_REQUEST));
655 $pass = trim(CRM_Utils_Array
::value('pass', $_REQUEST));
658 // its ok to have an empty password
660 return self
::authenticateAbort(
661 "ERROR: You need to send a valid user name and password to execute this file\n",
666 if ($requireKey && !self
::authenticateKey($abort)) {
670 $result = CRM_Utils_System
::authenticate($name, $pass, $loadCMSBootstrap);
672 return self
::authenticateAbort(
673 "ERROR: Invalid username and/or password\n",
677 elseif ($storeInSession) {
678 // lets store contact id and user id in session
679 list($userID, $ufID, $randomNumber) = $result;
680 if ($userID && $ufID) {
681 $config = CRM_Core_Config
::singleton();
682 $config->userSystem
->setUserSession([$userID, $ufID]);
685 return self
::authenticateAbort(
686 "ERROR: Unexpected error, could not match userID and contactID",
696 * Authenticate the user against the uf db.
698 * In case of successful authentication, returns an array consisting of
699 * (contactID, ufID, unique string). Returns FALSE if authentication is
702 * @param string $name
704 * @param string $password
706 * @param bool $loadCMSBootstrap
707 * @param string $realPath
709 * @return false|array
711 public static function authenticate($name, $password, $loadCMSBootstrap = FALSE, $realPath = NULL) {
712 $config = CRM_Core_Config
::singleton();
714 /* Before we do any loading, let's start the session and write to it.
715 * We typically call authenticate only when we need to bootstrap the CMS
716 * directly via Civi and hence bypass the normal CMS auth and bootstrap
717 * process typically done in CLI and cron scripts. See: CRM-12648
719 * Q: Can we move this to the userSystem class so that it can be tuned
720 * per-CMS? For example, when dealing with UnitTests UF, does it need to
721 * do this session write since the original issue was for Drupal.
723 $session = CRM_Core_Session
::singleton();
724 $session->set('civicrmInitSession', TRUE);
726 return $config->userSystem
->authenticate($name, $password, $loadCMSBootstrap, $realPath);
730 * Set a message in the UF to display to a user.
732 * @param string $message
733 * The message to set.
735 public static function setUFMessage($message) {
736 $config = CRM_Core_Config
::singleton();
737 return $config->userSystem
->setMessage($message);
741 * Determine whether a value is null-ish.
743 * @param mixed $value
744 * The value to check for null.
748 public static function isNull($value) {
749 // FIXME: remove $value = 'null' string test when we upgrade our DAO code to handle passing null in a better way.
750 if (!isset($value) ||
$value === NULL ||
$value === '' ||
$value === 'null') {
753 if (is_array($value)) {
754 // @todo Reuse of the $value variable = asking for trouble.
755 foreach ($value as $key => $value) {
756 if (in_array($key, CRM_Core_DAO
::acceptedSQLOperators(), TRUE) ||
!self
::isNull($value)) {
766 * Obscure all but the last few digits of a credit card number.
768 * @param string $number
769 * The credit card number to obscure.
771 * (optional) The number of digits to preserve unmodified.
774 * The obscured credit card number.
776 public static function mungeCreditCard($number, $keep = 4) {
777 $number = trim($number);
778 if (empty($number)) {
781 $replace = str_repeat('*', strlen($number) - $keep);
782 return substr_replace($number, $replace, 0, -$keep);
786 * Determine which PHP modules are loaded.
790 private static function parsePHPModules() {
792 phpinfo(INFO_MODULES
);
793 $s = ob_get_contents();
796 $s = strip_tags($s, '<h2><th><td>');
797 $s = preg_replace('/<th[^>]*>([^<]+)<\/th>/', "<info>\\1</info>", $s);
798 $s = preg_replace('/<td[^>]*>([^<]+)<\/td>/', "<info>\\1</info>", $s);
799 $vTmp = preg_split('/(<h2>[^<]+<\/h2>)/', $s, -1, PREG_SPLIT_DELIM_CAPTURE
);
801 for ($i = 1; $i < count($vTmp); $i++
) {
802 if (preg_match('/<h2>([^<]+)<\/h2>/', $vTmp[$i], $vMat)) {
803 $vName = trim($vMat[1]);
804 $vTmp2 = explode("\n", $vTmp[$i +
1]);
805 foreach ($vTmp2 as $vOne) {
806 $vPat = '<info>([^<]+)<\/info>';
807 $vPat3 = "/$vPat\s*$vPat\s*$vPat/";
808 $vPat2 = "/$vPat\s*$vPat/";
810 if (preg_match($vPat3, $vOne, $vMat)) {
811 $vModules[$vName][trim($vMat[1])] = [trim($vMat[2]), trim($vMat[3])];
814 elseif (preg_match($vPat2, $vOne, $vMat)) {
815 $vModules[$vName][trim($vMat[1])] = trim($vMat[2]);
824 * Get a setting from a loaded PHP module.
826 * @param string $pModuleName
827 * @param string $pSetting
831 public static function getModuleSetting($pModuleName, $pSetting) {
832 $vModules = self
::parsePHPModules();
833 return $vModules[$pModuleName][$pSetting];
837 * Do something no-one bothered to document.
839 * @param string $title
842 * @return mixed|string
844 public static function memory($title = NULL) {
847 $pid = posix_getpid();
850 $memory = str_replace("\n", '', shell_exec("ps -p" . $pid . " -o rss="));
851 $memory .= ", " . time();
853 CRM_Core_Error
::debug_var($title, $memory);
859 * Download something or other.
861 * @param string $name
862 * @param string $mimeType
863 * @param string $buffer
865 * @param bool $output
866 * @param string $disposition
868 public static function download(
869 $name, $mimeType, &$buffer,
872 $disposition = 'attachment'
874 $now = gmdate('D, d M Y H:i:s') . ' GMT';
876 self
::setHttpHeader('Content-Type', $mimeType);
877 self
::setHttpHeader('Expires', $now);
879 // lem9 & loic1: IE needs specific headers
880 $isIE = empty($_SERVER['HTTP_USER_AGENT']) ?
FALSE : strstr($_SERVER['HTTP_USER_AGENT'], 'MSIE');
882 $fileString = "filename=\"{$name}.{$ext}\"";
885 $fileString = "filename=\"{$name}\"";
888 self
::setHttpHeader("Content-Disposition", "inline; $fileString");
889 self
::setHttpHeader('Cache-Control', 'must-revalidate, post-check=0, pre-check=0');
890 self
::setHttpHeader('Pragma', 'public');
893 self
::setHttpHeader("Content-Disposition", "$disposition; $fileString");
894 self
::setHttpHeader('Pragma', 'no-cache');
904 * Gather and print (and possibly log) amount of used memory.
906 * @param string $title
908 * (optional) Whether to log the memory usage information.
910 public static function xMemory($title = NULL, $log = FALSE) {
911 $mem = (float ) xdebug_memory_usage() / (float ) (1024);
912 $mem = number_format($mem, 5) . ", " . time();
914 echo "<p>$title: $mem<p>";
916 CRM_Core_Error
::debug_var($title, $mem);
919 echo "<p>$title: $mem<p>";
925 * Take a URL (or partial URL) and make it better.
927 * Currently, URLs pass straight through unchanged unless they are "seriously
928 * malformed" (see http://us2.php.net/parse_url).
931 * The URL to operate on.
936 public static function fixURL($url) {
937 $components = parse_url($url);
943 // at some point we'll add code here to make sure the url is not
944 // something that will mess up, so we need to clean it up here
949 * Make sure a callback is valid in the current context.
951 * @param string $callback
952 * Name of the function to check.
956 public static function validCallback($callback) {
957 if (self
::$_callbacks === NULL) {
958 self
::$_callbacks = [];
961 if (!array_key_exists($callback, self
::$_callbacks)) {
962 if (strpos($callback, '::') !== FALSE) {
963 list($className, $methodName) = explode('::', $callback);
964 $fileName = str_replace('_', DIRECTORY_SEPARATOR
, $className) . '.php';
965 // ignore errors if any
966 @include_once
$fileName;
967 if (!class_exists($className)) {
968 self
::$_callbacks[$callback] = FALSE;
971 // instantiate the class
972 $object = new $className();
973 if (!method_exists($object, $methodName)) {
974 self
::$_callbacks[$callback] = FALSE;
977 self
::$_callbacks[$callback] = TRUE;
982 self
::$_callbacks[$callback] = function_exists($callback);
985 return self
::$_callbacks[$callback];
989 * Like PHP's built-in explode(), but always return an array of $limit items.
991 * This serves as a wrapper to the PHP explode() function. In the event that
992 * PHP's explode() returns an array with fewer than $limit elements, pad
993 * the end of the array with NULLs.
995 * @param string $separator
996 * @param string $string
1001 public static function explode($separator, $string, $limit) {
1002 $result = explode($separator, $string, $limit);
1003 for ($i = count($result); $i < $limit; $i++
) {
1012 * @param string $url
1014 * @param bool $addCookie
1019 public static function checkURL($url, $addCookie = FALSE) {
1020 // make a GET request to $url
1021 $ch = curl_init($url);
1023 curl_setopt($ch, CURLOPT_COOKIE
, http_build_query($_COOKIE));
1025 // it's quite alright to use a self-signed cert
1026 curl_setopt($ch, CURLOPT_SSL_VERIFYPEER
, 0);
1028 // lets capture the return stuff rather than echo
1029 curl_setopt($ch, CURLOPT_RETURNTRANSFER
, TRUE);
1031 // CRM-13227, CRM-14744: only return the SSL error status
1032 return (curl_exec($ch) !== FALSE);
1036 * Assert that we are running on a particular PHP version.
1039 * The major version of PHP that is required.
1040 * @param bool $abort
1041 * (optional) Whether to fatally abort if the version requirement is not
1042 * met. Defaults to TRUE.
1045 * Returns TRUE if the requirement is met, FALSE if the requirement is not
1046 * met and we're not aborting due to the failed requirement. If $abort is
1047 * TRUE and the requirement fails, this function does not return.
1049 * @throws CRM_Core_Exception
1051 public static function checkPHPVersion($ver = 5, $abort = TRUE) {
1052 $phpVersion = substr(PHP_VERSION
, 0, 1);
1053 if ($phpVersion >= $ver) {
1058 throw new CRM_Core_Exception(ts('This feature requires PHP Version %1 or greater',
1068 * @param string $url
1070 * @return null|string
1072 public static function urlEncode($url) {
1073 CRM_Core_Error
::deprecatedFunctionWarning('urlEncode');
1074 $items = parse_url($url);
1075 if ($items === FALSE) {
1079 if (empty($items['query'])) {
1083 $items['query'] = urlencode($items['query']);
1085 $url = $items['scheme'] . '://';
1086 if (!empty($items['user'])) {
1087 $url .= "{$items['user']}:{$items['pass']}@";
1090 $url .= $items['host'];
1091 if (!empty($items['port'])) {
1092 $url .= ":{$items['port']}";
1095 $url .= "{$items['path']}?{$items['query']}";
1096 if (!empty($items['fragment'])) {
1097 $url .= "#{$items['fragment']}";
1104 * Return the running civicrm version.
1109 * @throws CRM_Core_Exception
1111 public static function version() {
1115 $verFile = implode(DIRECTORY_SEPARATOR
,
1116 [dirname(__FILE__
), '..', '..', 'xml', 'version.xml']
1118 if (file_exists($verFile)) {
1119 $str = file_get_contents($verFile);
1120 $xmlObj = simplexml_load_string($str);
1121 $version = (string) $xmlObj->version_no
;
1125 if (!CRM_Utils_System
::isVersionFormatValid($version)) {
1126 throw new CRM_Core_Exception('Unknown codebase version.');
1134 * Gives the first two parts of the version string E.g. 6.1.
1138 public static function majorVersion() {
1139 list($a, $b) = explode('.', self
::version());
1144 * Determines whether a string is a valid CiviCRM version string.
1146 * @param string $version
1147 * Version string to be checked.
1151 public static function isVersionFormatValid($version) {
1152 return preg_match("/^(\d{1,2}\.){2,3}(\d{1,2}|(alpha|beta)\d{1,2})(\.upgrade)?$/", $version);
1156 * Wraps or emulates PHP's getallheaders() function.
1158 public static function getAllHeaders() {
1159 if (function_exists('getallheaders')) {
1160 return getallheaders();
1163 // emulate get all headers
1164 // http://www.php.net/manual/en/function.getallheaders.php#66335
1166 foreach ($_SERVER as $name => $value) {
1167 if (substr($name, 0, 5) == 'HTTP_') {
1168 $headers[str_replace(' ',
1170 ucwords(strtolower(str_replace('_',
1182 * Get request headers.
1184 * @return array|false
1186 public static function getRequestHeaders() {
1187 if (function_exists('apache_request_headers')) {
1188 return apache_request_headers();
1196 * Determine whether this is an SSL request.
1198 * Note that we inline this function in install/civicrm.php, so if you change
1199 * this function, please go and change the code in the install script as well.
1201 public static function isSSL() {
1202 return !empty($_SERVER['HTTPS']) && strtolower($_SERVER['HTTPS']) != 'off';
1208 * @param bool|FALSE $abort
1210 * @throws \CRM_Core_Exception
1212 public static function redirectToSSL($abort = FALSE) {
1213 $config = CRM_Core_Config
::singleton();
1214 $req_headers = self
::getRequestHeaders();
1215 // FIXME: Shouldn't the X-Forwarded-Proto check be part of CRM_Utils_System::isSSL()?
1216 if (Civi
::settings()->get('enableSSL') &&
1218 strtolower(CRM_Utils_Array
::value('X_FORWARDED_PROTO', $req_headers)) != 'https'
1220 // ensure that SSL is enabled on a civicrm url (for cookie reasons etc)
1221 $url = "https://{$_SERVER['HTTP_HOST']}{$_SERVER['REQUEST_URI']}";
1222 // @see https://lab.civicrm.org/dev/core/issues/425 if you're seeing this message.
1223 Civi
::log()->warning('CiviCRM thinks site is not SSL, redirecting to {url}', ['url' => $url]);
1224 if (!self
::checkURL($url, TRUE)) {
1226 throw new CRM_Core_Exception('HTTPS is not set up on this machine');
1229 CRM_Core_Session
::setStatus(ts('HTTPS is not set up on this machine'), ts('Warning'), 'alert');
1230 // admin should be the only one following this
1231 // since we dont want the user stuck in a bad place
1235 CRM_Utils_System
::redirect($url);
1240 * Get logged in user's IP address.
1242 * Get IP address from HTTP REMOTE_ADDR header. If the CMS is Drupal then use
1243 * the Drupal function as this also handles reverse proxies (based on proper
1244 * configuration in settings.php)
1246 * @param bool $strictIPV4
1247 * (optional) Whether to return only IPv4 addresses.
1250 * IP address of logged in user.
1252 public static function ipAddress($strictIPV4 = TRUE) {
1253 $address = $_SERVER['REMOTE_ADDR'] ??
NULL;
1255 $config = CRM_Core_Config
::singleton();
1256 if ($config->userSystem
->is_drupal
&& function_exists('ip_address')) {
1257 // drupal function handles the server being behind a proxy securely. We still have legacy ipn methods
1258 // that reach this point without bootstrapping hence the check that the fn exists
1259 $address = ip_address();
1263 if ($address == '::1') {
1264 $address = '127.0.0.1';
1267 // when we need to have strictly IPV4 ip address
1268 // convert ipV6 to ipV4
1270 // this converts 'IPV4 mapped IPV6 address' to IPV4
1271 if (filter_var($address, FILTER_VALIDATE_IP
, FILTER_FLAG_IPV6
) && strstr($address, '::ffff:')) {
1272 $address = ltrim($address, '::ffff:');
1280 * Get the referring / previous page URL.
1283 * The previous page URL
1285 public static function refererPath() {
1286 return $_SERVER['HTTP_REFERER'] ??
NULL;
1290 * Get the documentation base URL.
1293 * Base URL of the CRM documentation.
1295 public static function getDocBaseURL() {
1296 // FIXME: move this to configuration at some stage
1297 return 'https://docs.civicrm.org/';
1301 * Returns wiki (alternate) documentation URL base.
1306 public static function getWikiBaseURL() {
1307 // FIXME: move this to configuration at some stage
1308 return 'http://wiki.civicrm.org/confluence/display/CRMDOC/';
1312 * Returns URL or link to documentation page, based on provided parameters.
1314 * For use in PHP code.
1315 * WARNING: Always returns URL, if ts function is not defined ($URLonly has
1318 * @param string $page
1319 * Title of documentation wiki page.
1320 * @param bool $URLonly
1321 * (optional) Whether to return URL only or full HTML link (default).
1322 * @param string $text
1323 * (optional) Text of HTML link (no effect if $URLonly = false).
1324 * @param string $title
1325 * (optional) Tooltip text for HTML link (no effect if $URLonly = false)
1326 * @param string $style
1327 * (optional) Style attribute value for HTML link (no effect if $URLonly = false)
1329 * @param null $resource
1332 * URL or link to documentation page, based on provided parameters.
1334 public static function docURL2($page, $URLonly = FALSE, $text = NULL, $title = NULL, $style = NULL, $resource = NULL) {
1335 // if ts function doesn't exist, it means that CiviCRM hasn't been fully initialised yet -
1336 // return just the URL, no matter what other parameters are defined
1337 if (!function_exists('ts')) {
1338 if ($resource == 'wiki') {
1339 $docBaseURL = self
::getWikiBaseURL();
1342 $docBaseURL = self
::getDocBaseURL();
1343 $page = self
::formatDocUrl($page);
1345 return $docBaseURL . str_replace(' ', '+', $page);
1350 'URLonly' => $URLonly,
1354 'resource' => $resource,
1356 return self
::docURL($params);
1361 * Returns URL or link to documentation page, based on provided parameters.
1363 * For use in templates code.
1365 * @param array $params
1366 * An array of parameters (see CRM_Utils_System::docURL2 method for names)
1368 * @return null|string
1369 * URL or link to documentation page, based on provided parameters.
1371 public static function docURL($params) {
1373 if (!isset($params['page'])) {
1377 if (CRM_Utils_Array
::value('resource', $params) == 'wiki') {
1378 $docBaseURL = self
::getWikiBaseURL();
1381 $docBaseURL = self
::getDocBaseURL();
1382 $params['page'] = self
::formatDocUrl($params['page']);
1385 if (!isset($params['title']) or $params['title'] === NULL) {
1386 $params['title'] = ts('Opens documentation in a new window.');
1389 if (!isset($params['text']) or $params['text'] === NULL) {
1390 $params['text'] = ts('(Learn more...)');
1393 if (!isset($params['style']) ||
$params['style'] === NULL) {
1397 $style = "style=\"{$params['style']}\"";
1400 $link = $docBaseURL . str_replace(' ', '+', $params['page']);
1402 if (isset($params['URLonly']) && $params['URLonly'] == TRUE) {
1406 return "<a href=\"{$link}\" $style target=\"_blank\" class=\"crm-doc-link no-popup\" title=\"{$params['title']}\">{$params['text']}</a>";
1411 * Add language and version parameters to the doc url.
1413 * Note that this function may run before CiviCRM is initialized and so should not call ts() or perform any db lookups.
1418 public static function formatDocUrl($url) {
1419 return preg_replace('#^(user|sysadmin|dev)/#', '\1/en/latest/', $url);
1423 * Exit with provided exit code.
1425 * @param int $status
1426 * (optional) Code with which to exit.
1428 * @param array $testParameters
1430 public static function civiExit($status = 0, $testParameters = []) {
1432 if (CIVICRM_UF
=== 'UnitTests') {
1433 throw new CRM_Core_Exception_PrematureExitException('civiExit called', $testParameters);
1436 http_response_code(500);
1438 // move things to CiviCRM cache as needed
1439 CRM_Core_Session
::storeSessionObjects();
1441 if (Civi\Core\Container
::isContainerBooted()) {
1442 Civi
::dispatcher()->dispatch('civi.core.exit');
1445 $userSystem = CRM_Core_Config
::singleton()->userSystem
;
1446 if (is_callable([$userSystem, 'onCiviExit'])) {
1447 $userSystem->onCiviExit();
1453 * Reset the various system caches and some important static variables.
1455 public static function flushCache() {
1456 // flush out all cache entries so we can reload new data
1457 // a bit aggressive, but livable for now
1458 CRM_Utils_Cache
::singleton()->flush();
1460 // Traditionally, systems running on memory-backed caches were quite
1461 // zealous about destroying *all* memory-backed caches during a flush().
1462 // These flushes simulate that legacy behavior. However, they should probably
1463 // be removed at some point.
1464 $localDrivers = ['CRM_Utils_Cache_ArrayCache', 'CRM_Utils_Cache_NoCache'];
1465 if (Civi\Core\Container
::isContainerBooted()
1466 && !in_array(get_class(CRM_Utils_Cache
::singleton()), $localDrivers)) {
1467 Civi
::cache('long')->flush();
1468 Civi
::cache('settings')->flush();
1469 Civi
::cache('js_strings')->flush();
1470 Civi
::cache('community_messages')->flush();
1471 Civi
::cache('groups')->flush();
1472 Civi
::cache('navigation')->flush();
1473 Civi
::cache('customData')->flush();
1474 Civi
::cache('contactTypes')->clear();
1475 Civi
::cache('metadata')->clear();
1476 CRM_Extension_System
::singleton()->getCache()->flush();
1477 CRM_Cxn_CiviCxnHttp
::singleton()->getCache()->flush();
1480 // also reset the various static memory caches
1482 // reset the memory or array cache
1483 Civi
::cache('fields')->flush();
1486 CRM_ACL_BAO_Cache
::resetCache();
1488 // clear asset builder folder
1489 \Civi
::service('asset_builder')->clear(FALSE);
1491 // reset various static arrays used here
1492 CRM_Contact_BAO_Contact
::$_importableFields = CRM_Contact_BAO_Contact
::$_exportableFields
1493 = CRM_Contribute_BAO_Contribution
::$_importableFields
1494 = CRM_Contribute_BAO_Contribution
::$_exportableFields
1495 = CRM_Pledge_BAO_Pledge
::$_exportableFields
1496 = CRM_Core_BAO_CustomField
::$_importFields
1497 = CRM_Core_DAO
::$_dbColumnValueCache = NULL;
1499 CRM_Core_OptionGroup
::flushAll();
1500 CRM_Utils_PseudoConstant
::flushAll();
1504 * Load CMS bootstrap.
1506 * @param array $params
1507 * Array with uid name and pass
1508 * @param bool $loadUser
1509 * Boolean load user or not.
1510 * @param bool $throwError
1511 * @param string $realPath
1513 public static function loadBootStrap($params = [], $loadUser = TRUE, $throwError = TRUE, $realPath = NULL) {
1514 if (!is_array($params)) {
1517 $config = CRM_Core_Config
::singleton();
1518 $result = $config->userSystem
->loadBootStrap($params, $loadUser, $throwError, $realPath);
1519 if (is_callable([$config->userSystem
, 'setMySQLTimeZone'])) {
1520 $config->userSystem
->setMySQLTimeZone();
1528 * @return mixed|string
1530 public static function baseCMSURL() {
1531 static $_baseURL = NULL;
1533 $config = CRM_Core_Config
::singleton();
1534 $_baseURL = $userFrameworkBaseURL = $config->userFrameworkBaseURL
;
1536 if ($config->userFramework
== 'Joomla') {
1538 // we need to remove the administrator/ from the end
1539 $_baseURL = str_replace("/administrator/", "/", $userFrameworkBaseURL);
1543 global $civicrm_root;
1544 if (strpos($civicrm_root,
1545 DIRECTORY_SEPARATOR
. 'sites' .
1546 DIRECTORY_SEPARATOR
. 'all' .
1547 DIRECTORY_SEPARATOR
. 'modules'
1550 $startPos = strpos($civicrm_root,
1551 DIRECTORY_SEPARATOR
. 'sites' . DIRECTORY_SEPARATOR
1553 $endPos = strpos($civicrm_root,
1554 DIRECTORY_SEPARATOR
. 'modules' . DIRECTORY_SEPARATOR
1556 if ($startPos && $endPos) {
1557 // if component is in sites/SITENAME/modules
1558 $siteName = substr($civicrm_root,
1560 $endPos - $startPos - 7
1563 $_baseURL = $userFrameworkBaseURL . "sites/$siteName/";
1572 * Given a URL, return a relative URL if possible.
1574 * @param string $url
1578 public static function relativeURL($url) {
1579 CRM_Core_Error
::deprecatedFunctionWarning('url');
1580 // check if url is relative, if so return immediately
1581 if (substr($url, 0, 4) != 'http') {
1585 // make everything relative from the baseFilePath
1586 $baseURL = self
::baseCMSURL();
1588 // check if baseURL is a substr of $url, if so
1589 // return rest of string
1590 if (substr($url, 0, strlen($baseURL)) == $baseURL) {
1591 return substr($url, strlen($baseURL));
1594 // return the original value
1599 * Produce an absolute URL from a possibly-relative URL.
1601 * @param string $url
1602 * @param bool $removeLanguagePart
1606 public static function absoluteURL($url, $removeLanguagePart = FALSE) {
1607 CRM_Core_Error
::deprecatedFunctionWarning('url');
1608 // check if url is already absolute, if so return immediately
1609 if (substr($url, 0, 4) == 'http') {
1613 // make everything absolute from the baseFileURL
1614 $baseURL = self
::baseCMSURL();
1616 //CRM-7622: drop the language from the URL if requested (and it’s there)
1617 $config = CRM_Core_Config
::singleton();
1618 if ($removeLanguagePart) {
1619 $baseURL = self
::languageNegotiationURL($baseURL, FALSE, TRUE);
1622 return $baseURL . $url;
1626 * Clean url, replaces first '&' with '?'.
1628 * @param string $url
1633 public static function cleanUrl($url) {
1638 if ($pos = strpos($url, '&')) {
1639 $url = substr_replace($url, '?', $pos, 1);
1646 * Format the url as per language Negotiation.
1648 * @param string $url
1650 * @param bool $addLanguagePart
1651 * @param bool $removeLanguagePart
1656 public static function languageNegotiationURL(
1658 $addLanguagePart = TRUE,
1659 $removeLanguagePart = FALSE
1661 return CRM_Core_Config
::singleton()->userSystem
->languageNegotiationURL($url, $addLanguagePart, $removeLanguagePart);
1665 * Append the contents of an 'extra' smarty template file.
1667 * It must be present in the custom template directory. This does not work if there are
1668 * multiple custom template directories
1670 * @param string $fileName
1671 * The name of the tpl file that we are processing.
1672 * @param string $content
1673 * The current content string. May be modified by this function.
1674 * @param string $overideFileName
1675 * (optional) Sent by contribution/event reg/profile pages which uses a id
1676 * specific extra file name if present.
1678 public static function appendTPLFile(
1681 $overideFileName = NULL
1683 $template = CRM_Core_Smarty
::singleton();
1684 if ($overideFileName) {
1685 $additionalTPLFile = $overideFileName;
1688 $additionalTPLFile = str_replace('.tpl', '.extra.tpl', $fileName);
1691 if ($template->template_exists($additionalTPLFile)) {
1692 $content .= $template->fetch($additionalTPLFile);
1697 * Get a list of all files that are found within the directories.
1699 * Files must be the result of appending the provided relative path to
1700 * each component of the PHP include path.
1702 * @author Ken Zalewski
1704 * @param string $relpath
1705 * A relative path, typically pointing to a directory with multiple class
1709 * An array of files that exist in one or more of the directories that are
1710 * referenced by the relative path when appended to each element of the PHP
1713 public static function listIncludeFiles($relpath) {
1715 $inc_dirs = explode(PATH_SEPARATOR
, get_include_path());
1716 foreach ($inc_dirs as $inc_dir) {
1717 $target_dir = $inc_dir . DIRECTORY_SEPARATOR
. $relpath;
1718 if (is_dir($target_dir)) {
1719 $cur_list = scandir($target_dir);
1720 foreach ($cur_list as $fname) {
1721 if ($fname != '.' && $fname != '..') {
1722 $file_list[$fname] = $fname;
1731 * Get a list of all "plugins".
1733 * (PHP classes that implement a piece of
1734 * functionality using a well-defined interface) that are found in a
1735 * particular CiviCRM directory (both custom and core are searched).
1737 * @author Ken Zalewski
1739 * @param string $relpath
1740 * A relative path referencing a directory that contains one or more
1742 * @param string $fext
1743 * (optional) Only files with this extension will be considered to be
1745 * @param array $skipList
1746 * (optional) List of files to skip.
1749 * List of plugins, where the plugin name is both the key and the value of
1752 public static function getPluginList($relpath, $fext = '.php', $skipList = []) {
1753 $fext_len = strlen($fext);
1755 $inc_files = CRM_Utils_System
::listIncludeFiles($relpath);
1756 foreach ($inc_files as $inc_file) {
1757 if (substr($inc_file, 0 - $fext_len) == $fext) {
1758 $plugin_name = substr($inc_file, 0, 0 - $fext_len);
1759 if (!in_array($plugin_name, $skipList)) {
1760 $plugins[$plugin_name] = $plugin_name;
1768 * Execute scheduled jobs.
1770 public static function executeScheduledJobs() {
1771 $facility = new CRM_Core_JobManager();
1772 $facility->execute(FALSE);
1774 $redirectUrl = self
::url('civicrm/admin/job', 'reset=1');
1776 CRM_Core_Session
::setStatus(
1777 ts('Scheduled jobs have been executed according to individual timing settings. Please check log for messages.'),
1778 ts('Complete'), 'success');
1780 CRM_Utils_System
::redirect($redirectUrl);
1784 * Evaluate any tokens in a URL.
1786 * @param string|FALSE $url
1788 * @return string|FALSE
1790 public static function evalUrl($url) {
1791 if (!$url ||
strpos($url, '{') === FALSE) {
1795 $config = CRM_Core_Config
::singleton();
1796 $tsLocale = CRM_Core_I18n
::getLocale();
1798 '{ver}' => CRM_Utils_System
::version(),
1799 '{uf}' => $config->userFramework
,
1800 '{php}' => phpversion(),
1801 '{sid}' => self
::getSiteID(),
1802 '{baseUrl}' => $config->userFrameworkBaseURL
,
1803 '{lang}' => $tsLocale,
1804 '{co}' => $config->defaultContactCountry
,
1806 return strtr($url, array_map('urlencode', $vars));
1811 * Returns the unique identifier for this site, as used by community messages.
1813 * SiteID will be generated if it is not already stored in the settings table.
1817 public static function getSiteID() {
1818 $sid = Civi
::settings()->get('site_id');
1820 $config = CRM_Core_Config
::singleton();
1821 $sid = md5('sid_' . (defined('CIVICRM_SITE_KEY') ? CIVICRM_SITE_KEY
: '') . '_' . $config->userFrameworkBaseURL
);
1822 civicrm_api3('Setting', 'create', ['domain_id' => 'all', 'site_id' => $sid]);
1828 * Determine whether this is a developmental system.
1832 public static function isDevelopment() {
1833 static $cache = NULL;
1834 if ($cache === NULL) {
1835 global $civicrm_root;
1836 $cache = file_exists("{$civicrm_root}/.svn") ||
file_exists("{$civicrm_root}/.git");
1842 * Is in upgrade mode.
1846 public static function isInUpgradeMode() {
1847 $args = explode('/', CRM_Utils_Array
::value('q', $_GET));
1848 $upgradeInProcess = CRM_Core_Session
::singleton()->get('isUpgradePending');
1849 if ((isset($args[1]) && $args[1] == 'upgrade') ||
$upgradeInProcess) {
1858 * Determine the standard URL for viewing or editing the specified link.
1860 * This function delegates the decision-making to (a) the hook system and
1861 * (b) the BAO system.
1863 * @param array $crudLinkSpec
1865 * - action: int, CRM_Core_Action::UPDATE or CRM_Core_Action::VIEW [default: VIEW]
1866 * - entity_table: string, eg "civicrm_contact"
1869 * @return array|NULL
1870 * NULL if unavailable, or an array. array has keys:
1876 public static function createDefaultCrudLink($crudLinkSpec) {
1877 $crudLinkSpec['action'] = CRM_Utils_Array
::value('action', $crudLinkSpec, CRM_Core_Action
::VIEW
);
1878 $daoClass = CRM_Core_DAO_AllCoreTables
::getClassForTable($crudLinkSpec['entity_table']);
1883 $baoClass = str_replace('_DAO_', '_BAO_', $daoClass);
1884 if (!class_exists($baoClass)) {
1888 $bao = new $baoClass();
1889 $bao->id
= $crudLinkSpec['entity_id'];
1890 if (!$bao->find(TRUE)) {
1895 CRM_Utils_Hook
::crudLink($crudLinkSpec, $bao, $link);
1896 if (empty($link) && is_callable([$bao, 'createDefaultCrudLink'])) {
1897 $link = $bao->createDefaultCrudLink($crudLinkSpec);
1900 if (!empty($link)) {
1901 if (!isset($link['url'])) {
1902 $link['url'] = self
::url($link['path'], $link['query'], TRUE, NULL, FALSE);
1911 * Return an HTTP Response with appropriate content and status code set.
1912 * @param \Psr\Http\Message\ResponseInterface $response
1914 public static function sendResponse(\Psr\Http\Message\ResponseInterface
$response) {
1915 $config = CRM_Core_Config
::singleton()->userSystem
->sendResponse($response);