You are here

Home » API reference » Taxonomy Lineage 7 » lineage_handler_field.inc

class lineage_handler_field in Taxonomy Lineage 7

Same name and namespace in other branches
  1. 6 lineage_handler_field.inc \lineage_handler_field

Field handler for Taxonomy: Hierarchy.

Hierarchy

Expanded class hierarchy of lineage_handler_field

2 string references to 'lineage_handler_field'
lineage_views_data in ./lineage.views.inc
Implementation of hook_views_data().
views_plugin_style_lineage_nested::options_form in plugins/views_plugin_style_lineage_nested.inc
Render the given style.

File

handlers/lineage_handler_field.inc, line 11
Views field plugin for lineage's field handler.

View source 
class lineage_handler_field extends views_handler_field {

  /**
   *  Make views aware of new options
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['lineage'] = array();
    $options['lineage']['strip_weights'] = array(
      'default' => FALSE,
    );
    $options['lineage']['machine_safe'] = array(
      'default' => FALSE,
    );
    $options['lineage']['prefix'] = array(
      'default' => '',
    );
    $options['lineage']['suffix'] = array(
      'default' => '',
    );
    $options['lineage']['delimiter'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * Provide formatting options for the field.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $field = $this->content_field;
    $options = $this->options;
    $form['lineage'] = array(
      '#type' => 'fieldset',
      '#title' => t("Lineage string formatting options"),
    );
    $form['lineage']['strip_weights'] = array(
      '#type' => 'checkbox',
      '#title' => t('Strip weights'),
      '#default_value' => $options['lineage']['strip_weights'],
      '#description' => t("The raw lineage entries begin with a number indicating the term weight (for term ordering).  Check to remove weights for display."),
    );
    $form['lineage']['machine_safe'] = array(
      '#type' => 'checkbox',
      '#title' => t('Machine-safe'),
      '#default_value' => $options['lineage']['machine_safe'],
      '#description' => t("Reformats the lineage strings for use in machine-readable contexts.  Be sure to use an appropriate term delimiter (below) and prefix text (above) if you wish this to be a CSS class name; CSS class names must begin with a letter."),
    );
    $form['lineage']['prefix'] = array(
      '#type' => 'textfield',
      '#title' => t('Term prefix'),
      '#default_value' => $options['lineage']['prefix'],
      '#description' => t("Appended before each term name in the lineage.  You may include HTML."),
    );
    $form['lineage']['suffix'] = array(
      '#type' => 'textfield',
      '#title' => t('Term suffix'),
      '#default_value' => $options['lineage']['suffix'],
      '#description' => t("Appended before each term name in the lineage.  You may include HTML."),
    );
    $form['lineage']['delimiter'] = array(
      '#type' => 'textfield',
      '#title' => t('Delimiter between terms'),
      '#default_value' => $options['lineage']['delimiter'],
      '#description' => t("Use %linebreak_code for line breaks.", array(
        '%linebreak_code' => '\\n',
      )),
    );
  }

  /**
   * Render the field.
   */
  function render($values) {
    $options = $this->options ? $this->options : array();
    if ($options['lineage']) {
      extract($options['lineage']);
    }
    $lineage_string = $values->{$this->field_alias};
    if ($lineage_string == '') {
      return '';
    }

    // Split hierarchy string into hierarchical path pieces.
    // Term entries are separated by \n; trim so we don't add empty pieces.
    $term_strings = explode("\n", trim($lineage_string));

    // Compose the rendered hierarchy according to handler form options.
    if ($strip_weights) {
      $term_strings = array_map("lineage_strip_weight", $term_strings);
    }
    if ($machine_safe) {

      // Replace non-alphanumeric characters with a hyphen.
      $non_alphanumeric = '/[^a-zA-Z0-9]+/ ';
      $term_strings = preg_replace($non_alphanumeric, '-', $term_strings);
    }
    if ($prefix || $suffix) {
      foreach ($term_strings as $key => $term_string) {
        $term_string = $prefix . $term_string . $suffix;
        $term_strings[$key] = $term_string;
      }
    }

    // The user may enter "\n" for a linebreak delimiter;
    // replace with actual linebreak character.
    $delimiter = str_replace("\\n", "\n", $delimiter);
    $rendered = implode($delimiter, $term_strings);

    // Be sure to validate and sanitize markup since we allow HTML.
    return filter_xss_admin($rendered);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
lineage_handler_field::options_form function Provide formatting options for the field. Overrides views_handler_field::options_form
lineage_handler_field::option_definition function Make views aware of new options Overrides views_handler_field::option_definition
lineage_handler_field::render function Render the field. 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::options_validate public function Validate the options form. 4
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::admin_summary public function Provide extra data to the administration form Overrides views_handler::admin_summary
views_handler_field::advanced_render public function Render a field using advanced settings.
views_handler_field::allow_advanced_render public function Determine if this field can allow advanced rendering. 1
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::query public function Called to add the field to a query. 22
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