CRM_Utils_System_DrupalBase
abstract class CRM_Utils_System_DrupalBase extends CRM_Utils_System_Base
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? | |
bool | $supports_form_extensions | from CRM_Utils_System_Base |
Methods
No description
Append an additional breadcrumb tag to the existing breadcrumb.
Reset an additional breadcrumb tag to the existing breadcrumb.
Fixme: Why are we overriding the parent function? Seems inconsistent.
Generate an internal CiviCRM URL (copied from DRUPAL/includes/common.inc#url)
Authenticate the user against the CMS db.
No description
No description
Immediately stop script execution, log out the user and redirect to the home page.
No description
No description
If we are using a theming system, invoke theme, else just print the content.
Get the absolute path to the site's base url.
No description
No description
Create a user in the CMS.
Update a user's email address in the CMS.
No description
No description
Is a front end page being accessed.
Get user login URL for hosting CMS (method declared in each CMS system class)
No description
No description
No description
Sets the title of the page.
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
Get an array of user details for a contact, containing at minimum the user ID & name.
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
No description
No description
Send an HTTP Response base on PSR HTTP RespnseInterface response.
No description
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.
Load the user object.
Function to return current language of Drupal
Details
in CRM_Utils_System_Base at line 53
initialize()
in CRM_Utils_System_Base at line 59
abstract
loadBootStrap($params = [], $loadUser = TRUE, $throwError = TRUE, $realPath = NULL)
in CRM_Utils_System_Base at line 66
appendBreadCrumb(array $breadCrumbs)
Append an additional breadcrumb tag to the existing breadcrumb.
in CRM_Utils_System_Base at line 72
resetBreadCrumb()
Reset an additional breadcrumb tag to the existing breadcrumb.
in CRM_Utils_System_Base at line 81
addHTMLHead(string $head)
Append a string to the head of the html file.
in CRM_Utils_System_Base at line 87
mapConfigToSSL()
Rewrite various system urls to https.
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?
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)
in CRM_Utils_System_Base at line 156
array|bool
authenticate(string $name, string $password, bool $loadCMSBootstrap = FALSE, string $realPath = NULL)
Authenticate the user against the CMS db.
at line 237
setMessage(string $message)
in CRM_Utils_System_Base at line 176
bool
loadUser(obj $user)
Load user into session.
at line 259
permissionDenied()
in CRM_Utils_System_Base at line 193
logout()
deprecated
deprecated
Immediately stop script execution, log out the user and redirect to the home page.
at line 429
updateCategories()
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.
in CRM_Utils_System_Base at line 287
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.
at line 402
string
getVersion()
at line 343
string
languageNegotiationURL(string $url, bool $addLanguagePart = TRUE, bool $removeLanguagePart = FALSE)
in CRM_Utils_System_Base at line 361
string|null
cmsRootPath()
Determine the location of the CMS root.
in CRM_Utils_System_Base at line 375
int|bool
createUser(array $params, string $mail)
Create a user in the CMS.
in CRM_Utils_System_Base at line 387
updateCMSName(int $ufID, string $email)
Update a user's email address in the CMS.
in CRM_Utils_System_Base at line 395
bool
isUserLoggedIn()
Check if user is logged in to the CMS.
at line 409
bool
isUserRegistrationPermitted()
at line 419
bool
isPasswordUserGenerated()
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
in CRM_Utils_System_Base at line 439
abstract string
getLoginURL(string $destination = '')
Get user login URL for hosting CMS (method declared in each CMS system class)
at line 502
string|NULL
getLoginDestination(CRM_Core_Form $form)
in CRM_Utils_System_Base at line 463
getUfId(string $username)
Determine the native ID of the CMS user.
at line 466
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 304
flush()
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
in CRM_Utils_System_Base at line 553
bool
addStyleUrl(string $url, string $region)
Add a css file.
Note: This function is not to be called directly
in CRM_Utils_System_Base at line 570
bool
addStyle(string $code, string $region)
Add an inline style.
Note: This function is not to be called directly
in CRM_Utils_System_Base at line 582
setTitle(string $title, string|null $pageTitle = NULL)
Sets the title of the page.
at line 85
array
getDefaultSiteSettings(string $dir)
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.
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 244
mixed
getUniqueIdentifierFromUserObject(object $user)
at line 230
null|int
getUserIDFromUserObject(object $user)
at line 557
array
getUser(int $contactID)
Get an array of user details for a contact, containing at minimum the user ID & name.
in CRM_Utils_System_Base at line 821
int|null
getLoggedInUfID()
Get currently logged in user uf id.
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 311
array
getModules()
at line 266
string|null
getUserRecordUrl(int $contactID)
at line 281
bool
checkPermissionAddUser()
in CRM_Utils_System_Base at line 914
outputError(string $content)
Output code from error function.
at line 288
logger(string $message)
in CRM_Utils_System_Base at line 931
appendCoreResources(GenericHookEvent $e)
Append 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)
in CRM_Utils_System_Base at line 956
array
synchronizeUsers()
Create CRM contacts for all existing CMS users
in CRM_Utils_System_Base at line 966
sendResponse(ResponseInterface $response)
Send an HTTP Response base on PSR HTTP RespnseInterface response.
at line 50
__construct()
at line 116
bool
formatResourceUrl($url)
Check if a resource url is within the drupal directory and format appropriately.
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
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.
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.
at line 586
null|string
parseDrupalSiteNameFromRoot(string $civicrm_root)
deprecated
deprecated
Parse the name of the drupal site.
at line 661
string
getCurrentLanguage()
Function to return current language of Drupal