class CRM_Utils_System_Drupal8 extends CRM_Utils_System_DrupalBase

Drupal specific stuff goes here.

Properties

bool $is_drupal Deprecated property to check if this is a drupal install. from CRM_Utils_System_Base
bool $is_joomla Deprecated property to check if this is a joomla install. The correct method is to have functions on the UF classes for all UF specific functions and leave the codebase oblivious to the type of CMS from CRM_Utils_System_Base
bool $is_wordpress deprecated property to check if this is a wordpress install. The correct method is to have functions on the UF classes for all UF specific functions and leave the codebase oblivious to the type of CMS from CRM_Utils_System_Base
bool $supports_UF_Logging Does this CMS / UF support a CMS specific logging mechanism? from CRM_Utils_System_DrupalBase
bool $supports_form_extensions from CRM_Utils_System_Base

Methods

initialize()

No description

loadBootStrap($params = [], $loadUser = TRUE, $throwError = TRUE, $realPath = NULL)

Load drupal bootstrap.

appendBreadCrumb($breadcrumbs)

No description

resetBreadCrumb()

No description

addHTMLHead($header)

No description

mapConfigToSSL()

This function does nothing in Drupal 8. Changes to the base_url should be made in settings.php directly.

string
postURL(string $action)

Drupal 8 has a different function to get current path, hence overriding the postURL function

string
url(string $path = '', string $query = '', bool $absolute = FALSE, string $fragment = NULL, bool $frontend = FALSE, bool $forceBackend = FALSE)

No description

array|bool
authenticate(string $name, string $password, bool $loadCMSBootstrap = FALSE, string $realPath = NULL)

No description

setMessage(string $message)

No description

bool
loadUser($username)

No description

permissionDenied()

No description

logout()

In previous versions, this function was the controller for logging out. In Drupal 8, we rewrite the route to hand off logout to the standard Drupal logout controller. This function should therefore never be called.

updateCategories()

No description

string|null
getUFLocale()

No description

string|null
theme(string $content, bool $print = FALSE, bool $maintenance = FALSE)

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

string
getDefaultBlockLocation()

No description

bool|mixed|string
getAbsoluteBaseURL()

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

bool
getRelativeBaseURL()

Get the relative path to the sites base url.

string
getVersion()

No description

string
languageNegotiationURL(string $url, bool $addLanguagePart = TRUE, bool $removeLanguagePart = FALSE)

No description

string|null
cmsRootPath(string $path = NULL)

Determine the location of the CMS root.

int|bool
createUser(array $params, string $mail)

No description

updateCMSName(int $ufID, string $email)

No description

bool
isUserLoggedIn()

No description

bool
isUserRegistrationPermitted()

No description

bool
isPasswordUserGenerated()

No description

bool
isFrontEndPage()

Is a front end page being accessed.

string
getLoginURL(string $destination = '')

No description

string|NULL
getLoginDestination(CRM_Core_Form $form)

No description

getUfId(string $username)

Determine the native ID of the CMS user.

bool
setUFLocale(string $civicrm_language)

No description

setUserSession(array $data)

Set a init session with user object.

flush()

No description

bool
addScriptUrl(string $url, string $region)

Add a script file.

bool
addScript(string $code, string $region)

Add an inline script.

bool
addStyleUrl(string $url, string $region)

No description

bool
addStyle(string $code, string $region)

No description

setTitle(string $title, string|null $pageTitle = NULL)

No description

array
getDefaultSiteSettings(string $dir)

No description

array
getDefaultFileStorage()

No description

array
getCiviSourceStorage()

Determine the location of the CiviCRM source tree.

userLoginFinalize(array $params = [])

Perform any post login activities required by the UF - 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.

setMySQLTimeZone()

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

string|false|null
getTimeZoneOffset()

Get timezone from CMS.

string
getTimeZoneString()

Get timezone as a string.

mixed
getUniqueIdentifierFromUserObject(object $user)

No description

null|int
getUserIDFromUserObject(object $user)

No description

array
getUser(int $contactID)

No description

int|null
getLoggedInUfID()

No description

string|null
getLoggedInUniqueIdentifier()

No description

int
getBestUFID(object $user = NULL)

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

string
getBestUFUniqueIdentifier(object $user = NULL)

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

array
getModules()

No description

string|null
getUserRecordUrl(int $contactID)

No description

outputError(string $content)

Output code from error function.

logger(string $message)

No description

appendCoreResources(GenericHookEvent $e)

Append Drupal8 js to coreResourcesList.

alterAssetUrl(GenericHookEvent $e)

Modify dynamic assets.

setHttpHeader(string $name, string $value)

No description

array
synchronizeUsers()

No description

sendResponse(ResponseInterface $response)

Send an HTTP Response base on PSR HTTP RespnseInterface response.

__construct()

No description

bool
formatResourceUrl($url)

Check if a resource url is within the drupal directory and format appropriately.

string
appendCoreDirectoryToResourceBase(string $url)

In instance where civicrm folder has a drupal folder & a civicrm core folder @ the same level append the civicrm folder name to the url See CRM-13737 for discussion of how this allows implementers to alter the folder structure

void
replacePermission(string $oldPerm, array $newPerms)

Find any users/roles/security-principals with the given permission and replace it with one or more permissions.

object
getUserObject($userID)

Load the user object.

null|string
parseDrupalSiteNameFromRoot(string $civicrm_root) deprecated

Parse the name of the drupal site.

string
getCurrentLanguage()

Function to return current language of Drupal8

static 
checkUserNameEmailExists(array $params, array $errors, string $emailName = 'email')

Check if username and email exists in the drupal db.

string[]
parseUrl(string $url)

Helper function to extract path, query and route name from Civicrm URLs.

Details

in CRM_Utils_System_Base at line 53
initialize()

at line 404
loadBootStrap($params = [], $loadUser = TRUE, $throwError = TRUE, $realPath = NULL)

Load drupal bootstrap.

Parameters

$params
$loadUser
$throwError
$realPath

at line 204
appendBreadCrumb($breadcrumbs)

Parameters

$breadcrumbs

at line 214
resetBreadCrumb()

at line 221
addHTMLHead($header)

Parameters

$header

at line 287
mapConfigToSSL()

This function does nothing in Drupal 8. Changes to the base_url should be made in settings.php directly.

at line 646
string postURL(string $action)

Drupal 8 has a different function to get current path, hence overriding the postURL function

Parameters

string $action The default url if one is pre-specified.

Return Value

string The url to post the form.

at line 293
string url(string $path = '', string $query = '', bool $absolute = FALSE, string $fragment = NULL, bool $frontend = FALSE, bool $forceBackend = FALSE)

Parameters

string $path The path being linked to, such as "civicrm/add".
string $query A query string to append to the link.
bool $absolute Whether to force the output to be an absolute link (beginning with http). Useful for links that will be displayed outside the site, such as in an RSS feed.
string $fragment A fragment identifier (named anchor) to append to the link.
bool $frontend This link should be to the CMS front end (applies to WP & Joomla).
bool $forceBackend This link should be to the CMS back end (applies to WP & Joomla).

Return Value

string

at line 326
array|bool authenticate(string $name, string $password, bool $loadCMSBootstrap = FALSE, string $realPath = NULL)

Parameters

string $name The user name.
string $password The password for the above user.
bool $loadCMSBootstrap Load cms bootstrap?.
string $realPath Filename of script

Return Value

array|bool [contactID, ufID, unique string] else false if no auth

at line 631
setMessage(string $message)

Parameters

string $message The message to set.

at line 344
bool loadUser($username)

Parameters

$username

Return Value

bool

at line 378
permissionDenied()

at line 386
logout()

In previous versions, this function was the controller for logging out. In Drupal 8, we rewrite the route to hand off logout to the standard Drupal logout controller. This function should therefore never be called.

at line 518
updateCategories()

string|null getUFLocale()

Return Value

string|null Locale or null for none

in CRM_Utils_System_Base at line 232
string|null theme(string $content, bool $print = FALSE, bool $maintenance = FALSE)

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

Parameters

string $content The content that will be themed.
bool $print Are we displaying to the screen or bypassing theming?.
bool $maintenance For maintenance mode.

Return Value

string|null NULL, If $print is FALSE, and some other criteria match up. The themed string, otherwise.

Exceptions

Exception

at line 534
string getDefaultBlockLocation()

Return Value

string

in CRM_Utils_System_Base at line 296
bool|mixed|string getAbsoluteBaseURL()

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

Return Value

bool|mixed|string

in CRM_Utils_System_Base at line 318
bool getRelativeBaseURL()

Get the relative path to the sites base url.

Return Value

bool

string getVersion()

Return Value

string

at line 746
string languageNegotiationURL(string $url, bool $addLanguagePart = TRUE, bool $removeLanguagePart = FALSE)

Parameters

string $url
bool $addLanguagePart
bool $removeLanguagePart

Return Value

string Formatted url.

at line 454
string|null cmsRootPath(string $path = NULL)

Determine the location of the CMS root.

Parameters

string $path

Return Value

string|null Local file system path to CMS root, or NULL if it cannot be determined

at line 42
int|bool createUser(array $params, string $mail)

Parameters

array $params
string $mail Email id for cms user.

Return Value

int|bool uid if user exists, false otherwise

at line 124
updateCMSName(int $ufID, string $email)

Parameters

int $ufID User ID in CMS.
string $email Primary contact email address.

at line 491
bool isUserLoggedIn()

Return Value

bool

at line 498
bool isUserRegistrationPermitted()

Return Value

bool

at line 508
bool isPasswordUserGenerated()

Return Value

bool

bool isFrontEndPage()

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).

See https://github.com/civicrm/civicrm-drupal/pull/546/files

Return Value

bool

at line 186
string getLoginURL(string $destination = '')

Parameters

string $destination If present, add destination to querystring (works for Drupal only).

Return Value

string loginURL for the current CMS

string|NULL getLoginDestination(CRM_Core_Form $form)

Parameters

CRM_Core_Form $form Form object representing the 'current' form - to which the user will be returned.

Return Value

string|NULL destination value for URL

at line 369
getUfId(string $username)

Determine the native ID of the CMS user.

Parameters

string $username

at line 724
bool setUFLocale(string $civicrm_language)

Parameters

string $civicrm_language

Return Value

bool

in CRM_Utils_System_Base at line 485
setUserSession(array $data)

Set a init session with user object.

Parameters

array $data Array with user specific data

at line 541
flush()

clearResourceCache()

in CRM_Utils_System_Base at line 519
bool addScriptUrl(string $url, string $region)

Add a script file.

Note: This function is not to be called directly

Parameters

string $url absolute path to file
string $region location within the document: 'html-header', 'page-header', 'page-footer'.

Return Value

bool TRUE if we support this operation in this CMS, FALSE otherwise

See also

CRM_Core_Region::render

in CRM_Utils_System_Base at line 536
bool addScript(string $code, string $region)

Add an inline script.

Note: This function is not to be called directly

Parameters

string $code javascript code
string $region location within the document: 'html-header', 'page-header', 'page-footer'.

Return Value

bool TRUE if we support this operation in this CMS, FALSE otherwise

See also

CRM_Core_Region::render

at line 228
bool addStyleUrl(string $url, string $region)

Parameters

string $url absolute path to file
string $region location within the document: 'html-header', 'page-header', 'page-footer'.

Return Value

bool TRUE if we support this operation in this CMS, FALSE otherwise

at line 246
bool addStyle(string $code, string $region)

Parameters

string $code css code
string $region location within the document: 'html-header', 'page-header', 'page-footer'.

Return Value

bool TRUE if we support this operation in this CMS, FALSE otherwise

at line 194
setTitle(string $title, string|null $pageTitle = NULL)

Parameters

string $title Title to set in html header
string|null $pageTitle Title to set in html body (if different)

array getDefaultSiteSettings(string $dir)

Parameters

string $dir

Return Value

array
  • $url, (Joomla - non admin url)
    • $siteName,
    • $siteRoot

array getDefaultFileStorage()

Return Value

array
  • url: string. ex: "http://example.com/sites/foo.com/files/civicrm"
    • path: string. ex: "/var/www/sites/foo.com/files/civicrm"

in CRM_Utils_System_Base at line 654
array getCiviSourceStorage()

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.

Return Value

array
  • url: string. ex: "http://example.com/sites/all/modules/civicrm"
    • path: string. ex: "/var/www/sites/all/modules/civicrm"

userLoginFinalize(array $params = [])

Perform any post login activities required by the UF - 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.

Parameters

array $params FIXME: Document values accepted/required by $params

in CRM_Utils_System_Base at line 717
setMySQLTimeZone()

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

in CRM_Utils_System_Base at line 730
string|false|null getTimeZoneOffset()

Get timezone from CMS.

Return Value

string|false|null

in CRM_Utils_System_Base at line 765
string getTimeZoneString()

Get timezone as a string.

Return Value

string Timezone string e.g. 'America/Los_Angeles'

at line 579
mixed getUniqueIdentifierFromUserObject(object $user)

Parameters

object $user Object as described by the User Framework.

Return Value

mixed Unique identifier from the user Framework system

at line 586
null|int getUserIDFromUserObject(object $user)

Parameters

object $user Object as described by the User Framework.

Return Value

null|int

at line 569
array getUser(int $contactID)

Parameters

int $contactID

Return Value

array CMS user details including - id - name (ie the system user name.

at line 525
int|null getLoggedInUfID()

Return Value

int|null logged in user uf id.

string|null getLoggedInUniqueIdentifier()

Return Value

string|null logged in user unique identifier

in CRM_Utils_System_Base at line 851
int getBestUFID(object $user = NULL)

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.

Parameters

object $user

Return Value

int User ID of UF System

in CRM_Utils_System_Base at line 871
string getBestUFUniqueIdentifier(object $user = NULL)

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.

Parameters

object $user

Return Value

string unique identifier from the UF System

at line 553
array getModules()

Return Value

array [CRM_Core_Module]

string|null getUserRecordUrl(int $contactID)

Parameters

int $contactID Contact ID.

Return Value

string|null

bool checkPermissionAddUser()

Return Value

bool

in CRM_Utils_System_Base at line 914
outputError(string $content)

Output code from error function.

Parameters

string $content

logger(string $message)

Parameters

string $message

at line 717
appendCoreResources(GenericHookEvent $e)

Append Drupal8 js to coreResourcesList.

Parameters

GenericHookEvent $e

in CRM_Utils_System_Base at line 939
alterAssetUrl(GenericHookEvent $e)

Modify dynamic assets.

Parameters

GenericHookEvent $e

in CRM_Utils_System_Base at line 946
setHttpHeader(string $name, string $value)

Parameters

string $name
string $value

at line 593
array synchronizeUsers()

Return Value

array

in CRM_Utils_System_Base at line 966
sendResponse(ResponseInterface $response)

Send an HTTP Response base on PSR HTTP RespnseInterface response.

Parameters

ResponseInterface $response

__construct()

at line 271
bool formatResourceUrl($url)

Check if a resource url is within the drupal directory and format appropriately.

This seems to be a legacy function. We assume all resources are within the drupal directory and always return TRUE. As well, we clean up the $url.

FIXME: This is not a legacy function and the above is not a safe assumption. External urls are allowed by CRM_Core_Resources and this needs to return the correct value.

Parameters

$url (reference)

Return Value

bool TRUE for internal paths, FALSE for external. The drupal_add_js fn is able to add js more efficiently if it is known to be in the drupal site

string appendCoreDirectoryToResourceBase(string $url)

In instance where civicrm folder has a drupal folder & a civicrm core folder @ the same level append the civicrm folder name to the url See CRM-13737 for discussion of how this allows implementers to alter the folder structure

Parameters

string $url Potential resource url based on standard folder assumptions.

Return Value

string with civicrm-core directory appended if not standard civi dir

void replacePermission(string $oldPerm, array $newPerms)

Find any users/roles/security-principals with the given permission and replace it with one or more permissions.

Parameters

string $oldPerm
array $newPerms Array, strings.

Return Value

void

object getUserObject($userID)

Load the user object.

Note this function still works in drupal 6, 7 & 8 but is deprecated in Drupal 8.

Parameters

$userID

Return Value

object

null|string parseDrupalSiteNameFromRoot(string $civicrm_root) deprecated

deprecated

Parse the name of the drupal site.

Parameters

string $civicrm_root

Return Value

null|string

at line 659
string getCurrentLanguage()

Function to return current language of Drupal8

Return Value

string

at line 145
static checkUserNameEmailExists(array $params, array $errors, string $emailName = 'email')

Check if username and email exists in the drupal db.

Parameters

array $params Array of name and mail values.
array $errors Errors.
string $emailName Field label for the 'email'.

at line 687
string[] parseUrl(string $url)

Helper function to extract path, query and route name from Civicrm URLs.

For example, 'civicrm/contact/view?reset=1&cid=66' will be returned as:

Parameters

string $url The url to parse.

Return Value

string[] The parsed url parts, containing 'path', 'route' and 'query'.