class views_handler_field_links

A abstract handler which provides a collection of links.

Hierarchy

Expanded class hierarchy of views_handler_field_links

Related topics

File

handlers/views_handler_field_links.inc, line 13

View source
class views_handler_field_links extends views_handler_field {
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        $options['fields'] = array(
            'default' => array(),
        );
        $options['check_access'] = array(
            'default' => FALSE,
        );
        $options['destination'] = array(
            'default' => TRUE,
            'bool' => TRUE,
        );
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function options_form(&$form, &$form_state) {
        parent::options_form($form, $form_state);
        $all_fields = $this->view->display_handler
            ->get_field_labels();
        // Offer to include only those fields that follow this one.
        $field_options = array_slice($all_fields, 0, array_search($this->options['id'], array_keys($all_fields)));
        $form['fields'] = array(
            '#type' => 'checkboxes',
            '#title' => t('Fields'),
            '#description' => t('Fields to be included as links.'),
            '#options' => $field_options,
            '#default_value' => $this->options['fields'],
            '#required' => TRUE,
        );
        $form['check_access'] = array(
            '#type' => 'checkbox',
            '#title' => t('Evaluate router path for access'),
            '#default_value' => $this->options['check_access'],
            '#description' => t('Will check if the path exists and is accessible for the current user. Might be useful, might be slow.'),
        );
        $form['destination'] = array(
            '#type' => 'checkbox',
            '#title' => t('Include destination'),
            '#description' => t('Include a "destination" parameter in the link to return the user to the original view upon completing the link action.'),
            '#default_value' => $this->options['destination'],
        );
    }
    
    /**
     * {@inheritdoc}
     */
    public function options_submit(&$form, &$form_state) {
        // Remove unselected options.
        $form_state['values']['options']['fields'] = array_filter($form_state['values']['options']['fields']);
        parent::options_submit($form, $form_state);
    }
    
    /**
     * Return the list of links of this field.
     *
     * @return array
     *   The links which are used by the render function.
     */
    public function get_links() {
        $links = array();
        foreach ($this->options['fields'] as $field) {
            if (empty($this->view->field[$field]->last_render_text)) {
                continue;
            }
            $title = $this->view->field[$field]->last_render_text;
            // Use the alter settings for the link field source not this links field.
            $alter = $this->view->field[$field]->options['alter'];
            $url = array(
                'query' => array(),
            );
            // Copy code from views_handler_field::render_as_link().
            $path = $alter['path'];
            if (!empty($path) && $path != '<front>') {
                // Leave path alone on <front> as strip_tags() would remove this.
                // Replace tokens and strip any HTML tags in the path.
                $tokens = $this->get_render_tokens(array());
                $path = strip_tags(decode_entities(strtr($path, $tokens)));
                if (!empty($alter['path_case']) && $alter['path_case'] != 'none') {
                    $path = $this->case_transform($path, $alter['path_case']);
                }
                if (!empty($alter['replace_spaces'])) {
                    $path = str_replace(' ', '-', $path);
                }
                $url = drupal_parse_url($path);
                if (empty($url)) {
                    // Seriously malformed URLs may return FALSE or empty arrays.
                    continue;
                }
                $path = $url['path'];
                // Check router menu item access for the current user.
                if ($this->options['check_access']) {
                    $menu_item = menu_get_item($path);
                    if (!$menu_item || empty($menu_item['access'])) {
                        continue;
                    }
                }
                if (!empty($this->options['destination']) && empty($alter['external'])) {
                    // Override any destination argument included in URL.
                    $url['query'] = array_merge($url['query'], drupal_get_destination());
                }
                // Omit tweaks of query, fragment, and link_class.
                $alt = strtr($alter['alt'], $tokens);
                if ($alt && $alt != $title) {
                    // Set the title attribute only if it improves accessibility.
                    $url['attributes']['title'] = decode_entities($alt);
                }
                if (!empty($alter['rel']) && ($rel = strtr($alter['rel'], $tokens))) {
                    $url['attributes']['rel'] = $rel;
                }
                $target = check_plain(trim(strtr($alter['target'], $tokens)));
                if (!empty($target)) {
                    $url['attributes']['target'] = $target;
                }
            }
            $links[$field] = array(
                'href' => $path,
                'title' => $title,
            ) + $url;
        }
        return $links;
    }
    
    /**
     * {@inheritdoc}
     */
    public function query() {
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title 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 &#039;broken&#039;. 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&#039;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 &#039;extra options&#039; 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 &#039;exposed&#039;, 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 &#039;additional&#039; 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&#039;s label.
views_handler_field::element_label_type public function Return an HTML element for the label based upon the field&#039;s element type.
views_handler_field::element_type public function Return an HTML element based upon the field&#039;s element type. 2
views_handler_field::element_wrapper_classes public function Return the class of the field&#039;s wrapper.
views_handler_field::element_wrapper_type public function Return an HTML element for the wrapper based upon the field&#039;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 &#039;render&#039; 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&#039;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&#039;s label.
views_handler_field::pre_render public function Run before any fields are rendered. 8
views_handler_field::render public function Render the field. 42
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&#039;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_links::get_links public function Return the list of links of this field.
views_handler_field_links::options_form public function Default options form provides the label widget that all fields should have. Overrides views_handler_field::options_form 2
views_handler_field_links::options_submit public function Performs some cleanup tasks on the options array before saving it. Overrides views_handler_field::options_submit
views_handler_field_links::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_handler_field::option_definition 1
views_handler_field_links::query public function Called to add the field to a query. Overrides views_handler_field::query
views_object::$definition public property Handler&#039;s definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition public function Collect this handler&#039;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&#039;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