CRM_Utils_System_Backdrop
class CRM_Utils_System_Backdrop extends CRM_Utils_System_DrupalBase
Backdrop-specific logic that differs from Drupal.
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
No description
No description
No description
No description
Fixme: Why are we overriding the parent function? Seems inconsistent.
Generate an internal CiviCRM URL (copied from DRUPAL/includes/common.inc#url)
No description
No description
No description
No description
If we are using a theming system, invoke theme, else just print the content.
Get the default location for CiviCRM blocks.
Get the absolute path to the site's base url.
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
No description
No description
Determine the default location for file storage.
Determine the location of the CiviCRM source tree.
Perform any post login activities required by the UF - For Backdrop this could mean recording a watchdog message about the new session, saving the login timestamp, calling hook_user_login(), etc.
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.
Append Drupal js to coreResourcesList.
No description
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.
Parse the name of the drupal site.
Check if username and email exists in the drupal db.
Get the name of the table that stores the user details.
Load Backdrop bootstrap.
Wrapper for og_membership creation.
Wrapper for og_membership deletion.
Get all the contact emails for users that have a specific permission.
Details
in CRM_Utils_System_Base at line 53
initialize()
at line 174
appendBreadCrumb(array $breadCrumbs)
at line 199
resetBreadCrumb()
at line 207
addHTMLHead($header)
at line 286
mapConfigToSSL()
in CRM_Utils_System_DrupalBase at line 510
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?
in CRM_Utils_System_DrupalBase at line 149
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)
at line 307
array|bool
authenticate(string $name, string $password, bool $loadCMSBootstrap = FALSE, string $realPath = NULL)
in CRM_Utils_System_DrupalBase at line 218
setMessage(string $message)
at line 382
bool
loadUser($username)
in CRM_Utils_System_DrupalBase at line 240
permissionDenied()
at line 481
logout()
in CRM_Utils_System_DrupalBase at line 399
updateCategories()
at line 416
string|null
getUFLocale()
in CRM_Utils_System_Base at line 230
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 491
string
getDefaultBlockLocation()
Get the default location for CiviCRM blocks.
in CRM_Utils_System_Base at line 295
bool|mixed|string
getAbsoluteBaseURL()
Get the absolute path to the site's base url.
in CRM_Utils_System_Base at line 317
bool
getRelativeBaseURL()
Get the relative path to the sites base url.
in CRM_Utils_System_DrupalBase at line 392
string
getVersion()
at line 678
string
languageNegotiationURL(string $url, bool $addLanguagePart = TRUE, bool $removeLanguagePart = FALSE)
at line 608
string|null
cmsRootPath($scriptFilename = NULL)
at line 42
int|bool
createUser(array $params, string $mail)
at line 94
updateCMSName(int $ufID, string $email)
at line 651
bool
isUserLoggedIn()
at line 153
string
getLoginURL(string $destination = '')
in CRM_Utils_System_DrupalBase at line 472
string|NULL
getLoginDestination(CRM_Core_Form $form)
at line 470
getUfId(string $username)
Determine the native ID of the CMS user.
at line 444
bool
setUFLocale(string $civicrm_language)
in CRM_Utils_System_Base at line 453
setUserSession(array $data)
Set a init session with user object.
in CRM_Utils_System_DrupalBase at line 294
flush()
at line 870
clearResourceCache()
at line 222
bool
addScriptUrl(string $url, string $region)
at line 242
bool
addScript(string $code, string $region)
at line 260
bool
addStyleUrl(string $url, string $region)
at line 274
bool
addStyle(string $code, string $region)
at line 161
setTitle(string $title, string|null $pageTitle = NULL)
in CRM_Utils_System_DrupalBase at line 64
array
getDefaultSiteSettings(string $dir)
in CRM_Utils_System_Base at line 582
array
getDefaultFileStorage()
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.
in CRM_Utils_System_Base at line 631
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 409
userLoginFinalize(array $params = array())
Perform any post login activities required by the UF - For Backdrop this could mean recording a watchdog message about the new session, saving the login timestamp, calling hook_user_login(), etc.
in CRM_Utils_System_Base at line 694
setMySQLTimeZone()
Set timezone in mysql so that timestamp fields show the correct time.
in CRM_Utils_System_Base at line 708
string|false|null
getTimeZoneOffset()
Get timezone from CMS.
at line 803
string
getTimeZoneString()
in CRM_Utils_System_DrupalBase at line 225
mixed
getUniqueIdentifierFromUserObject(object $user)
in CRM_Utils_System_DrupalBase at line 211
null|int
getUserIDFromUserObject(object $user)
in CRM_Utils_System_DrupalBase at line 527
array
getUser(int $contactID)
Get an array of user details for a contact, containing at minimum the user ID & name.
at line 663
int|null
getLoggedInUfID()
in CRM_Utils_System_DrupalBase at line 232
string|null
getLoggedInUniqueIdentifier()
in CRM_Utils_System_Base at line 824
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 844
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.
in CRM_Utils_System_DrupalBase at line 301
array
getModules()
in CRM_Utils_System_DrupalBase at line 247
string|null
getUserRecordUrl(int $contactID)
in CRM_Utils_System_DrupalBase at line 262
bool
checkPermissionAddUser()
in CRM_Utils_System_Base at line 887
outputError(string $content)
Output code from error function.
in CRM_Utils_System_DrupalBase at line 269
logger(string $message)
in CRM_Utils_System_DrupalBase at line 287
appendCoreResources(array $list)
Append Drupal js to coreResourcesList.
at line 821
setHttpHeader(string $name, string $value)
at line 828
array
synchronizeUsers()
in CRM_Utils_System_DrupalBase at line 50
__construct()
in CRM_Utils_System_DrupalBase at line 95
bool
formatResourceUrl($url)
Check if a resource url is within the drupal directory and format appropriately.
in CRM_Utils_System_DrupalBase at line 135
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 746
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 544
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 555
null|string
parseDrupalSiteName(string $civicrm_root)
Parse the name of the drupal site.
at line 115
static
checkUserNameEmailExists(array $params, array $errors, string $emailName = 'email')
Check if username and email exists in the drupal db.
at line 296
protected string
getUsersTableName()
Get the name of the table that stores the user details.
at line 508
bool
loadBootStrap(array $params = array(), bool $loadUser = TRUE, bool $throwError = TRUE, bool|string $realPath = NULL)
Load Backdrop bootstrap.
at line 764
og_membership_create(int $ogID, int $userID)
Wrapper for og_membership creation.
at line 787
og_membership_delete(int $ogID, int $userID)
Wrapper for og_membership deletion.
at line 883
string
permissionEmails(string $permissionName)
Get all the contact emails for users that have a specific permission.