CRM_Utils_System_Drupal8
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
Load drupal bootstrap.
No description
No description
No description
This function does nothing in Drupal 8. Changes to the base_url should be made in settings.php directly.
Drupal 8 has a different function to get current path, hence overriding the postURL function
No description
No description
No description
No description
No description
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.
No description
If we are using a theming system, invoke theme, else just print the content.
No description
Get the absolute path to the site's base url.
No description
Determine the location of the CMS root.
No description
No description
No description
No description
No description
No description
Determine the native ID of the CMS user.
No description
No description
No description
No description
No description
Determine the location of the CiviCRM source tree.
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.
Set timezone in mysql so that timestamp fields show the correct time.
No description
No description
No description
No description
Return a UFID (user account ID from the UserFramework / CMS system.
Return a unique identifier (usually an email address or username) from the UserFramework / CMS system.
No description
No description
Send an HTTP Response base on PSR HTTP RespnseInterface response.
Check if a resource url is within the drupal directory and format appropriately.
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
Find any users/roles/security-principals with the given permission and replace it with one or more permissions.
Function to return current language of Drupal8
Check if username and email exists in the drupal db.
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.
at line 204
appendBreadCrumb($breadcrumbs)
at line 214
resetBreadCrumb()
at line 221
addHTMLHead($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
at line 293
string
url(string $path = '', string $query = '', bool $absolute = FALSE, string $fragment = NULL, bool $frontend = FALSE, bool $forceBackend = FALSE)
at line 326
array|bool
authenticate(string $name, string $password, bool $loadCMSBootstrap = FALSE, string $realPath = NULL)
at line 631
setMessage(string $message)
at line 344
bool
loadUser($username)
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()
in CRM_Utils_System_DrupalBase at line 438
string|null
getUFLocale()
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.
at line 534
string
getDefaultBlockLocation()
in CRM_Utils_System_Base at line 296
bool|mixed|string
getAbsoluteBaseURL()
Get the absolute path to the site's base url.
in CRM_Utils_System_Base at line 318
bool
getRelativeBaseURL()
Get the relative path to the sites base url.
in CRM_Utils_System_DrupalBase at line 402
string
getVersion()
at line 746
string
languageNegotiationURL(string $url, bool $addLanguagePart = TRUE, bool $removeLanguagePart = FALSE)
at line 454
string|null
cmsRootPath(string $path = NULL)
Determine the location of the CMS root.
at line 42
int|bool
createUser(array $params, string $mail)
at line 124
updateCMSName(int $ufID, string $email)
at line 491
bool
isUserLoggedIn()
at line 498
bool
isUserRegistrationPermitted()
at line 508
bool
isPasswordUserGenerated()
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
at line 186
string
getLoginURL(string $destination = '')
in CRM_Utils_System_DrupalBase at line 502
string|NULL
getLoginDestination(CRM_Core_Form $form)
at line 369
getUfId(string $username)
Determine the native ID of the CMS user.
at line 724
bool
setUFLocale(string $civicrm_language)
in CRM_Utils_System_Base at line 485
setUserSession(array $data)
Set a init session with user object.
at line 541
flush()
in CRM_Utils_System_DrupalBase at line 297
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
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
at line 228
bool
addStyleUrl(string $url, string $region)
at line 246
bool
addStyle(string $code, string $region)
at line 194
setTitle(string $title, string|null $pageTitle = NULL)
in CRM_Utils_System_DrupalBase at line 85
array
getDefaultSiteSettings(string $dir)
in CRM_Utils_System_DrupalBase at line 64
array
getDefaultFileStorage()
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.
in CRM_Utils_System_DrupalBase at line 495
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.
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.
in CRM_Utils_System_Base at line 765
string
getTimeZoneString()
Get timezone as a string.
at line 579
mixed
getUniqueIdentifierFromUserObject(object $user)
at line 586
null|int
getUserIDFromUserObject(object $user)
at line 569
array
getUser(int $contactID)
at line 525
int|null
getLoggedInUfID()
in CRM_Utils_System_DrupalBase at line 251
string|null
getLoggedInUniqueIdentifier()
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.
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.
at line 553
array
getModules()
in CRM_Utils_System_DrupalBase at line 266
string|null
getUserRecordUrl(int $contactID)
in CRM_Utils_System_DrupalBase at line 281
bool
checkPermissionAddUser()
in CRM_Utils_System_Base at line 914
outputError(string $content)
Output code from error function.
in CRM_Utils_System_DrupalBase at line 288
logger(string $message)
at line 717
appendCoreResources(GenericHookEvent $e)
Append Drupal8 js to coreResourcesList.
in CRM_Utils_System_Base at line 939
alterAssetUrl(GenericHookEvent $e)
Modify dynamic assets.
in CRM_Utils_System_Base at line 946
setHttpHeader(string $name, string $value)
at line 593
array
synchronizeUsers()
in CRM_Utils_System_Base at line 966
sendResponse(ResponseInterface $response)
Send an HTTP Response base on PSR HTTP RespnseInterface response.
in CRM_Utils_System_DrupalBase at line 50
__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.
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
in CRM_Utils_System_DrupalBase at line 330
void
replacePermission(string $oldPerm, array $newPerms)
Find any users/roles/security-principals with the given permission and replace it with one or more permissions.
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.
in CRM_Utils_System_DrupalBase at line 586
null|string
parseDrupalSiteNameFromRoot(string $civicrm_root)
deprecated
deprecated
Parse the name of the drupal site.
at line 659
string
getCurrentLanguage()
Function to return current language of Drupal8
at line 145
static
checkUserNameEmailExists(array $params, array $errors, string $emailName = 'email')
Check if username and email exists in the drupal db.
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: