UserData.php

Same filename in this branch
  1. 8.9.x core/modules/user/src/Plugin/views/field/UserData.php
  2. 8.9.x core/modules/user/src/Plugin/migrate/destination/UserData.php
Same filename in other branches
  1. 9 core/modules/user/src/Plugin/views/field/UserData.php
  2. 9 core/modules/user/src/Plugin/migrate/destination/UserData.php
  3. 9 core/modules/user/src/UserData.php
  4. 10 core/modules/user/src/Plugin/views/field/UserData.php
  5. 10 core/modules/user/src/Plugin/migrate/destination/UserData.php
  6. 10 core/modules/user/src/UserData.php
  7. 11.x core/modules/user/src/Plugin/views/field/UserData.php
  8. 11.x core/modules/user/src/Plugin/migrate/destination/UserData.php
  9. 11.x core/modules/user/src/UserData.php

Namespace

Drupal\user

File

core/modules/user/src/UserData.php

View source
<?php

namespace Drupal\user;

use Drupal\Core\Database\Connection;

/**
 * Defines the user data service.
 */
class UserData implements UserDataInterface {
    
    /**
     * The database connection to use.
     *
     * @var \Drupal\Core\Database\Connection
     */
    protected $connection;
    
    /**
     * Constructs a new user data service.
     *
     * @param \Drupal\Core\Database\Connection $connection
     *   The database connection to use.
     */
    public function __construct(Connection $connection) {
        $this->connection = $connection;
    }
    
    /**
     * {@inheritdoc}
     */
    public function get($module, $uid = NULL, $name = NULL) {
        $query = $this->connection
            ->select('users_data', 'ud')
            ->fields('ud')
            ->condition('module', $module);
        if (isset($uid)) {
            $query->condition('uid', $uid);
        }
        if (isset($name)) {
            $query->condition('name', $name);
        }
        $result = $query->execute();
        // If $module, $uid, and $name were passed, return the value.
        if (isset($name) && isset($uid)) {
            $result = $result->fetchAllAssoc('uid');
            if (isset($result[$uid])) {
                return $result[$uid]->serialized ? unserialize($result[$uid]->value) : $result[$uid]->value;
            }
            return NULL;
        }
        $return = [];
        // If $module and $uid were passed, return data keyed by name.
        if (isset($uid)) {
            foreach ($result as $record) {
                $return[$record->name] = $record->serialized ? unserialize($record->value) : $record->value;
            }
            return $return;
        }
        // If $module and $name were passed, return data keyed by uid.
        if (isset($name)) {
            foreach ($result as $record) {
                $return[$record->uid] = $record->serialized ? unserialize($record->value) : $record->value;
            }
            return $return;
        }
        // If only $module was passed, return data keyed by uid and name.
        foreach ($result as $record) {
            $return[$record->uid][$record->name] = $record->serialized ? unserialize($record->value) : $record->value;
        }
        return $return;
    }
    
    /**
     * {@inheritdoc}
     */
    public function set($module, $uid, $name, $value) {
        $serialized = (int) (!is_scalar($value));
        if ($serialized) {
            $value = serialize($value);
        }
        $this->connection
            ->merge('users_data')
            ->keys([
            'uid' => $uid,
            'module' => $module,
            'name' => $name,
        ])
            ->fields([
            'value' => $value,
            'serialized' => $serialized,
        ])
            ->execute();
    }
    
    /**
     * {@inheritdoc}
     */
    public function delete($module = NULL, $uid = NULL, $name = NULL) {
        $query = $this->connection
            ->delete('users_data');
        // Cast scalars to array so we can consistently use an IN condition.
        if (isset($module)) {
            $query->condition('module', (array) $module, 'IN');
        }
        if (isset($uid)) {
            $query->condition('uid', (array) $uid, 'IN');
        }
        if (isset($name)) {
            $query->condition('name', (array) $name, 'IN');
        }
        $query->execute();
    }

}

Classes

Title Deprecated Summary
UserData Defines the user data service.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.