class rules_data_type_relationship in User Relationships 6

Defines the rules relationship data type.

Hierarchy

• class \rules_data_type
  • class \rules_data_type_relationship

1 string reference to 'rules_data_type_relationship'

user_relationships_rules_rules_data_type_info in user_relationships_rules/user_relationships_rules.rules.inc

Implementation of hook_rules_data_type_info().

File

user_relationships_rules/user_relationships_rules.rules.inc, line 125

rules integration for the system module

class rules_data_type_relationship extends rules_data_type {
  function load($rid) {
    return user_relationships_load(array(
      'rid' => $rid,
    ));
  }
  function get_identifier() {
    $relationship =& $this
      ->get();
    return $relationship->rid;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
rules_data_type::$type		property
rules_data_type::$_data		property
rules_data_type::$_info		property
rules_data_type::check_value		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::construct		function	Constructor
rules_data_type::eval_input		function	Returns whether the input evaluator should be used for this data
rules_data_type::get		function	Gets the data
rules_data_type::get_default_input_form		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::get_info		function	Gets the information about this data type.
rules_data_type::init		function	Inititate the data
rules_data_type::is_identifiable		function	Returns whether this data is identifiable
rules_data_type::is_savable		function	Returns whether this data is savable
rules_data_type::save		function	Makes changes to the data permanent. Implement it, if your data type is savable.	1
rules_data_type::update		function	Replaces the data with the new one
rules_data_type::uses_input_form		function	Returns whether this data makes use of an input form for creating an instance on the fly.
rules_data_type_relationship::get_identifier		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::get_identifier
rules_data_type_relationship::load		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::load