views_handler_field_node.inc

Same filename in other branches
  1. 6.x-3.x modules/node/views_handler_field_node.inc

Definition of views_handler_field_node.

File

modules/node/views_handler_field_node.inc

View source
<?php


/**
 * @file
 * Definition of views_handler_field_node.
 */

/**
 * Field handler to provide simple renderer that allows linking to a node.
 *
 * Definition terms:
 * - link_to_node default: Should this field have the checkbox "link to node"
 *   enabled by default.
 *
 * @ingroup views_field_handlers
 */
class views_handler_field_node extends views_handler_field {
    
    /**
     * {@inheritdoc}
     */
    public function init(&$view, &$options) {
        parent::init($view, $options);
        // Don't add the additional fields to groupby.
        if (!empty($this->options['link_to_node'])) {
            $this->additional_fields['nid'] = array(
                'table' => 'node',
                'field' => 'nid',
            );
            if (module_exists('translation')) {
                $this->additional_fields['language'] = array(
                    'table' => 'node',
                    'field' => 'language',
                );
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        $options['link_to_node'] = array(
            'default' => isset($this->definition['link_to_node default']) ? $this->definition['link_to_node default'] : FALSE,
            'bool' => TRUE,
        );
        return $options;
    }
    
    /**
     * Provide link to node option.
     */
    public function options_form(&$form, &$form_state) {
        $form['link_to_node'] = array(
            '#title' => t('Link this field to the original piece of content'),
            '#description' => t("Enable to override this field's links."),
            '#type' => 'checkbox',
            '#default_value' => !empty($this->options['link_to_node']),
        );
        parent::options_form($form, $form_state);
    }
    
    /**
     * Render whatever the data is as a link to the node.
     *
     * Data should be made XSS safe prior to calling this function.
     */
    public function render_link($data, $values) {
        if (!empty($this->options['link_to_node']) && !empty($this->additional_fields['nid'])) {
            if ($data !== NULL && $data !== '') {
                $this->options['alter']['make_link'] = TRUE;
                $this->options['alter']['path'] = "node/" . $this->get_value($values, 'nid');
                if (isset($this->aliases['language'])) {
                    $languages = language_list();
                    $language = $this->get_value($values, 'language');
                    if (isset($languages[$language])) {
                        $this->options['alter']['language'] = $languages[$language];
                    }
                    else {
                        unset($this->options['alter']['language']);
                    }
                }
            }
            else {
                $this->options['alter']['make_link'] = FALSE;
            }
        }
        return $data;
    }
    
    /**
     * {@inheritdoc}
     */
    public function render($values) {
        $value = $this->get_value($values);
        return $this->render_link($this->sanitize_value($value), $values);
    }

}

Classes

Title Deprecated Summary
views_handler_field_node Field handler to provide simple renderer that allows linking to a node.