class ViewsConditionalHandler in Views Conditional 7

@file Handles conditionals in Views. IF xxx THEN yyy...

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_field
    class \ViewsConditionalHandler

Expanded class hierarchy of ViewsConditionalHandler

1 string reference to 'ViewsConditionalHandler'

views_conditional_views_data in includes/views/views_conditional.views.inc: Implements hook_views_data().

File

includes/views/handlers/views_conditional_handler.inc, line 8: Handles conditionals in Views. IF xxx THEN yyy...

View source

class ViewsConditionalHandler extends views_handler_field {

  // Conditional operators.
  public $conditions = array(
    1 => 'Equal to',
    2 => 'NOT equal to',
    3 => 'Greater than',
    4 => 'Less than',
    5 => 'Empty',
    6 => 'NOT empty',
    7 => 'Contains',
    8 => 'Does NOT contain',
    9 => 'Length Equal to',
    10 => 'Length NOT equal to',
    11 => 'Length Greater than',
    12 => 'Length Less than',
  );

  /**
   * Set default values for form elements.
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['label']['default'] = NULL;
    $options['if'] = array(
      'default' => '',
    );
    $options['condition'] = array(
      'default' => '',
    );
    $options['equalto'] = array(
      'default' => '',
    );
    $options['then'] = array(
      'default' => '',
    );
    $options['or'] = array(
      'default' => '',
    );
    $options['strip_tags'] = array(
      'default' => FALSE,
    );
    return $options;
  }

  /**
   * Views form elements.
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['relationship']['#access'] = FALSE;

    // Display all labels weighted less than the current label.
    $fields = array(
      0 => '- ' . t('no field selected') . ' -',
    );
    foreach ($this->view->display_handler
      ->get_handlers('field') as $field => $handler) {

      // We only use fields up to (not including) this one.
      if ($field == $this->options['id']) {
        break;
      }
      $title = $handler
        ->ui_name();
      $fields[$field] = "[{$field}] == {$title}";
    }
    $form['if'] = array(
      '#type' => 'select',
      '#title' => t('If this field...'),
      '#options' => $fields,
      '#default_value' => $this->options['if'],
    );
    $form['condition'] = array(
      '#type' => 'select',
      '#title' => t('Is...'),
      '#options' => $this->conditions,
      '#default_value' => $this->options['condition'],
    );
    $form['equalto'] = array(
      '#type' => 'textfield',
      '#title' => t('This value'),
      '#description' => t('Input a value to compare the field against.  Replacement variables may be used'),
      '#default_value' => $this->options['equalto'],
    );
    $form['then'] = array(
      '#type' => 'textarea',
      '#title' => t('Then output this...'),
      '#description' => t('Input what should be output.  Replacement variables may be used.'),
      '#default_value' => $this->options['then'],
    );
    $form['or'] = array(
      '#type' => 'textarea',
      '#title' => t('Otherwise, output this...'),
      '#description' => t('Input what should be output if the above conditions do NOT evaluate to true.'),
      '#default_value' => $this->options['or'],
    );
    $form['strip_tags'] = array(
      '#type' => 'checkbox',
      '#title' => t('Strip html tags from the output'),
      '#default_value' => $this->options['strip_tags'],
    );
    $form['replacements'] = array(
      '#type' => 'fieldset',
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
      '#title' => t('Replacement Variables'),
    );
    $form['replacements']['notice'] = array(
      '#markup' => 'You may use any of these replacement variables in the "equals" or the "output" text fields.  If you wish to use brackets ([ or ]), replace them with %5D or %5E.',
      '#prefix' => '<p>',
      '#suffix' => '</p>',
    );
    $items = array(
      'DATE_UNIX => Current date / time, in UNIX timestamp format (' . REQUEST_TIME . ')',
      'DATE_STAMP => Current date / time, in standard format (' . format_date(REQUEST_TIME) . ')',
    );
    foreach ($this->view->display_handler
      ->get_handlers('field') as $field => $handler) {

      // We only use fields up to (not including) this one.
      if ($field == $this->options['id']) {
        break;
      }
      $title = $handler
        ->ui_name();
      $items[] = "[{$field}] == {$title}";
    }
    $form['replacements']['variables'] = array(
      '#markup' => theme('item_list', array(
        'items' => $items,
      )),
    );
  }

  /**
   * Check that everything is in order.
   */
  public function options_validate(&$form, &$form_state) {
    $values =& $form_state['values']['options'];
    if (empty($values['if']) || empty($values['condition']) || empty($values['equalto'])) {
      if (empty($values['if'])) {
        form_set_error('if', t("Please specify a valid field to run a condition on."));
      }
      if (empty($values['condition'])) {
        form_set_error('condition', t("Please select a conditional operator."));
      }

      // We using there is_numeric because values '0', '0.0' counting as empty in PHP language.
      if (empty($values['equalto']) && !in_array($values['condition'], array(
        5,
        6,
      )) && !is_numeric($values['equalto'])) {
        form_set_error('condition', t("Please specify something to compare with."));
      }
    }
  }

  /**
   * Defines summary text for Fields category in Views.
   */
  public function admin_summary() {

    // We using there is_numeric because values '0', '0.0' counting as empty in PHP language.
    if (!empty($this->options['if']) && !empty($this->options['condition']) && (!empty($this->options['equalto']) || in_array($this->options['condition'], array(
      5,
      6,
    )) || is_numeric($this->options['equalto'])) && trim($this->options['then']) != '') {
      return t('If !if is !condition !equalto, output !then, else output !or', array(
        '!if' => $this->options['if'],
        '!condition' => $this->conditions[$this->options['condition']],
        '!equalto' => $this->options['equalto'],
        '!then' => strip_tags($this->options['then']),
        '!or' => strip_tags($this->options['or']),
      ));
    }
    else {
      return t('Invalid field selection');
    }
  }

  /**
   * Remove advanced rendering options from form.
   */
  public function allow_advanced_render() {
    return FALSE;
  }

  /**
   * Defines field alias.  No query manipulation necessary.
   */
  public function query() {
    $this->field_alias = 'views_conditional_' . $this->position;
  }

  /**
   * Cleans a variable for handling later.
   */
  public function clean_var($var) {
    $unparsed = isset($var->last_render) ? $var->last_render : '';
    return $this->options['strip_tags'] ? trim(strip_tags($unparsed)) : trim($unparsed);
  }

  /**
   * Renders the final output based on conditional input.
   */
  public function render($values) {
    $if = $this->options['if'];
    $condition = $this->options['condition'];
    $equalto = $this->options['equalto'];
    $then = $this->options['then'];
    $or = $this->options['or'] ? $this->options['or'] : '';

    // Gather field information.
    $fields = $this->view->display_handler
      ->get_handlers('field');

    // Search through field information for possible replacement variables.
    foreach ($this->view->display_handler
      ->get_field_labels() as $key => $var) {

      // If we find a replacement variable, replace it.
      if (strpos($equalto, "[{$key}]") !== FALSE) {
        $field = $this
          ->clean_var($fields[$key]);
        $equalto = str_replace("[{$key}]", $field, $equalto);
      }
      if (strpos($then, "[{$key}]") !== FALSE) {
        $field = $this
          ->clean_var($fields[$key]);
        $then = str_replace("[{$key}]", $field, $then);
      }
      if (strpos($or, "[{$key}]") !== FALSE) {
        $field = $this
          ->clean_var($fields[$key]);
        $or = str_replace("[{$key}]", $field, $or);
      }
    }

    // If we find a date stamp replacement, replace that.
    if (strpos($equalto, 'DATE_STAMP') !== FALSE) {
      $equalto = str_replace('DATE_STAMP', format_date(REQUEST_TIME), $equalto);
    }
    if (strpos($then, 'DATE_STAMP') !== FALSE) {
      $then = str_replace('DATE_STAMP', format_date(REQUEST_TIME), $then);
    }
    if (strpos($or, 'DATE_STAMP') !== FALSE) {
      $or = str_replace('DATE_STAMP', format_date(REQUEST_TIME), $or);
    }

    // If we find a unix date stamp replacement, replace that.
    if (strpos($equalto, 'DATE_UNIX') !== FALSE) {
      $equalto = str_replace('DATE_UNIX', REQUEST_TIME, $equalto);
    }
    if (strpos($then, 'DATE_UNIX') !== FALSE) {
      $then = str_replace('DATE_UNIX', REQUEST_TIME, $then);
    }
    if (strpos($or, 'DATE_UNIX') !== FALSE) {
      $or = str_replace('DATE_UNIX', REQUEST_TIME, $or);
    }

    // Strip tags on the "if" field.  Otherwise it appears to
    // output as <div class="xxx">Field data</div>...
    // ...which of course makes it difficult to compare.
    $r = isset($fields["{$if}"]->last_render) ? trim(strip_tags($fields["{$if}"]->last_render, '<img>')) : NULL;

    // Run conditions.
    switch ($condition) {

      // Equal to.
      case 1:
        if ($r == $equalto) {
          return $then;
        }
        else {
          return $or;
        }
        break;

      // Not equal to.
      case 2:
        if ($r !== $equalto) {
          return $then;
        }
        else {
          return $or;
        }
        break;

      // Greater than.
      case 3:
        if ($r > $equalto) {
          return $then;
        }
        else {
          return $or;
        }
        break;

      // Less than.
      case 4:
        if ($r < $equalto) {
          return $then;
        }
        else {
          return $or;
        }
        break;

      // Empty.
      case 5:
        if (empty($r)) {
          return $then;
        }
        else {
          return $or;
        }
        break;

      // Not empty.
      case 6:
        if (!empty($r)) {
          return $then;
        }
        else {
          return $or;
        }
        break;

      // Contains
      case 7:
        if (mb_stripos($r, $equalto) !== FALSE) {
          return $then;
        }
        else {
          return $or;
        }
        break;

      // Does NOT contain
      case 8:
        if (mb_stripos($r, $equalto) === FALSE) {
          return $then;
        }
        else {
          return $or;
        }
        break;

      // Length Equal to.
      case 9:
        if (mb_strlen($r) == $equalto) {
          return $then;
        }
        else {
          return $or;
        }
        break;

      // Length Not equal to.
      case 10:
        if (mb_strlen($r) !== $equalto) {
          return $then;
        }
        else {
          return $or;
        }
        break;

      // Length Greater than.
      case 11:
        if (mb_strlen($r) > $equalto) {
          return $then;
        }
        else {
          return $or;
        }
        break;

      // Length Less than.
      case 12:
        if (mb_strlen($r) < $equalto) {
          return $then;
        }
        else {
          return $or;
        }
        break;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ViewsConditionalHandler::$conditions	public	property
ViewsConditionalHandler::admin_summary	public	function	Defines summary text for Fields category in Views. Overrides views_handler_field::admin_summary
ViewsConditionalHandler::allow_advanced_render	public	function	Remove advanced rendering options from form. Overrides views_handler_field::allow_advanced_render
ViewsConditionalHandler::clean_var	public	function	Cleans a variable for handling later.
ViewsConditionalHandler::options_form	public	function	Views form elements. Overrides views_handler_field::options_form
ViewsConditionalHandler::options_validate	public	function	Check that everything is in order. Overrides views_handler::options_validate
ViewsConditionalHandler::option_definition	public	function	Set default values for form elements. Overrides views_handler_field::option_definition
ViewsConditionalHandler::query	public	function	Defines field alias. No query manipulation necessary. Overrides views_handler_field::query
ViewsConditionalHandler::render	public	function	Renders the final output based on conditional input. Overrides views_handler_field::render
views_handler::$handler_type	public	property	The type of the handler, for example filter/footer/field.
views_handler::$query	public	property	Where the $query object will reside:.	1
views_handler::$real_field	public	property	The actual field in the database table, maybe different on other kind of query plugins/special handlers.
views_handler::$relationship	public	property	The relationship used for this field.
views_handler::$table_alias	public	property	The alias of the table of this handler which is used in the query.
views_handler::$view	public	property	The top object of a view. Overrides views_object::$view
views_handler::accept_exposed_input	public	function	Take input from exposed handlers and assign to this handler, if necessary.	1
views_handler::access	public	function	Check whether current user has access to this handler.	10
views_handler::broken	public	function	Determine if the handler is considered 'broken'.	6
views_handler::can_expose	public	function	Determine if a handler can be exposed.	2
views_handler::case_transform	public	function	Transform a string by a certain method.
views_handler::ensure_my_table	public	function	Ensure the main table for this handler is in the query. This is used a lot.	8
views_handler::exposed_form	public	function	Render our chunk of the exposed handler form when selecting.	1
views_handler::exposed_info	public	function	Get information about the exposed form for the form renderer.	1
views_handler::exposed_submit	public	function	Submit the exposed handler form.
views_handler::exposed_validate	public	function	Validate the exposed handler form.	4
views_handler::expose_form	public	function	Form for exposed handler options.	2
views_handler::expose_options	public	function	Set new exposed option defaults when exposed setting is flipped on.	2
views_handler::expose_submit	public	function	Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data.
views_handler::expose_validate	public	function	Validate the options form.	1
views_handler::extra_options	public	function	Provide defaults for the handler.
views_handler::extra_options_form	public	function	Provide a form for setting options.	1
views_handler::extra_options_submit	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
views_handler::extra_options_validate	public	function	Validate the options form.
views_handler::get_field	public	function	Shortcut to get a handler's raw field value.
views_handler::get_join	public	function	Get the join object that should be used for this handler.
views_handler::groupby_form	public	function	Provide a form for aggregation settings.	1
views_handler::groupby_form_submit	public	function	Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.	1
views_handler::has_extra_options	public	function	If a handler has 'extra options' it will get a little settings widget and another form called extra_options.	1
views_handler::is_a_group	public	function	Returns TRUE if the exposed filter works like a grouped filter.	1
views_handler::is_exposed	public	function	Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::multiple_exposed_input	public	function	Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets.	1
views_handler::needs_style_plugin	public	function	Determine if the argument needs a style plugin.	1
views_handler::placeholder	public	function	Provides a unique placeholders for handlers.
views_handler::post_execute	public	function	Run after the view is executed, before the result is cached.	1
views_handler::pre_query	public	function	Run before the view is built.	1
views_handler::sanitize_value	public	function	Sanitize the value for output.
views_handler::set_relationship	public	function	Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_button	public	function	Shortcut to display the expose/hide button.	2
views_handler::show_expose_form	public	function	Shortcut to display the exposed options form.
views_handler::store_exposed_input	public	function	If set to remember exposed input in the session, store it there.	1
views_handler::use_group_by	public	function	Provides the handler some groupby.	2
views_handler::validate	public	function	Validates the handler against the complete View.	1
views_handler_field::$additional_fields	public	property	Stores additional fields which get added to the query. The generated aliases are stored in $aliases.
views_handler_field::$aliases	public	property
views_handler_field::$field_alias	public	property
views_handler_field::$last_render_index	protected	property	Keeps track of the last render index.
views_handler_field::$original_value	public	property	The field value prior to any rewriting.
views_handler_field::add_additional_fields	public	function	Add 'additional' fields to the query.
views_handler_field::add_self_tokens	public	function	Add any special tokens this field might use for itself.	4
views_handler_field::advanced_render	public	function	Render a field using advanced settings.
views_handler_field::click_sort	public	function	Called to determine what to tell the clicksorter.	1
views_handler_field::click_sortable	public	function	Determine if this field is click sortable.	1
views_handler_field::construct	public	function	Construct a new field handler. Overrides views_object::construct	17
views_handler_field::document_self_tokens	public	function	Document any special tokens this field might use for itself.	4
views_handler_field::element_classes	public	function	Return the class of the field.
views_handler_field::element_label_classes	public	function	Return the class of the field's label.
views_handler_field::element_label_type	public	function	Return an HTML element for the label based upon the field's element type.
views_handler_field::element_type	public	function	Return an HTML element based upon the field's element type.	2
views_handler_field::element_wrapper_classes	public	function	Return the class of the field's wrapper.
views_handler_field::element_wrapper_type	public	function	Return an HTML element for the wrapper based upon the field's element type.
views_handler_field::get_elements	public	function	Provide a list of elements valid for field HTML.
views_handler_field::get_render_tokens	public	function	Get the 'render' tokens to use for advanced rendering.
views_handler_field::get_token_values_recursive	public	function	Recursive function to add replacements for nested query string parameters.
views_handler_field::get_value	public	function	Get the value that's supposed to be rendered.	3
views_handler_field::init	public	function	Init the handler with necessary data. Overrides views_handler::init	11
views_handler_field::is_value_empty	public	function	Checks if a field value is empty.
views_handler_field::label	public	function	Get this field's label.
views_handler_field::options_submit	public	function	Performs some cleanup tasks on the options array before saving it. Overrides views_handler::options_submit	1
views_handler_field::pre_render	public	function	Run before any fields are rendered.	8
views_handler_field::render_altered	public	function	Render this field as altered text, from a fieldset set by the user.
views_handler_field::render_as_link	public	function	Render this field as a link, with info from a fieldset set by the user.
views_handler_field::render_text	public	function	Perform an advanced text render for the item.
views_handler_field::render_trim_text	public	function	Trim the field down to the specified length.
views_handler_field::theme	public	function	Call out to the theme() function.
views_handler_field::theme_functions	public	function	Build a list of suitable theme functions for this view.
views_handler_field::tokenize_value	public	function	Replace a value with tokens from the last field.
views_handler_field::ui_name	public	function	Return a string representing this handler's name in the UI. Overrides views_handler::ui_name	1
views_handler_field::use_string_group_by	public	function	Determines if this field will be available as an option to group the result by in the style settings.
views_object::$definition	public	property	Handler's definition.
views_object::$options	public	property	Except for displays, options for the object will be held here.	1
views_object::altered_option_definition		function	Collect this handler's option definition and alter them, ready for use.
views_object::destroy	public	function	Destructor.	2
views_object::export_option	public	function		1
views_object::export_options	public	function
views_object::export_option_always	public	function	Always exports the option, regardless of the default value.
views_object::options Deprecated	public	function	Set default options on this object.	1
views_object::set_default_options	public	function	Set default options.
views_object::set_definition	public	function	Let the handler know what its full definition is.
views_object::unpack_options	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable	public	function	Unpack a single option definition.
views_object::unpack_translatables	public	function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults	public	function

You are here

class ViewsConditionalHandler in Views Conditional 7

Hierarchy

File

Members

API Navigation