class FlagRulesUIClass in Flag 7.2

UI for inputing flags.

Hierarchy

• class \RulesDataUI
  • class \FlagRulesUIClass implements RulesDataDirectInputFormInterface

1 string reference to 'FlagRulesUIClass'

flag_rules_data_info in ./flag.rules.inc

Implements hook_rules_data_info().

File

./flag.rules.inc, line 57

Rules integration for the Flag module.

class FlagRulesUIClass extends RulesDataUI implements RulesDataDirectInputFormInterface {
  public static function getDefaultMode() {
    return 'input';
  }
  public static function inputForm($name, $info, $settings, RulesPlugin $element) {
    $options = _flag_rules_flags_options(isset($info['flag_type']) ? $info['flag_type'] : NULL);
    $header = array(
      'title' => t('Flag:'),
      'type' => t('The flag type'),
      'global' => t('Is the flag global?'),
    );
    $settings += array(
      $name => isset($info['default value']) ? $info['default value'] : '',
    );
    $form[$name] = array(
      '#type' => 'tableselect',
      '#header' => $header,
      '#options' => $options,
      '#required' => empty($info['optional']),
      '#multiple' => FALSE,
      '#default_value' => $settings[$name],
      '#empty' => t('There is no suiting flag available.'),
    );
    return $form;
  }
  public static function render($value) {
    $flag = flag_get_flag($value);
    if ($flag === FALSE) {
      return array();
    }
    return array(
      'content' => array(
        '#markup' => check_plain($flag
          ->get_title()),
      ),
      '#attributes' => array(
        'class' => array(
          'rules-parameter-flag',
        ),
      ),
    );
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FlagRulesUIClass::getDefaultMode	public static	function	Specifies the default input mode per data type. Overrides RulesDataUI::getDefaultMode
FlagRulesUIClass::inputForm	public static	function	Constructs the direct input form. Overrides RulesDataDirectInputFormInterface::inputForm
FlagRulesUIClass::render	public static	function	Render the configured value. Overrides RulesDataDirectInputFormInterface::render
RulesDataUI::getTypeInfo	public static	function	Returns the data type and parameter information for the given arguments.
RulesDataUI::renderOptionsLabel	public static	function	Renders the value with a label if an options list is available.
RulesDataUI::selectionForm	public static	function	Provides the selection form for a parameter.