| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
-*/
+ */
/**
*
*/
class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch {
- /*
+ /**
* Create UF Match, Note that thsi function is here in it's simplest form @ the moment
*
+ * @param $params
*
- * @param array $params input parameters
- */
- /**
- * @param array $params
- *
- * @return CRM_Core_DAO_UFMatch
+ * @return \CRM_Core_DAO_UFMatch
*/
- static function create($params) {
+ public static function create($params) {
$hook = empty($params['id']) ? 'create' : 'edit';
CRM_Utils_Hook::pre($hook, 'UFMatch', CRM_Utils_Array::value('id', $params), $params);
- if(empty($params['domain_id'])) {
+ if (empty($params['domain_id'])) {
$params['domain_id'] = CRM_Core_Config::domainID();
}
$dao = new CRM_Core_DAO_UFMatch();
* object for this user. If the user has new values, we need
* to update the CRM DB with the new values
*
- * @param Object $user the drupal user object
- * @param boolean $update has the user object been edited
+ * @param Object $user
+ * The drupal user object.
+ * @param bool $update
+ * Has the user object been edited.
* @param $uf
*
* @param $ctype
* @param bool $isLogin
*
* @return void
- * @access public
- * @static
*/
- static function synchronize(&$user, $update, $uf, $ctype, $isLogin = FALSE) {
+ public static function synchronize(&$user, $update, $uf, $ctype, $isLogin = FALSE) {
$userSystem = CRM_Core_Config::singleton()->userSystem;
$session = CRM_Core_Session::singleton();
if (!is_object($session)) {
}
//make sure we have session w/ consistent ids.
- $ufID = $ufmatch->uf_id;
- $userID = $ufmatch->contact_id;
+ $ufID = $ufmatch->uf_id;
+ $userID = $ufmatch->contact_id;
$ufUniqID = '';
if ($isUserLoggedIn) {
$loggedInUserUfID = CRM_Utils_System::getLoggedInUfID();
//are we processing logged in user.
if ($loggedInUserUfID && $loggedInUserUfID != $ufID) {
- $userIds = self::getUFValues($loggedInUserUfID);
- $ufID = CRM_Utils_Array::value('uf_id', $userIds, '');
- $userID = CRM_Utils_Array::value('contact_id', $userIds, '');
+ $userIds = self::getUFValues($loggedInUserUfID);
+ $ufID = CRM_Utils_Array::value('uf_id', $userIds, '');
+ $userID = CRM_Utils_Array::value('contact_id', $userIds, '');
$ufUniqID = CRM_Utils_Array::value('uf_name', $userIds, '');
}
}
// add current contact to recently viewed
if ($ufmatch->contact_id) {
- list($displayName, $contactImage, $contactType, $contactSubtype, $contactImageUrl) =
- CRM_Contact_BAO_Contact::getDisplayAndImage($ufmatch->contact_id, TRUE, TRUE);
+ list($displayName, $contactImage, $contactType, $contactSubtype, $contactImageUrl)
+ = CRM_Contact_BAO_Contact::getDisplayAndImage($ufmatch->contact_id, TRUE, TRUE);
$otherRecent = array(
'imageUrl' => $contactImageUrl,
* Synchronize the object with the UF Match entry. Can be called stand-alone from
* the drupalUsers script
*
- * @param Object $user the drupal user object
- * @param string $userKey the id of the user from the uf object
- * @param string $uniqId the OpenID of the user
- * @param string $uf the name of the user framework
- * @param integer $status returns the status if user created or already exits (used for CMS sync)
- *
- * @param null $ctype
+ * @param Object $user
+ * The drupal user object.
+ * @param string $userKey
+ * The id of the user from the uf object.
+ * @param string $uniqId
+ * The OpenID of the user.
+ * @param string $uf
+ * The name of the user framework.
+ * @param int $status
+ * Returns the status if user created or already exits (used for CMS sync).
+ * @param string $ctype
+ * contact type
* @param bool $isLogin
*
- * @return the ufmatch object that was found or created
- * @access public
- * @static
+ * @return CRM_Core_DAO_UFMatch|bool
*/
- static function &synchronizeUFMatch(&$user, $userKey, $uniqId, $uf, $status = NULL, $ctype = NULL, $isLogin = FALSE) {
+ public static function &synchronizeUFMatch(&$user, $userKey, $uniqId, $uf, $status = NULL, $ctype = NULL, $isLogin = FALSE) {
$config = CRM_Core_Config::singleton();
if (!CRM_Utils_Rule::email($uniqId)) {
$newContact = FALSE;
// make sure that a contact id exists for this user id
- $ufmatch = new CRM_Core_DAO_UFMatch();
+ $ufmatch = new CRM_Core_DAO_UFMatch();
$ufmatch->domain_id = CRM_Core_Config::domainID();
- $ufmatch->uf_id = $userKey;
+ $ufmatch->uf_id = $userKey;
if (!$ufmatch->find(TRUE)) {
$transaction = new CRM_Core_Transaction();
$conflict = CRM_Core_DAO::singleValueQuery($sql, $params);
if (!$conflict) {
- $found = TRUE;
+ $found = TRUE;
$ufmatch->contact_id = $dao->contact_id;
- $ufmatch->uf_name = $uniqId;
+ $ufmatch->uf_name = $uniqId;
}
}
}
}
- $contactId = CRM_Contact_BAO_Contact::createProfileContact($params, CRM_Core_DAO::$_nullArray);
+ $contactId = CRM_Contact_BAO_Contact::createProfileContact($params, CRM_Core_DAO::$_nullArray);
$ufmatch->contact_id = $contactId;
- $ufmatch->uf_name = $uniqId;
+ $ufmatch->uf_name = $uniqId;
}
// check that there are not two CMS IDs matching the same CiviCRM contact - this happens when a civicrm
1 => $ufmatch->contact_id,
2 => $uf,
3 => $ufmatch->uf_id,
- 4 => $conflict
+ 4 => $conflict,
)
);
unset($conflict);
}
/**
- * Update the uf_name in the user object
+ * Update the uf_name in the user object.
*
- * @param int $contactId id of the contact to update
+ * @param int $contactId
+ * Id of the contact to update.
*
* @return void
- * @access public
- * @static
*/
- static function updateUFName($contactId) {
+ public static function updateUFName($contactId) {
if (!$contactId) {
return;
}
$update = FALSE;
// 1.do check for contact Id.
- $ufmatch = new CRM_Core_DAO_UFMatch();
+ $ufmatch = new CRM_Core_DAO_UFMatch();
$ufmatch->contact_id = $contactId;
- $ufmatch->domain_id = CRM_Core_Config::domainID();
+ $ufmatch->domain_id = CRM_Core_Config::domainID();
if (!$ufmatch->find(TRUE)) {
return;
}
}
/**
- * Update the email value for the contact and user profile
+ * Update the email value for the contact and user profile.
*
- * @param $contactId Int Contact ID of the user
- * @param $emailAddress email to be modified for the user
+ * @param int $contactId
+ * Contact ID of the user.
+ * @param $emailAddress
+ * Email to be modified for the user.
*
* @return void
- * @access public
- * @static
*/
- static function updateContactEmail($contactId, $emailAddress) {
+ public static function updateContactEmail($contactId, $emailAddress) {
$strtolower = function_exists('mb_strtolower') ? 'mb_strtolower' : 'strtolower';
$emailAddress = $strtolower($emailAddress);
- $ufmatch = new CRM_Core_DAO_UFMatch();
+ $ufmatch = new CRM_Core_DAO_UFMatch();
$ufmatch->contact_id = $contactId;
- $ufmatch->domain_id = CRM_Core_Config::domainID();
+ $ufmatch->domain_id = CRM_Core_Config::domainID();
if ($ufmatch->find(TRUE)) {
// Save the email in UF Match table
$ufmatch->uf_name = $emailAddress;
}
else {
//else insert a new email record
- $email = new CRM_Core_DAO_Email();
+ $email = new CRM_Core_DAO_Email();
$email->contact_id = $contactId;
$email->is_primary = 1;
- $email->email = $emailAddress;
+ $email->email = $emailAddress;
$email->save();
$emailID = $email->id;
}
}
/**
- * Delete the object records that are associated with this cms user
+ * Delete the object records that are associated with this cms user.
*
- * @param int $ufID id of the user to delete
+ * @param int $ufID
+ * Id of the user to delete.
*
* @return void
- * @access public
- * @static
*/
- static function deleteUser($ufID) {
+ public static function deleteUser($ufID) {
$ufmatch = new CRM_Core_DAO_UFMatch();
$ufmatch->uf_id = $ufID;
}
/**
- * Get the contact_id given a uf_id
+ * Get the contact_id given a uf_id.
*
- * @param int $ufID Id of UF for which related contact_id is required
+ * @param int $ufID
+ * Id of UF for which related contact_id is required.
*
- * @return int contact_id on success, null otherwise
- * @access public
- * @static
+ * @return int
+ * contact_id on success, null otherwise
*/
- static function getContactId($ufID) {
+ public static function getContactId($ufID) {
if (!isset($ufID)) {
return NULL;
}
}
/**
- * Get the uf_id given a contact_id
+ * Get the uf_id given a contact_id.
*
- * @param int $contactID ID of the contact for which related uf_id is required
+ * @param int $contactID
+ * ID of the contact for which related uf_id is required.
*
- * @return int uf_id of the given contact_id on success, null otherwise
- * @access public
- * @static
+ * @return int
+ * uf_id of the given contact_id on success, null otherwise
*/
- static function getUFId($contactID) {
+ public static function getUFId($contactID) {
if (!isset($contactID)) {
return NULL;
}
/**
* @return bool
*/
- static function isEmptyTable() {
+ public static function isEmptyTable() {
$sql = "SELECT count(id) FROM civicrm_uf_match";
return CRM_Core_DAO::singleValueQuery($sql) > 0 ? FALSE : TRUE;
}
/**
- * Get the list of contact_id
+ * Get the list of contact_id.
*
*
- * @return int contact_id on success, null otherwise
- * @access public
- * @static
+ * @return int
+ * contact_id on success, null otherwise
*/
- static function getContactIDs() {
+ public static function getContactIDs() {
$id = array();
$dao = new CRM_Core_DAO_UFMatch();
$dao->find();
*
* @param int $openId
*
- * @return bool true if allowed to login, false otherwise
- * @access public
- * @static
+ * @return bool
+ * true if allowed to login, false otherwise
*/
- static function getAllowedToLogin($openId) {
+ public static function getAllowedToLogin($openId) {
$ufmatch = new CRM_Core_DAO_UFMatch();
$ufmatch->uf_name = $openId;
$ufmatch->allowed_to_login = 1;
* have id's (it uses OpenIDs, which go in a different field)
*
*
- * @return int next highest unused value for uf_id
- * @access public
- * @static
+ * @return int
+ * next highest unused value for uf_id
*/
- static function getNextUfIdValue() {
+ public static function getNextUfIdValue() {
$query = "SELECT MAX(uf_id)+1 AS next_uf_id FROM civicrm_uf_match";
$dao = CRM_Core_DAO::executeQuery($query);
if ($dao->fetch()) {
*
* @return bool
*/
- static function isDuplicateUser($email) {
+ public static function isDuplicateUser($email) {
$session = CRM_Core_Session::singleton();
$contactID = $session->get('userID');
if (!empty($email) && isset($contactID)) {
/**
* Get uf match values for given uf id or logged in user.
*
- * @param int $ufID uf id.
- *
- * return array $ufValues uf values.
- **
+ * @param int $ufID
+ * Uf id.
*
* @return array
+ * uf values.
*/
- static function getUFValues($ufID = NULL) {
+ public static function getUFValues($ufID = NULL) {
if (!$ufID) {
//get logged in user uf id.
$ufID = CRM_Utils_System::getLoggedInUfID();
static $ufValues;
if ($ufID && !isset($ufValues[$ufID])) {
- $ufmatch = new CRM_Core_DAO_UFMatch();
- $ufmatch->uf_id = $ufID;
+ $ufmatch = new CRM_Core_DAO_UFMatch();
+ $ufmatch->uf_id = $ufID;
$ufmatch->domain_id = CRM_Core_Config::domainID();
if ($ufmatch->find(TRUE)) {
$ufValues[$ufID] = array(
}
return $ufValues[$ufID];
}
-}
+}