Update version in comments
[civicrm-core.git] / CRM / Core / BAO / UFMatch.php
index f33d6edfcb236088b0ed43b6c07b2ef0ba2d3799..d0fb614a30b679dd84dfb9cdc2f5b1c3df557526 100644 (file)
@@ -23,7 +23,7 @@
  | 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
    */
   public static function create($params) {
     $hook = empty($params['id']) ? 'create' : 'edit';
@@ -79,7 +74,6 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch {
    * @param bool $isLogin
    *
    * @return void
-   * @static
    */
   public static function synchronize(&$user, $update, $uf, $ctype, $isLogin = FALSE) {
     $userSystem = CRM_Core_Config::singleton()->userSystem;
@@ -129,16 +123,16 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch {
     }
 
     //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, '');
       }
     }
@@ -150,8 +144,8 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch {
 
     // 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,
@@ -184,12 +178,11 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch {
    *   The name of the user framework.
    * @param int $status
    *   Returns the status if user created or already exits (used for CMS sync).
-   *
-   * @param null $ctype
+   * @param string $ctype
+   *   contact type
    * @param bool $isLogin
    *
-   * @return the ufmatch object that was found or created
-   * @static
+   * @return CRM_Core_DAO_UFMatch|bool
    */
   public static function &synchronizeUFMatch(&$user, $userKey, $uniqId, $uf, $status = NULL, $ctype = NULL, $isLogin = FALSE) {
     $config = CRM_Core_Config::singleton();
@@ -202,9 +195,9 @@ class CRM_Core_BAO_UFMatch extends CRM_Core_DAO_UFMatch {
     $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();
@@ -261,9 +254,9 @@ AND    domain_id = %2
         $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;
         }
       }
 
@@ -310,9 +303,9 @@ AND    domain_id = %2
           }
         }
 
-        $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
@@ -363,13 +356,12 @@ AND    domain_id    = %4
   }
 
   /**
-   * 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.
    *
    * @return void
-   * @static
    */
   public static function updateUFName($contactId) {
     if (!$contactId) {
@@ -385,9 +377,9 @@ AND    domain_id    = %4
     $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;
     }
@@ -417,7 +409,7 @@ AND    domain_id    = %4
   }
 
   /**
-   * Update the email value for the contact and user profile
+   * Update the email value for the contact and user profile.
    *
    * @param int $contactId
    *   Contact ID of the user.
@@ -425,15 +417,14 @@ AND    domain_id    = %4
    *   Email to be modified for the user.
    *
    * @return void
-   * @static
    */
   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;
@@ -458,10 +449,10 @@ AND    domain_id    = %4
       }
       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;
       }
@@ -474,13 +465,12 @@ AND    domain_id    = %4
   }
 
   /**
-   * 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.
    *
    * @return void
-   * @static
    */
   public static function deleteUser($ufID) {
     $ufmatch = new CRM_Core_DAO_UFMatch();
@@ -491,13 +481,13 @@ AND    domain_id    = %4
   }
 
   /**
-   * 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.
    *
-   * @return int    contact_id on success, null otherwise
-   * @static
+   * @return int
+   *   contact_id on success, null otherwise
    */
   public static function getContactId($ufID) {
     if (!isset($ufID)) {
@@ -515,13 +505,13 @@ AND    domain_id    = %4
   }
 
   /**
-   * 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.
    *
-   * @return int    uf_id of the given contact_id on success, null otherwise
-   * @static
+   * @return int
+   *   uf_id of the given contact_id on success, null otherwise
    */
   public static function getUFId($contactID) {
     if (!isset($contactID)) {
@@ -547,11 +537,11 @@ AND    domain_id    = %4
   }
 
   /**
-   * Get the list of contact_id
+   * Get the list of contact_id.
    *
    *
-   * @return int    contact_id on success, null otherwise
-   * @static
+   * @return int
+   *   contact_id on success, null otherwise
    */
   public static function getContactIDs() {
     $id = array();
@@ -569,8 +559,8 @@ AND    domain_id    = %4
    *
    * @param int $openId
    *
-   * @return bool     true if allowed to login, false otherwise
-   * @static
+   * @return bool
+   *   true if allowed to login, false otherwise
    */
   public static function getAllowedToLogin($openId) {
     $ufmatch = new CRM_Core_DAO_UFMatch();
@@ -587,8 +577,8 @@ AND    domain_id    = %4
    * have id's (it uses OpenIDs, which go in a different field)
    *
    *
-   * @return int     next highest unused value for uf_id
-   * @static
+   * @return int
+   *   next highest unused value for uf_id
    */
   public static function getNextUfIdValue() {
     $query = "SELECT MAX(uf_id)+1 AS next_uf_id FROM civicrm_uf_match";
@@ -627,10 +617,8 @@ AND    domain_id    = %4
    * @param int $ufID
    *   Uf id.
    *
-   * return array  $ufValues uf values.
-   * *
-   *
    * @return array
+   *   uf values.
    */
   public static function getUFValues($ufID = NULL) {
     if (!$ufID) {
@@ -643,8 +631,8 @@ AND    domain_id    = %4
 
     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(
@@ -657,4 +645,5 @@ AND    domain_id    = %4
     }
     return $ufValues[$ufID];
   }
+
 }