CRM_Utils_System_Drupal

class CRM_Utils_System_Drupal 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

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

Load drupal bootstrap.

appendBreadCrumb(array $breadCrumbs)

No description

resetBreadCrumb()

No description

addHTMLHead($header)

No description

mapConfigToSSL()

No description

string
postURL(string $action)

Fixme: Why are we overriding the parent function? Seems inconsistent.

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

Generate an internal CiviCRM URL (copied from DRUPAL/includes/common.inc#url)

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

No description

setMessage(string $message)

No description

from CRM_Utils_System_DrupalBase
bool
loadUser($username)

No description

permissionDenied()

No description

from CRM_Utils_System_DrupalBase
logout()

No description

updateCategories()

No description

from CRM_Utils_System_DrupalBase
string|null
getUFLocale()

No description

from CRM_Utils_System_DrupalBase
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.

from CRM_Utils_System_Base
string
getDefaultBlockLocation()

Get the default location for CiviCRM blocks.

bool|mixed|string
getAbsoluteBaseURL()

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

from CRM_Utils_System_Base
bool
getRelativeBaseURL()

Get the relative path to the sites base url.

from CRM_Utils_System_Base
string
getVersion()

No description

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

No description

string|null
cmsRootPath(string $scriptFilename = NULL)

Get CMS root path.

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

No description

updateCMSName(int $ufID, $ufName)

No description

bool
isUserLoggedIn()

No description

bool
isUserRegistrationPermitted()

No description

from CRM_Utils_System_DrupalBase
bool
isPasswordUserGenerated()

No description

from CRM_Utils_System_DrupalBase
bool
isFrontEndPage()

Is a front end page being accessed.

from CRM_Utils_System_DrupalBase
string
getLoginURL(string $destination = '')

No description

string|NULL
getLoginDestination(CRM_Core_Form $form)

No description

from CRM_Utils_System_DrupalBase
getUfId(string $username)

Determine the native ID of the CMS user.

bool
setUFLocale(string $civicrm_language)

No description

from CRM_Utils_System_DrupalBase
setUserSession(array $data)

Set a init session with user object.

from CRM_Utils_System_Base
flush()

No description

from CRM_Utils_System_DrupalBase
clearResourceCache()

No description

from CRM_Utils_System_DrupalBase
bool
addScriptUrl(string $url, string $region)

No description

bool
addScript(string $code, string $region)

No description

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

from CRM_Utils_System_DrupalBase
array
getDefaultFileStorage()

No description

from CRM_Utils_System_DrupalBase
array
getCiviSourceStorage()

Determine the location of the CiviCRM source tree.

from CRM_Utils_System_Base
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.

from CRM_Utils_System_Base
string|false|null
getTimeZoneOffset()

Get timezone from CMS.

from CRM_Utils_System_Base
string
getTimeZoneString()

No description

mixed
getUniqueIdentifierFromUserObject(object $user)

No description

from CRM_Utils_System_DrupalBase
null|int
getUserIDFromUserObject(object $user)

No description

from CRM_Utils_System_DrupalBase
array
getUser(int $contactID)

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

from CRM_Utils_System_DrupalBase
int|null
getLoggedInUfID()

No description

string|null
getLoggedInUniqueIdentifier()

No description

from CRM_Utils_System_DrupalBase
int
getBestUFID(object $user = NULL)

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

from CRM_Utils_System_Base
string
getBestUFUniqueIdentifier(object $user = NULL)

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

from CRM_Utils_System_Base
array
getModules()

No description

from CRM_Utils_System_DrupalBase
string|null
getUserRecordUrl(int $contactID)

No description

from CRM_Utils_System_DrupalBase
bool
checkPermissionAddUser()

No description

from CRM_Utils_System_DrupalBase
outputError(string $content)

Output code from error function.

from CRM_Utils_System_Base
logger(string $message)

No description

from CRM_Utils_System_DrupalBase
appendCoreResources(GenericHookEvent $e)

Append to coreResourcesList.

from CRM_Utils_System_Base
alterAssetUrl(GenericHookEvent $e)

Modify dynamic assets.

from CRM_Utils_System_Base
setHttpHeader(string $name, string $value)

No description

array
synchronizeUsers()

No description

sendResponse(ResponseInterface $response)

Send an HTTP Response base on PSR HTTP RespnseInterface response.

from CRM_Utils_System_Base
__construct()

No description

from CRM_Utils_System_DrupalBase
bool
formatResourceUrl($url)

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

from CRM_Utils_System_DrupalBase
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

from CRM_Utils_System_DrupalBase
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.

from CRM_Utils_System_DrupalBase
null|string
parseDrupalSiteNameFromRoot(string $civicrm_root) deprecated

Parse the name of the drupal site.

from CRM_Utils_System_DrupalBase
string
getCurrentLanguage()

Function to return current language of Drupal

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

Check if username and email exists in the drupal db.

string
getUsersTableName()

Get the name of the users table.

og_membership_create(int $ogID, int $drupalID)

Wrapper for og_membership creation.

og_membership_delete(int $ogID, int $drupalID)

Wrapper for og_membership deletion.

onCiviExit()

Commit the session before exiting.

Details

in CRM_Utils_System_Base at line 53
initialize()

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

Load drupal bootstrap.

Parameters

$params
$loadUser
$throwError
$realPath

at line 185
appendBreadCrumb(array $breadCrumbs)

Parameters

array $breadCrumbs

at line 210
resetBreadCrumb()

at line 218
addHTMLHead($header)

Parameters

$header

at line 297
mapConfigToSSL()

in CRM_Utils_System_DrupalBase at line 540
string postURL(string $action)

Fixme: Why are we overriding the parent function? Seems inconsistent.

This version supplies slightly different params to $this->url (not absolute and html encoded) but why?

Parameters

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

Return Value

string The url to post the form.

in CRM_Utils_System_DrupalBase at line 168
string url(string $path = NULL, string $query = NULL, bool $absolute = FALSE, string $fragment = NULL, bool $frontend = FALSE, bool $forceBackend = FALSE)

Generate an internal CiviCRM URL (copied from DRUPAL/includes/common.inc#url)

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 318
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

in CRM_Utils_System_DrupalBase at line 237
setMessage(string $message)

Parameters

string $message The message to set.

at line 395
bool loadUser($username)

Parameters

$username

Return Value

bool

in CRM_Utils_System_DrupalBase at line 259
permissionDenied()

at line 444
logout()

in CRM_Utils_System_DrupalBase at line 429
updateCategories()

in CRM_Utils_System_DrupalBase at line 438
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 454
string getDefaultBlockLocation()

Get the default location for CiviCRM blocks.

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

in CRM_Utils_System_DrupalBase at line 402
string getVersion()

Return Value

string

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

Parameters

string $url
bool $addLanguagePart
bool $removeLanguagePart

Return Value

string Formatted url.

at line 579
string|null cmsRootPath(string $scriptFilename = NULL)

Get CMS root path.

Parameters

string $scriptFilename

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 94
updateCMSName(int $ufID, $ufName)

Parameters

int $ufID User ID in CMS.
$ufName

at line 633
bool isUserLoggedIn()

Return Value

bool

in CRM_Utils_System_DrupalBase at line 409
bool isUserRegistrationPermitted()

Return Value

bool

in CRM_Utils_System_DrupalBase at line 419
bool isPasswordUserGenerated()

Return Value

bool

in CRM_Utils_System_DrupalBase at line 675
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 164
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

in CRM_Utils_System_DrupalBase at line 502
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 433
getUfId(string $username)

Determine the native ID of the CMS user.

Parameters

string $username

in CRM_Utils_System_DrupalBase at line 466
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

in CRM_Utils_System_DrupalBase at line 304
flush()

in CRM_Utils_System_DrupalBase at line 297
clearResourceCache()

at line 233
bool addScriptUrl(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 253
bool addScript(string $code, string $region)

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

at line 271
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 285
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 172
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)

in CRM_Utils_System_DrupalBase at line 85
array getDefaultSiteSettings(string $dir)

Parameters

string $dir

Return Value

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

in CRM_Utils_System_DrupalBase at line 64
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"

at line 423
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

at line 787
string getTimeZoneString()

Return Value

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

in CRM_Utils_System_DrupalBase at line 244
mixed getUniqueIdentifierFromUserObject(object $user)

Parameters

object $user Object as described by the User Framework.

Return Value

mixed Unique identifier from the user Framework system

in CRM_Utils_System_DrupalBase at line 230
null|int getUserIDFromUserObject(object $user)

Parameters

object $user Object as described by the User Framework.

Return Value

null|int

in CRM_Utils_System_DrupalBase at line 557
array getUser(int $contactID)

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

Parameters

int $contactID

Return Value

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

at line 645
int|null getLoggedInUfID()

Return Value

int|null logged in user uf id.

in CRM_Utils_System_DrupalBase at line 251
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

in CRM_Utils_System_DrupalBase at line 311
array getModules()

Return Value

array [CRM_Core_Module]

in CRM_Utils_System_DrupalBase at line 266
string|null getUserRecordUrl(int $contactID)

Parameters

int $contactID Contact ID.

Return Value

string|null

in CRM_Utils_System_DrupalBase at line 281
bool checkPermissionAddUser()

Return Value

bool

in CRM_Utils_System_Base at line 914
outputError(string $content)

Output code from error function.

Parameters

string $content

in CRM_Utils_System_DrupalBase at line 288
logger(string $message)

Parameters

string $message

in CRM_Utils_System_Base at line 931
appendCoreResources(GenericHookEvent $e)

Append to coreResourcesList.

Parameters

GenericHookEvent $e

in CRM_Utils_System_Base at line 939
alterAssetUrl(GenericHookEvent $e)

Modify dynamic assets.

Parameters

GenericHookEvent $e

at line 805
setHttpHeader(string $name, string $value)

Parameters

string $name
string $value

at line 812
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

in CRM_Utils_System_DrupalBase at line 50
__construct()

in CRM_Utils_System_DrupalBase at line 116
bool formatResourceUrl($url)

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

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

in CRM_Utils_System_DrupalBase at line 154
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

at line 730
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

in CRM_Utils_System_DrupalBase at line 574
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

in CRM_Utils_System_DrupalBase at line 586
null|string parseDrupalSiteNameFromRoot(string $civicrm_root) deprecated

deprecated

Parse the name of the drupal site.

Parameters

string $civicrm_root

Return Value

null|string

in CRM_Utils_System_DrupalBase at line 661
string getCurrentLanguage()

Function to return current language of Drupal

Return Value

string

at line 115
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 Array of errors.
string $emailName Field label for the 'email'.

at line 307
protected string getUsersTableName()

Get the name of the users table.

Return Value

string

at line 748
og_membership_create(int $ogID, int $drupalID)

Wrapper for og_membership creation.

Parameters

int $ogID Organic Group ID.
int $drupalID Drupal User ID.

at line 771
og_membership_delete(int $ogID, int $drupalID)

Wrapper for og_membership deletion.

Parameters

int $ogID Organic Group ID.
int $drupalID Drupal User ID.

at line 852
onCiviExit()

Commit the session before exiting.

Similar to drupal_exit().