CRM/Core/BAO/OpenID.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17
  18 /**
  19  * This class contains function for Open Id
  20  */
  21 class CRM_Core_BAO_OpenID extends CRM_Core_DAO_OpenID {
  22
  23   /**
  24    * Create or update OpenID record.
  25    *
  26    * @param array $params
  27    *
  28    * @return CRM_Core_DAO_OpenID
  29    *
  30    * @throws \API_Exception
  31    * @throws \CRM_Core_Exception
  32    */
  33   public static function create($params) {
  34     CRM_Core_BAO_Block::handlePrimary($params, __CLASS__);
  35     return self::writeRecord($params);
  36   }
  37
  38   /**
  39    * Create or update OpenID record.
  40    *
  41    * @deprecated
  42    *
  43    * @param array $params
  44    *
  45    * @return \CRM_Core_DAO|\CRM_Core_DAO_IM
  46    * @throws \CRM_Core_Exception
  47    * @throws \API_Exception
  48    */
  49   public static function add($params) {
  50     CRM_Core_Error::deprecatedFunctionWarning('use the v4 api');
  51     return self::create($params);
  52   }
  53
  54   /**
  55    * Given the list of params in the params array, fetch the object
  56    * and store the values in the values array
  57    *
  58    * @param array $entityBlock
  59    *   Input parameters to find object.
  60    *
  61    * @return mixed
  62    * @throws \CRM_Core_Exception
  63    */
  64   public static function &getValues($entityBlock) {
  65     return CRM_Core_BAO_Block::getValues('openid', $entityBlock);
  66   }
  67
  68   /**
  69    * Get all the openids for a specified contact_id, with the primary openid being first
  70    *
  71    * @param int $id
  72    *   The contact id.
  73    *
  74    * @param bool $updateBlankLocInfo
  75    *
  76    * @return array
  77    *   the array of openid's
  78    */
  79   public static function allOpenIDs($id, $updateBlankLocInfo = FALSE) {
  80     if (!$id) {
  81       return NULL;
  82     }
  83
  84     $query = "
  85 SELECT civicrm_openid.openid, civicrm_location_type.name as locationType, civicrm_openid.is_primary as is_primary,
  86 civicrm_openid.allowed_to_login as allowed_to_login, civicrm_openid.id as openid_id,
  87 civicrm_openid.location_type_id as locationTypeId
  88 FROM      civicrm_contact
  89 LEFT JOIN civicrm_openid ON ( civicrm_openid.contact_id = civicrm_contact.id )
  90 LEFT JOIN civicrm_location_type ON ( civicrm_openid.location_type_id = civicrm_location_type.id )
  91 WHERE
  92   civicrm_contact.id = %1
  93 ORDER BY
  94   civicrm_openid.is_primary DESC,  openid_id ASC ";
  95     $params = [1 => [$id, 'Integer']];
  96
  97     $openids = $values = [];
  98     $dao = CRM_Core_DAO::executeQuery($query, $params);
  99     $count = 1;
 100     while ($dao->fetch()) {
 101       $values = [
 102         'locationType' => $dao->locationType,
 103         'is_primary' => $dao->is_primary,
 104         'id' => $dao->openid_id,
 105         'openid' => $dao->openid,
 106         'locationTypeId' => $dao->locationTypeId,
 107         'allowed_to_login' => $dao->allowed_to_login,
 108       ];
 109
 110       if ($updateBlankLocInfo) {
 111         $openids[$count++] = $values;
 112       }
 113       else {
 114         $openids[$dao->openid_id] = $values;
 115       }
 116     }
 117     return $openids;
 118   }
 119
 120   /**
 121    * Call common delete function.
 122    *
 123    * @param int $id
 124    *
 125    * @return bool
 126    */
 127   public static function del($id) {
 128     return CRM_Contact_BAO_Contact::deleteObjectWithPrimary('OpenID', $id);
 129   }
 130
 131 }