You are here

Home » API reference » Views RSS 7.2 » views_rss_handler_field_term_node_tid.inc

class views_rss_handler_field_term_node_tid in Views RSS 7.2

Same name and namespace in other branches
  1. 6.2 views/views_rss_handler_field_term_node_tid.inc \views_rss_handler_field_term_node_tid

@file Field handler to provide additional control for the All Taxonomy Terms field.

Hierarchy

Expanded class hierarchy of views_rss_handler_field_term_node_tid

1 string reference to 'views_rss_handler_field_term_node_tid'
views_rss_views_data_alter in views/views_rss.views.inc
Implements hook_views_data_alter().

File

views/views_rss_handler_field_term_node_tid.inc, line 8
Field handler to provide additional control for the All Taxonomy Terms field.

View source 
class views_rss_handler_field_term_node_tid extends views_handler_field_term_node_tid {
  function option_definition() {
    $options = parent::option_definition();
    $options['rss_domain'] = array(
      'default' => 'none',
    );
    $options['rss_include_parents'] = array(
      'default' => 0,
    );
    $options['rss_include_vocabulary'] = array(
      'default' => 0,
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);

    // New display type: "RSS <category> element".
    $form['type']['#weight'] = 2;
    $form['separator']['#weight'] = 3;
    $form['type']['#options']['rss_category'] = t('RSS &lt;category&gt; element');

    // Additional options for "domain" attribute.
    $form['rss_domain'] = array(
      '#type' => 'select',
      '#title' => t('<em>Domain</em> attribute'),
      '#description' => t("<em>domain</em> attribute identifies the category's taxonomy.") . ' ' . l('[?]', 'http://www.rssboard.org/rss-profile#element-channel-item-category', array(
        'attributes' => array(
          'title' => t('Need more information?'),
        ),
      )),
      '#options' => array(
        'none' => t('None'),
        'path' => t('Path'),
        'alias' => t('URL alias'),
      ),
      '#default_value' => $this->options['rss_domain'],
      '#dependency' => array(
        'radio:options[type]' => array(
          'rss_category',
        ),
      ),
      '#weight' => 3,
    );

    // Output terms with their parents.
    // Example: parent2/parent1/term
    $form['rss_include_parents'] = array(
      '#type' => 'checkbox',
      '#title' => t('Include term parents'),
      '#description' => t('Output terms from hierarchical vocabularies together with their parents (slash-delimited).'),
      '#default_value' => $this->options['rss_include_parents'],
      '#dependency' => array(
        'radio:options[type]' => array(
          'rss_category',
        ),
      ),
      '#weight' => 4,
    );

    // Output terms with their parents and vocabulary.
    // Example: vocabulary/parent2/parent1/term
    $form['rss_include_vocabulary'] = array(
      '#type' => 'checkbox',
      '#title' => t('Include term vocabulary'),
      '#description' => t('Add vocabulary name before term parents.'),
      '#default_value' => $this->options['rss_include_vocabulary'],
      '#process' => array(
        'ctools_dependent_process',
      ),
      '#dependency_count' => 2,
      '#dependency' => array(
        'radio:options[type]' => array(
          'rss_category',
        ),
        'edit-options-rss-include-parents' => array(
          1,
        ),
      ),
      '#weight' => 5,
    );

    // Hide "Link this field to its term page" checkbox
    // if "RSS <category> element" is selected as "Display type".
    $form['link_to_taxonomy']['#weight'] = 4;
    $form['link_to_taxonomy']['#states'] = array(
      'visible' => array(
        ':input[name="options[type]"]' => array(
          '!value' => 'rss_category',
        ),
      ),
    );
  }
  function pre_render(&$values) {
    parent::pre_render($values);

    // For "RSS <category> element" display type make sure
    // that field value will never be rendered as link.
    if ($this->options['type'] == 'rss_category') {
      foreach ($this->items as $node_nid => $terms) {
        foreach ($terms as $term_tid => $term) {
          if (isset($term['make_link'])) {
            $this->items[$node_nid][$term_tid]['make_link'] = FALSE;
          }
          if ($this->options['rss_domain'] != 'none' && empty($this->options['link_to_taxonomy'])) {
            $this->items[$node_nid][$term_tid]['path'] = 'taxonomy/term/' . $term_tid;
          }
          if ($this->options['rss_include_parents']) {
            $this->items[$node_nid][$term_tid]['parents'] = taxonomy_get_parents_all($term_tid);
          }
          if ($this->options['rss_include_vocabulary']) {
            $this->items[$node_nid][$term_tid]['vocabulary'] = $term['vocabulary'];
          }
        }
      }
    }
  }
  function render_items($items) {
    if (!empty($items)) {
      if ($this->options['type'] == 'rss_category') {
        return implode('', $items);
      }

      // Default render_items().
      return parent::render_items($items);
    }
  }
  function render_item($count, $item) {
    if ($this->options['type'] == 'rss_category') {

      // Basic XML element details.
      $rss_element = array(
        'key' => 'category',
        'value' => $item['name'],
      );

      // Slash-delimited list of all parents with the term at the end.
      // $item['parents'] array contains the current term as well.
      if ($this->options['rss_include_parents'] && isset($item['parents'])) {
        $parents = array();

        // Add vocabulary if required.
        if ($this->options['rss_include_vocabulary'] && isset($item['vocabulary'])) {
          $parents[] = $item['vocabulary'];
        }

        // Add all terms (parent and current one).
        foreach (array_reverse($item['parents']) as $parent) {
          $parents[] = $parent->name;
        }
        if (count($parents)) {
          $rss_element['value'] = implode('/', $parents);
        }
      }

      // Add "domain" attribute if required.
      if ($this->options['rss_domain'] == 'path') {
        $rss_element['attributes']['domain'] = url('<front>', array(
          'absolute' => TRUE,
        )) . $item['path'];
      }
      elseif ($this->options['rss_domain'] == 'alias') {
        $rss_element['attributes']['domain'] = url($item['path'], array(
          'absolute' => TRUE,
        ));
      }

      // Prepare raw-rendered values to store in view results.
      $rendered = array(
        '#item' => $item,
        '#markup' => format_xml_elements(array(
          $rss_element,
        )),
        '#rss_element' => $rss_element,
        '#settings' => $this->options,
      );

      // Store raw-rendered values in view results, the same way
      // as values from standard field formatters are added.
      $row_index = $this->view->row_index;
      $field_name = 'field_' . $this->field;
      $this->view->result[$row_index]->{$field_name}[$count] = array(
        'rendered' => $rendered,
        'raw' => $item,
      );

      // Return formatted XML element.
      return format_xml_elements(array(
        $rss_element,
      ));
    }

    // Standard Views render_item().
    return parent::render_item($count, $item);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::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::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::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::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::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_handler_field_prerender_list::$items public property Stores all items which are used to render the items.
views_handler_field_prerender_list::allow_advanced_render public function Determine if advanced rendering is allowed. Overrides views_handler_field::allow_advanced_render
views_handler_field_prerender_list::get_items public function Return an array of items for the field.
views_handler_field_prerender_list::get_value public function Get the value that's supposed to be rendered. Overrides views_handler_field::get_value
views_handler_field_prerender_list::render public function Render the field. Overrides views_handler_field::render
views_handler_field_term_node_tid::add_self_tokens public function Add any special tokens this field might use for itself. Overrides views_handler_field::add_self_tokens
views_handler_field_term_node_tid::document_self_tokens public function Document any special tokens this field might use for itself. Overrides views_handler_field::document_self_tokens
views_handler_field_term_node_tid::init public function Init the handler with necessary data. Overrides views_handler_field::init
views_handler_field_term_node_tid::query public function Add this term to the query. Overrides views_handler_field::query
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
views_rss_handler_field_term_node_tid::options_form function Provide "link to term" option. Overrides views_handler_field_term_node_tid::options_form
views_rss_handler_field_term_node_tid::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler_field_term_node_tid::option_definition
views_rss_handler_field_term_node_tid::pre_render function Run before any fields are rendered. Overrides views_handler_field_term_node_tid::pre_render
views_rss_handler_field_term_node_tid::render_item function Overrides views_handler_field_term_node_tid::render_item
views_rss_handler_field_term_node_tid::render_items function Render all items in this field together. Overrides views_handler_field_prerender_list::render_items