class rules_data_type_string in Rules 6

Rules string data type

Hierarchy

• class \rules_data_type
  • class \rules_data_type_string

Related topics

Rules module integrations.

Module integrations with the rules module.

Rules module integrations.

Module integrations with the rules module.

1 string reference to 'rules_data_type_string'

rules_rules_data_type_info in rules/modules/rules.rules.inc

Implementation of hook_rules_data_type_info().

File

rules/modules/rules.rules.inc, line 56

rules integration for the rules module

class rules_data_type_string extends rules_data_type {

  /**
   * Gets the input form for the data
   * Implement it, if your data is not identifiable.
   */
  function get_default_input_form($info, $value, &$form_state) {
    $info += array(
      'long' => FALSE,
      'required' => TRUE,
      'description' => '',
    );
    return array(
      '#type' => $info['long'] ? 'textarea' : 'textfield',
      '#title' => $info['label'],
      '#description' => $info['description'],
      '#required' => $info['required'],
      '#default_value' => $value,
    );
  }

}

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_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.	5
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::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.	5
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_string::get_default_input_form		function	Gets the input form for the data Implement it, if your data is not identifiable. Overrides rules_data_type::get_default_input_form	2