class rules_data_type_user in Rules 6
Defines the user data type
Hierarchy
- class \rules_data_type
- class \rules_data_type_user
Expanded class hierarchy of rules_data_type_user
Related topics
1 string reference to 'rules_data_type_user'
- user_rules_data_type_info in rules/
modules/ user.rules.inc - Implementation of hook_rules_data_type_info().
File
- rules/
modules/ user.rules.inc, line 276 - rules integration for the user module
View source
class rules_data_type_user extends rules_data_type {
function load($uid) {
return user_load($uid);
}
function get_identifier() {
$user = $this
->get();
return $user->uid;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
rules_data_type:: |
property | |||
rules_data_type:: |
property | |||
rules_data_type:: |
property | |||
rules_data_type:: |
function | Checks the value of your data type. E.g. the number data type uses this to make sure the value is a number. | 3 | |
rules_data_type:: |
function | Constructor | ||
rules_data_type:: |
function | Returns whether the input evaluator should be used for this data | ||
rules_data_type:: |
function | Gets the data | ||
rules_data_type:: |
function | Gets an input form for creating an instance of your data type. Implement it, if your data type has set use_input_form to TRUE. | 1 | |
rules_data_type:: |
function | Gets the information about this data type. | ||
rules_data_type:: |
function | Inititate the data | ||
rules_data_type:: |
function | Returns whether this data is identifiable | ||
rules_data_type:: |
function | Returns whether this data is savable | ||
rules_data_type:: |
function | Makes changes to the data permanent. Implement it, if your data type is savable. | 1 | |
rules_data_type:: |
function | Replaces the data with the new one | ||
rules_data_type:: |
function | Returns whether this data makes use of an input form for creating an instance on the fly. | ||
rules_data_type_user:: |
function |
Gets the identifier of this data, which can be of every php data type - even an array.
Implement it, if your data type is identifiable. Overrides rules_data_type:: |
||
rules_data_type_user:: |
function |
Loads the data identified with an identifier as returned by get_identifier().
Just return the data or FALSE if loading the data failed. Overrides rules_data_type:: |