1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
<?php
namespace Drupal\user;
/**
* Defines the user data service interface.
*/
interface UserDataInterface {
/**
* Returns data stored for a user account.
*
* @param string $module
* The name of the module the data is associated with.
* @param int $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);
/**
* Stores data for a user account.
*
* @param string $module
* The name of the module the data is associated with.
* @param int $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.
*/
public function set($module, $uid, $name, $value);
/**
* 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 int|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.
*/
public function delete($module = NULL, $uid = NULL, $name = NULL);
}
|
