CRM_Utils_System

Access methods in the appropriate CMS class

Compose a new URL string from the current URL string.

Used by all the framework components, specifically, pager, sort and qfc

Get the query string and clean it up.

Strips some variables that should not be propagated, specifically variables like 'reset'. Also strips any side-affect actions (e.g. export).

This function is copied mostly verbatim from Pager.php (_getLinksUrl)

If we are using a theming system, invoke theme, else just print the content.

Generate a query string if input is an array.

Generate an internal CiviCRM URL.

Path of the current page e.g. 'civicrm/contact/view'

Get href.

What menu path are we currently on. Called for the primary tpl.

Called from a template to compose a url.

Sets the title of the page.

Figures and sets the userContext.

Uses the referrer if valid else uses the default.

Gets a class name for an object.

Redirect to another URL.

Redirect to another URL using JavaScript.

Use an html based file with javascript embedded to redirect to another url This prevent the too many redirect errors emitted by various browsers

Get the base URL of the system.

Authenticate or abort.

Authenticate key.

Authenticate script.

Authenticate the user against the uf db.

In case of successful authentication, returns an array consisting of (contactID, ufID, unique string). Returns FALSE if authentication is unsuccessful.

Set a message in the UF to display to a user.

Determine whether a value is null-ish.

Obscure all but the last few digits of a credit card number.

Get a setting from a loaded PHP module.

Do something no-one bothered to document.

Download something or other.

Gather and print (and possibly log) amount of used memory.

Take a URL (or partial URL) and make it better.

Currently, URLs pass straight through unchanged unless they are "seriously malformed" (see http://us2.php.net/parse_url).

Make sure a callback is valid in the current context.

Like PHP's built-in explode(), but always return an array of $limit items.

This serves as a wrapper to the PHP explode() function. In the event that PHP's explode() returns an array with fewer than $limit elements, pad the end of the array with NULLs.

Check url.

Assert that we are running on a particular PHP version.

Format wiki url.

Encode url.

Return the running civicrm version.

Gives the first two parts of the version string E.g. 6.1.

Determines whether a string is a valid CiviCRM version string.

Wraps or emulates PHP's getallheaders() function.

Get request headers.

Determine whether this is an SSL request.

Note that we inline this function in install/civicrm.php, so if you change this function, please go and change the code in the install script as well.

Redirect to SSL.

Get logged in user's IP address.

Get IP address from HTTP REMOTE_ADDR header. If the CMS is Drupal then use the Drupal function as this also handles reverse proxies (based on proper configuration in settings.php)

Get the referring / previous page URL.

Get the documentation base URL.

Returns wiki (alternate) documentation URL base.

Returns URL or link to documentation page, based on provided parameters.

For use in PHP code. WARNING: Always returns URL, if ts function is not defined ($URLonly has no effect).

Returns URL or link to documentation page, based on provided parameters.

For use in templates code.

Add language and version parameters to the doc url.

Note that this function may run before CiviCRM is initialized and so should not call ts() or perform any db lookups.

Exit with provided exit code.

Reset the various system caches and some important static variables.

Load CMS bootstrap.

Get Base CMS url.

Given a URL, return a relative URL if possible.

Produce an absolute URL from a possibly-relative URL.

Clean url, replaces first '&' with '?'.

Format the url as per language Negotiation.

Append the contents of an 'extra' smarty template file.

It must be present in the custom template directory. This does not work if there are multiple custom template directories

Get a list of all files that are found within the directories.

Files must be the result of appending the provided relative path to each component of the PHP include path.

Get a list of all "plugins".

(PHP classes that implement a piece of functionality using a well-defined interface) that are found in a particular CiviCRM directory (both custom and core are searched).

Execute scheduled jobs.

Evaluate any tokens in a URL.

Returns the unique identifier for this site, as used by community messages.

SiteID will be generated if it is not already stored in the settings table.

Determine whether this is a developmental system.

Is in upgrade mode.

Determine the standard URL for viewing or editing the specified link.

This function delegates the decision-making to (a) the hook system and (b) the BAO system.

Return an HTTP Response with appropriate content and status code set.

Append an additional breadcrumb tag to the existing breadcrumbs.

Reset an additional breadcrumb tag to the existing breadcrumb.

Append a string to the head of the HTML file.

Set http header.

Callback for hook_civicrm_coreResourceList.

Callback for hook_civicrm_getAssetUrl.