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   use CRM_Contact_AccessTrait;
  23
  24   /**
  25    * Create or update OpenID record.
  26    *
  27    * @param array $params
  28    *
  29    * @return CRM_Core_DAO_OpenID
  30    *
  31    * @throws \API_Exception
  32    * @throws \CRM_Core_Exception
  33    */
  34   public static function create($params) {
  35     CRM_Core_BAO_Block::handlePrimary($params, __CLASS__);
  36     return self::writeRecord($params);
  37   }
  38
  39   /**
  40    * Create or update OpenID record.
  41    *
  42    * @deprecated
  43    *
  44    * @param array $params
  45    *
  46    * @return \CRM_Core_DAO|\CRM_Core_DAO_IM
  47    * @throws \CRM_Core_Exception
  48    * @throws \API_Exception
  49    */
  50   public static function add($params) {
  51     CRM_Core_Error::deprecatedFunctionWarning('use the v4 api');
  52     return self::create($params);
  53   }
  54
  55   /**
  56    * Given the list of params in the params array, fetch the object
  57    * and store the values in the values array
  58    *
  59    * @param array $entityBlock
  60    *   Input parameters to find object.
  61    *
  62    * @return mixed
  63    * @throws \CRM_Core_Exception
  64    */
  65   public static function &getValues($entityBlock) {
  66     return CRM_Core_BAO_Block::getValues('openid', $entityBlock);
  67   }
  68
  69   /**
  70    * Get all the openids for a specified contact_id, with the primary openid being first
  71    *
  72    * @param int $id
  73    *   The contact id.
  74    *
  75    * @param bool $updateBlankLocInfo
  76    *
  77    * @return array
  78    *   the array of openid's
  79    */
  80   public static function allOpenIDs($id, $updateBlankLocInfo = FALSE) {
  81     if (!$id) {
  82       return NULL;
  83     }
  84
  85     $query = "
  86 SELECT civicrm_openid.openid, civicrm_location_type.name as locationType, civicrm_openid.is_primary as is_primary,
  87 civicrm_openid.allowed_to_login as allowed_to_login, civicrm_openid.id as openid_id,
  88 civicrm_openid.location_type_id as locationTypeId
  89 FROM      civicrm_contact
  90 LEFT JOIN civicrm_openid ON ( civicrm_openid.contact_id = civicrm_contact.id )
  91 LEFT JOIN civicrm_location_type ON ( civicrm_openid.location_type_id = civicrm_location_type.id )
  92 WHERE
  93   civicrm_contact.id = %1
  94 ORDER BY
  95   civicrm_openid.is_primary DESC,  openid_id ASC ";
  96     $params = [1 => [$id, 'Integer']];
  97
  98     $openids = $values = [];
  99     $dao = CRM_Core_DAO::executeQuery($query, $params);
 100     $count = 1;
 101     while ($dao->fetch()) {
 102       $values = [
 103         'locationType' => $dao->locationType,
 104         'is_primary' => $dao->is_primary,
 105         'id' => $dao->openid_id,
 106         'openid' => $dao->openid,
 107         'locationTypeId' => $dao->locationTypeId,
 108         'allowed_to_login' => $dao->allowed_to_login,
 109       ];
 110
 111       if ($updateBlankLocInfo) {
 112         $openids[$count++] = $values;
 113       }
 114       else {
 115         $openids[$dao->openid_id] = $values;
 116       }
 117     }
 118     return $openids;
 119   }
 120
 121   /**
 122    * Call common delete function.
 123    *
 124    * @see \CRM_Contact_BAO_Contact::on_hook_civicrm_post
 125    *
 126    * @param int $id
 127    * @deprecated
 128    * @return bool
 129    */
 130   public static function del($id) {
 131     return (bool) self::deleteRecord(['id' => $id]);
 132   }
 133
 134 }