class MongodbUserData in MongoDB 8

Hierarchy

• class \Drupal\mongodb_user\MongodbUserData implements UserDataInterface

1 string reference to 'MongodbUserData'

mongodb_user.services.yml in mongodb_user/mongodb_user.services.yml

mongodb_user/mongodb_user.services.yml

1 service uses MongodbUserData

mongodb.user.data in mongodb_user/mongodb_user.services.yml

Drupal\mongodb_user\MongodbUserData

File

mongodb_user/src/MongodbUserData.php, line 13

Contains \Drupal\mongodb_user\MongodbUserData.

Namespace

Drupal\mongodb_user

class MongodbUserData implements UserDataInterface {

  /**
   * @var MongoCollectionFactory
   */
  protected $mongo;
  public function __construct(MongoCollectionFactory $mongo) {
    $this->mongo = $mongo;
  }

  /**
   * Returns data stored for a user account.
   *
   * @param string $module
   *   The name of the module the data is associated with.
   * @param integer $uid
   *   (optional) The user account ID the data is associated with.
   * @param string $name
   *   (optional) The name of the data key.
   *
   * @return mixed|array
   *   The requested user account data, depending on the arguments passed:
   *   - For $module, $name, and $uid, the stored value is returned, or NULL if
   *     no value was found.
   *   - For $module and $uid, an associative array is returned that contains
   *     the stored data name/value pairs.
   *   - For $module and $name, an associative array is returned whose keys are
   *     user IDs and whose values contain the stored values.
   *   - For $module only, an associative array is returned that contains all
   *     existing data for $module in all user accounts, keyed first by user ID
   *     and $name second.
   */
  public function get($module, $uid = NULL, $name = NULL) {
    $args = func_get_args();
    $result = $this->mongo
      ->get('user_data')
      ->find($this
      ->getQuery($args));
    switch (isset($uid) + isset($name)) {
      case 2:
        foreach ($result as $row) {
          return $row['value'];
        }
        return NULL;
      case 1:
        $return = [];
        $key_field = isset($uid) ? 'name' : 'uid';
        foreach ($result as $row) {
          $return[$row[$key_field]] = $row['value'];
        }
        return $return;
      case 0:
        $return = [];
        foreach ($result as $row) {
          $return[$row['uid']][$row['name']] = $row['value'];
        }
        return $return;
    }
  }

  /**
   * Stores data for a user account.
   *
   * @param string $module
   *   The name of the module the data is associated with.
   * @param integer $uid
   *   The user account ID the data is associated with.
   * @param string $name
   *   The name of the data key.
   * @param mixed $value
   *   The value to store. Non-scalar values are serialized automatically.
   *
   * @return void
   */
  public function set($module, $uid, $name, $value) {
    $criteria = [
      'module' => $module,
      'uid' => $uid,
      'name' => $name,
    ];
    $this->mongo
      ->get('user_data')
      ->update($criteria, $criteria + [
      'value' => $value,
    ], [
      'upsert' => TRUE,
    ]);
  }

  /**
   * Deletes data stored for a user account.
   *
   * @param string|array $module
   *   (optional) The name of the module the data is associated with. Can also
   *   be an array to delete the data of multiple modules.
   * @param integer|array $uid
   *   (optional) The user account ID the data is associated with. If omitted,
   *   all data for $module is deleted. Can also be an array of IDs to delete
   *   the data of multiple user accounts.
   * @param string $name
   *   (optional) The name of the data key. If omitted, all data associated with
   *   $module and $uid is deleted.
   *
   * @return void
   */
  public function delete($module = NULL, $uid = NULL, $name = NULL) {
    if ($query = $this
      ->getQuery(func_get_args())) {
      $this->mongo
        ->get('user_data')
        ->remove($query);
    }
  }

  /**
   * @param $args
   *   A list of $module, $uid, $name
   * @return array
   */
  protected function getQuery($args) {
    $query = [];
    foreach ([
      'module',
      'uid',
      'name',
    ] as $i => $field) {
      if (isset($args[$i])) {
        $x = $args[$i];
        $query[$field] = is_array($x) ? [
          '$in' => $x,
        ] : $x;
      }
    }
    return $query;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MongodbUserData::$mongo	protected	property
MongodbUserData::delete	public	function	Deletes data stored for a user account. Overrides UserDataInterface::delete
MongodbUserData::get	public	function	Returns data stored for a user account. Overrides UserDataInterface::get
MongodbUserData::getQuery	protected	function
MongodbUserData::set	public	function	Stores data for a user account. Overrides UserDataInterface::set
MongodbUserData::__construct	public	function