CRM_Utils_System_Soap

Append an additional breadcrumb tag to the existing breadcrumb.

Reset an additional breadcrumb tag to the existing breadcrumb.

Append a string to the head of the html file.

Rewrite various system urls to https.

FIXME: Can this override be removed in favor of the parent?

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

Load user into session.

Immediately stop script execution and display a 401 "Access Denied" page.

Immediately stop script execution, log out the user and redirect to the home page.

Clear CMS caches related to the user registration/profile forms.

Used when updating/embedding profiles on CMS user forms.

Get the locale set in the CMS.

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

Get the absolute path to the site's base url.

Get the relative path to the sites base url.

Get CMS Version.

Format the url as per language Negotiation.

Determine the location of the CMS root.

Create a user in the CMS.

Update a user's email address in the CMS.

Check if user is logged in to the CMS.

Check if user registration is permitted.

Check if user can create passwords or is initially assigned a system-generated one.

Is a front end page being accessed.

Generally this would be a contribution form or other public page as opposed to a backoffice page (like contact edit).

Get user login URL for hosting CMS (method declared in each CMS system class)

Get the login destination string.

When this is passed in the URL the user will be directed to it after filling in the CMS form.

Determine the native ID of the CMS user.

Set the localisation from the user framework.

Set a init session with user object.

Reset any system caches that may be required for proper CiviCRM integration.

Flush css/js caches.

Add a script file.

Note: This function is not to be called directly

Add an inline script.

Note: This function is not to be called directly

Add a css file.

Note: This function is not to be called directly

Add an inline style.

Note: This function is not to be called directly

Sets the title of the page.

Return default Site Settings.

Determine the default location for file storage.

FIXME: 1. This was pulled out from a bigger function. It should be split into even smaller pieces and marked abstract. 2. This would be easier to compute by a calling a CMS API, but for whatever reason Civi gets it from config data.

Determine the location of the CiviCRM source tree.

FIXME: 1. This was pulled out from a bigger function. It should be split into even smaller pieces and marked abstract. 2. This would be easier to compute by a calling a CMS API, but for whatever reason we take the hard way.

Perform any post login activities required by the CMS.

e.g. for drupal: records a watchdog message about the new session, saves the login timestamp, calls hook_user op 'login' and generates a new session.

Set timezone in mysql so that timestamp fields show the correct time.

Get timezone from CMS.

Get timezone as a string.

Get Unique Identifier from UserFramework system (CMS).

Get User ID from UserFramework system (CMS).

Get an array of user details for a contact, containing at minimum the user ID & name.

Get currently logged in user uf id.

Get currently logged in user unique identifier - this tends to be the email address or user name.

Return a UFID (user account ID from the UserFramework / CMS system.

ID is based on the user object passed, defaulting to the logged in user if not passed.

Note that ambiguous situation occurs in CRM_Core_BAO_UFMatch::synchronize - a cleaner approach would seem to be resolving the user id before calling the function.

Note there is already a function getUFId which takes $username as a param - we could add $user as a second param to it but it seems messy - just overloading it because the name is taken.

Return a unique identifier (usually an email address or username) from the UserFramework / CMS system.

This is based on the user object passed, defaulting to the logged in user if not passed.

Note that ambiguous situation occurs in CRM_Core_BAO_UFMatch::synchronize - a cleaner approach would seem to be resolving the unique identifier before calling the function.

List modules installed in the CMS, including enabled and disabled ones.

Get Url to view user record.

Is the current user permitted to add a user.

Output code from error function.

Log error to CMS.

Append to coreResourcesList.

Modify dynamic assets.

Create CRM contacts for all existing CMS users

Send an HTTP Response base on PSR HTTP RespnseInterface response.

Given a permission string, check for access requirements

Set the email address of the user.

Swap the current UF for soap.