CRM_Utils_System_Joomla

class CRM_Utils_System_Joomla extends CRM_Utils_System_Base

Joomla 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_Base
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, bool $loadDefines = TRUE)

Load joomla bootstrap.

appendBreadCrumb(array $breadCrumbs)

No description

resetBreadCrumb()

No description

addHTMLHead($string = NULL)

No description

mapConfigToSSL()

Rewrite various system urls to https.

from CRM_Utils_System_Base
string
postURL(string $action)

Figure out the post url for QuickForm.

from CRM_Utils_System_Base
string
url(string $path = NULL, string $query = NULL, 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)

FIXME: Do something

bool
loadUser(string $username, string $password = NULL)

No description

permissionDenied()

FIXME: Use CMS-native approach

logout()

No description

updateCategories()

Clear CMS caches related to the user registration/profile forms.

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

from CRM_Utils_System_Base
string
getDefaultBlockLocation()

No description

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

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

Format the url as per language Negotiation.

from CRM_Utils_System_Base
string|null
cmsRootPath()

Determine the location of the CMS root.

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

No description

updateCMSName(int $ufID, $ufName)

No description

bool
isUserLoggedIn()

No description

bool
isUserRegistrationPermitted()

No description

bool
isPasswordUserGenerated()

No description

bool
isFrontEndPage()

Is a front end page being accessed.

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

from CRM_Utils_System_Base
bool
setUFLocale(string $civicrm_language)

No description

setUserSession(array $data)

Set a init session with user object.

flush()

Reset any system caches that may be required for proper CiviCRM integration.

from CRM_Utils_System_Base
clearResourceCache()

Flush css/js caches.

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

Add a script file.

from CRM_Utils_System_Base
bool
addScript(string $code, string $region)

Add an inline script.

from CRM_Utils_System_Base
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 = NULL)

No description

array
getDefaultFileStorage()

Determine the default location for file storage.

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

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

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.

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

Get a list of all installed modules, including enabled and disabled ones

string|null
getUserRecordUrl(int $contactID)

No description

bool
checkPermissionAddUser()

No description

outputError(string $content)

Output code from error function.

from CRM_Utils_System_Base
logger(string $message)

Log error to CMS.

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

from CRM_Utils_System_Base
array
synchronizeUsers()

No description

sendResponse(ResponseInterface $response)

Send an HTTP Response base on PSR HTTP RespnseInterface response.

from CRM_Utils_System_Base
__construct()

Class constructor.

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

Check if username and email exists in the Joomla db.

setEmail(object $user)

Set the email address of the user.

getJVersion($joomlaBase)

No description

mixed
getBasePath()

Setup the base path related constant.

Details

in CRM_Utils_System_Base at line 53
initialize()

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

Load joomla bootstrap.

Parameters

$params
$loadUser
$throwError
$realPath
bool $loadDefines

at line 186
appendBreadCrumb(array $breadCrumbs)

Parameters

array $breadCrumbs

at line 212
resetBreadCrumb()

at line 218
addHTMLHead($string = NULL)

Parameters

$string

in CRM_Utils_System_Base at line 87
mapConfigToSSL()

Rewrite various system urls to https.

in CRM_Utils_System_Base at line 100
string postURL(string $action)

Figure out the post url for QuickForm.

Parameters

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

Return Value

string The url to post the form.

at line 252
string url(string $path = NULL, string $query = NULL, 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 334
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 437
setMessage(string $message)

FIXME: Do something

Parameters

string $message The message to set.

at line 446
bool loadUser(string $username, string $password = NULL)

Parameters

string $username
string $password

Return Value

bool

at line 477
permissionDenied()

FIXME: Use CMS-native approach

at line 484
logout()

in CRM_Utils_System_Base at line 201
updateCategories()

Clear CMS caches related to the user registration/profile forms.

Used when updating/embedding profiles on CMS user forms.

See also

CRM-3600

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

in CRM_Utils_System_Base at line 287
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

at line 512
string getVersion()

Return Value

string

in CRM_Utils_System_Base at line 347
string languageNegotiationURL(string $url, bool $addLanguagePart = TRUE, bool $removeLanguagePart = FALSE)

Format the url as per language Negotiation.

Parameters

string $url
bool $addLanguagePart
bool $removeLanguagePart

Return Value

string Formatted url.

at line 773
string|null cmsRootPath()

Determine the location of the CMS root.

Return Value

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

at line 55
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 98
updateCMSName(int $ufID, $ufName)

Parameters

int $ufID User ID in CMS.
$ufName

at line 621
bool isUserLoggedIn()

Return Value

bool

at line 629
bool isUserRegistrationPermitted()

Return Value

bool

at line 640
bool isPasswordUserGenerated()

Return Value

bool

in CRM_Utils_System_Base at line 426
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).

Return Value

bool

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

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

in CRM_Utils_System_Base at line 463
getUfId(string $username)

Determine the native ID of the CMS user.

Parameters

string $username

Exceptions

CRM_Core_Exception

at line 504
bool setUFLocale(string $civicrm_language)

Parameters

string $civicrm_language

Return Value

bool

at line 423
setUserSession(array $data)

Set a init session with user object.

Parameters

array $data Array with user specific data

in CRM_Utils_System_Base at line 495
flush()

Reset any system caches that may be required for proper CiviCRM integration.

in CRM_Utils_System_Base at line 502
clearResourceCache()

Flush css/js caches.

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 240
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 171
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)

at line 789
array getDefaultSiteSettings(string $dir = NULL)

Parameters

string $dir

Return Value

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

in CRM_Utils_System_Base at line 614
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.

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"

in CRM_Utils_System_Base at line 711
userLoginFinalize(array $params = [])

Perform any post login activities required by the CMS.

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 687
string getTimeZoneString()

Return Value

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

at line 680
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 673
null|int getUserIDFromUserObject(object $user)

Parameters

object $user Object as described by the User Framework.

Return Value

null|int

at line 663
array getUser(int $contactID)

Parameters

int $contactID

Return Value

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

at line 647
int|null getLoggedInUfID()

Return Value

int|null logged in user uf id.

at line 655
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 698
array getModules()

Get a list of all installed modules, including enabled and disabled ones

Return Value

array [CRM_Core_Module]

at line 819
string|null getUserRecordUrl(int $contactID)

Parameters

int $contactID Contact ID.

Return Value

string|null

at line 834
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_Base at line 923
logger(string $message)

Log error to CMS.

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

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

Parameters

string $name
string $value

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

at line 42
__construct()

Class constructor.

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

Check if username and email exists in the Joomla db.

Parameters

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

at line 321
setEmail(object $user)

Set the email address of the user.

Parameters

object $user Handle to the user object.

at line 522
getJVersion($joomlaBase)

Parameters

$joomlaBase

at line 541
mixed getBasePath()

Setup the base path related constant.

Return Value

mixed