yoti-8.x-2.5/src/Models/YotiUserModel.php

<?php

namespace Drupal\yoti\Models;

use Drupal\yoti\YotiHelper;
use Yoti\ActivityDetails;

/**
 * Class YotiUserModel.
 *
 * @package Drupal\yoti\Models
 * @author Moussa Sidibe <websdk@yoti.com>
 */
class YotiUserModel {

  /**
   * Get Yoti user profile by user Id.
   *
   * @param int $userId
   *   User Id.
   *
   * @return mixed
   *   Yoti user profile.
   */
  public static function getYotiUserById($userId) {
    $userProfile = NULL;
    if (!empty($userId)) {
      $userProfile = \Drupal::database()
        ->select(YotiHelper::YOTI_USER_TABLE_NAME, 'u')
        ->fields('u')
        ->condition('uid', (int) $userId)
        ->range(0, 1)
        ->execute()
        ->fetchAssoc();
    }
    return $userProfile;
  }

  /**
   * Schema for Yoti user table.
   */
  public static function getYotiUserTableSchema() {
    return [
      'description' => 'Stores Yoti user data.',
      'fields' => [
        'id' => [
          'description' => 'Unique identifier',
          'type' => 'serial',
          'unsigned' => TRUE,
          'not null' => TRUE,
        ],
        'uid' => [
          'description' => 'Drupal user ID',
          'type' => 'int',
          'not null' => TRUE,
          'unsigned' => TRUE,
        ],
        'identifier' => [
          'description' => 'Identifier',
          'type' => 'varchar',
          'length' => 255,
          'not null' => TRUE,
        ],
        'data' => [
          'description' => 'Yoti user data',
          'type' => 'text',
        ],
      ],
      'primary key' => [
        'id',
      ],
      'unique keys' => [
        'uid' => [
          'uid',
        ],
      ],
      // For documentation purposes only; foreign keys are not created in the
      // database.
      'foreign keys' => [
        'data_user' => [
          'table' => 'users',
          'columns' => [
            'uid' => 'uid',
          ],
        ],
      ],
    ];
  }

  /**
   * Return fields to be removed from Yoti users table.
   *
   * @return array
   *   Fields to remove.
   */
  public static function removeDuplicatedFieldsFromYotiUserTable() {
    $table_name = YotiHelper::YOTI_USER_TABLE_NAME;
    $ret = [];
    $dbConn = \Drupal::database();
    $ret[] = $dbConn->schema()->dropField($table_name, 'selfie_filename');
    $ret[] = $dbConn->schema()->dropField($table_name, 'phone_number');
    $ret[] = $dbConn->schema()->dropField($table_name, 'date_of_birth');
    $ret[] = $dbConn->schema()->dropField($table_name, 'given_names');
    $ret[] = $dbConn->schema()->dropField($table_name, 'family_name');
    $ret[] = $dbConn->schema()->dropField($table_name, 'nationality');
    $ret[] = $dbConn->schema()->dropField($table_name, 'gender');
    $ret[] = $dbConn->schema()->dropField($table_name, 'email_address');

    return $ret;
  }

  /**
   * Get user Drupal Uid by Yoti user Id.
   *
   * @param int $yotiId
   *   Yoti user Id.
   * @param string $field
   *   User field to look up.
   *
   * @return mixed
   *   Drupal User Uid.
   *
   * @throws \InvalidArgumentException
   */
  public static function getUserUidByYotiId($yotiId, $field) {
    // Check that field is available in the Yoti user table schema.
    $schema = self::getYotiUserTableSchema();
    if (!in_array($field, array_keys($schema['fields']))) {
      throw new \InvalidArgumentException(t('"%field_name" is not a valid Yoti field.', [
        '%field_name' => $field,
      ]));
    }

    $col = NULL;
    if (!empty($yotiId) && !empty($field)) {
      $col = \Drupal::database()
        ->select(YotiHelper::YOTI_USER_TABLE_NAME, 'u')
        ->fields('u', ['uid'])
        ->condition($field, $yotiId)
        ->range(0, 1)
        ->execute()
        ->fetchCol();
    }
    return $col;
  }

  /**
   * Create Yoti user.
   *
   * @param int $userId
   *   User Id.
   * @param \Yoti\ActivityDetails $activityDetails
   *   Yoti user data.
   * @param array $meta
   *   User meta data.
   *
   * @throws \Exception
   */
  public static function createYotiUser($userId, ActivityDetails $activityDetails, array $meta) {
    \Drupal::database()->insert(YotiHelper::YOTI_USER_TABLE_NAME)->fields([
      'uid' => $userId,
      'identifier' => $activityDetails->getRememberMeId(),
      'data' => serialize($meta),
    ])->execute();
  }

  /**
   * Delete Yoti user by Id.
   *
   * @param int $userId
   *   User Id.
   */
  public static function deleteYotiUserById($userId) {
    \Drupal::database()->delete(YotiHelper::YOTI_USER_TABLE_NAME)->condition("uid", $userId)->execute();
  }

  /**
   * Get the number of username starting with prefix.
   *
   * @param string $prefix
   *   Yoti username prefix.
   *
   * @return int
   *   Yoti username count.
   */
  public static function getUsernameCountByPrefix($prefix) {
    $usernameCount = 0;
    if (!empty($prefix)) {
      $userQuery = \Drupal::database()->select('users_field_data', 'uf');
      $userQuery->fields('uf', ['name']);
      $userQuery->condition('name', $userQuery->escapeLike($prefix) . '%', 'LIKE');
      $results = $userQuery->execute()->fetchAll();
      $usernameCount = count($results);
    }
    return $usernameCount;
  }

  /**
   * Get the number of user email starting with prefix.
   *
   * @param string $prefix
   *   Yoti user email prefix.
   *
   * @return int
   *   Yoti user email count.
   */
  public static function getUserEmailCountByPrefix($prefix) {
    $emailCount = 0;
    if (!empty($prefix)) {
      $userQuery = \Drupal::database()->select('users_field_data', 'uf');
      $userQuery->fields('uf', ['mail']);
      $userQuery->condition('mail', \Drupal::database()->escapeLike($prefix) . '%', 'LIKE');
      $results = $userQuery->execute()->fetchAll();
      $emailCount = count($results);
    }
    return $emailCount;
  }

}