class SearchApiSavedSearchesViewsHandlerFieldName in Search API Saved Searches 7

Views field handler for displaying a saved search's name, optionally linked to the search page.

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_field
    class \SearchApiSavedSearchesViewsHandlerFieldName

Expanded class hierarchy of SearchApiSavedSearchesViewsHandlerFieldName

1 string reference to 'SearchApiSavedSearchesViewsHandlerFieldName'

search_api_saved_searches_views_data_alter in views/search_api_saved_searches.views.inc: Implements hook_views_data_alter().

File

views/handler_field_saved_search_name.inc, line 11: Contains the SearchApiSavedSearchesViewsHandlerFieldName class.

View source

class SearchApiSavedSearchesViewsHandlerFieldName extends views_handler_field {

  /**
   * The ID of the currently rendered search.
   *
   * @var int|null
   */
  protected $currentSearchId;
  public function option_definition() {
    $options = parent::option_definition();
    $options['link_to_page'] = array(
      'default' => TRUE,
    );
    return $options;
  }
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['link_to_page'] = array(
      '#type' => 'checkbox',
      '#title' => t('Link to search page'),
      '#default_value' => $this->options['link_to_page'],
    );
  }
  public function render($values) {
    $this->currentSearchId = isset($values->id) ? $values->id : NULL;
    return parent::render($values);
  }
  public function render_text($alter) {
    if ($this->options['link_to_page'] && $this->currentSearchId) {
      $search = search_api_saved_search_load($this->currentSearchId);
      if ($search && search_api_saved_search_edit_access(NULL, $search) && !empty($search->options['page'])) {
        $alter['make_link'] = TRUE;
        $page = $search->options['page'] + array(
          'path' => NULL,
          'query' => array(),
        );
        $alter['path'] = $page['path'];
        $alter['query'] = $page['query'];
      }
    }
    return parent::render_text($alter);
  }

  /**
   * Render this field as a link, with info from a fieldset set by the user.
   *
   * Overwritten to fix query parameters for some setups.
   *
   * @see https://www.drupal.org/project/views/issues/2909709#comment-12275897
   */
  public function render_as_link($alter, $text, $tokens) {
    $value = '';
    if (!empty($alter['prefix'])) {
      $value .= filter_xss_admin(strtr($alter['prefix'], $tokens));
    }
    $options = array(
      'html' => TRUE,
      'absolute' => !empty($alter['absolute']) ? TRUE : FALSE,
    );

    // $path will be run through check_url() by l() so we do not need to
    // sanitize it ourselves.
    $path = $alter['path'];

    // strip_tags() removes <front>, so check whether its different to front.
    if ($path != '<front>') {

      // Use strip tags as there should never be HTML in the path. However, we
      // need to preserve special characters like " that were removed by
      // check_plain().
      $path = strip_tags(decode_entities(strtr($path, $tokens)));
      if (!empty($alter['path_case']) && $alter['path_case'] != 'none') {
        $path = $this
          ->case_transform($path, $this->options['alter']['path_case']);
      }
      if (!empty($alter['replace_spaces'])) {
        $path = str_replace(' ', '-', $path);
      }
      if (!empty($alter['unwanted_characters'])) {
        foreach (explode(' ', $alter['unwanted_characters']) as $unwanted) {
          $path = str_replace($unwanted, '', $path);
        }
      }
    }

    // Parse the URL and move any query and fragment parameters out of the path.
    $url = parse_url($path);

    // Seriously malformed URLs may return FALSE or empty arrays.
    if (empty($url)) {
      return $text;
    }

    // If the path is empty do not build a link around the given text and return
    // it as is. http://www.example.com URLs will not have a $url['path'], so
    // check host as well.
    if (empty($url['path']) && empty($url['host']) && empty($url['fragment'])) {
      return $text;
    }

    // If no scheme is provided in the $path, assign the default 'http://'.
    // This allows a url of 'www.example.com' to be converted to
    // 'http://www.example.com'. Only do this on for external URLs.
    if ($alter['external']) {
      if (!isset($url['scheme'])) {

        // There is no scheme, add the default 'http://' to the $path.
        $path = "http://{$path}";

        // Reset the $url array to include the new scheme.
        $url = parse_url($path);
      }
    }
    if (isset($url['query'])) {
      $path = strtr($path, array(
        '?' . $url['query'] => '',
      ));
      $query = drupal_get_query_array($url['query']);

      // Remove query parameters that were assigned a query string replacement
      // token for which there is no value available.
      foreach ($query as $param => $val) {
        if ($val == '%' . $param) {
          unset($query[$param]);
        }
      }
      $options['query'] = $query;
    }
    if (isset($url['fragment'])) {
      $path = strtr($path, array(
        '#' . $url['fragment'] => '',
      ));

      // If the path is empty we want to have a fragment for the current site.
      if ($path == '') {
        $options['external'] = TRUE;
      }
      $options['fragment'] = $url['fragment'];
    }
    $alt = strtr($alter['alt'], $tokens);

    // Set the title attribute of the link only if it improves accessibility
    if ($alt && $alt != $text) {
      $options['attributes']['title'] = decode_entities($alt);
    }
    $class = strtr($alter['link_class'], $tokens);
    if ($class) {
      $options['attributes']['class'] = array(
        $class,
      );
    }
    if (!empty($alter['rel']) && ($rel = strtr($alter['rel'], $tokens))) {
      $options['attributes']['rel'] = $rel;
    }
    $target = check_plain(trim(strtr($alter['target'], $tokens)));
    if (!empty($target)) {
      $options['attributes']['target'] = $target;
    }

    // Allow the addition of arbitrary attributes to links. Additional
    // attributes currently can only be altered in preprocessors and not within
    // the UI.
    if (isset($alter['link_attributes']) && is_array($alter['link_attributes'])) {
      foreach ($alter['link_attributes'] as $key => $attribute) {
        if (!isset($options['attributes'][$key])) {
          $options['attributes'][$key] = strtr($attribute, $tokens);
        }
      }
    }

    // If the query and fragment were programmatically assigned overwrite any
    // parsed values.
    if (isset($alter['query'])) {

      // Convert the query to a string, perform token replacement, and then
      // convert back to an array form for l().
      $options['query'] = http_build_query($alter['query']);
      $options['query'] = strtr($options['query'], $tokens);
      parse_str($options['query'], $options['query']);
    }
    if (isset($alter['alias'])) {

      // Alias is a boolean field, so no token.
      $options['alias'] = $alter['alias'];
    }
    if (isset($alter['fragment'])) {
      $options['fragment'] = strtr($alter['fragment'], $tokens);
    }
    if (isset($alter['language'])) {
      $options['language'] = $alter['language'];
    }

    // If the url came from entity_uri(), pass along the required options.
    if (isset($alter['entity'])) {
      $options['entity'] = $alter['entity'];
    }
    if (isset($alter['entity_type'])) {
      $options['entity_type'] = $alter['entity_type'];
    }
    $value .= l($text, $path, $options);
    if (!empty($alter['suffix'])) {
      $value .= filter_xss_admin(strtr($alter['suffix'], $tokens));
    }
    return $value;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SearchApiSavedSearchesViewsHandlerFieldName::$currentSearchId	protected	property	The ID of the currently rendered search.
SearchApiSavedSearchesViewsHandlerFieldName::options_form	public	function	Default options form provides the label widget that all fields should have. Overrides views_handler_field::options_form
SearchApiSavedSearchesViewsHandlerFieldName::option_definition	public	function	Information about options for all kinds of purposes will be held here. Overrides views_handler_field::option_definition
SearchApiSavedSearchesViewsHandlerFieldName::render	public	function	Render the field. Overrides views_handler_field::render
SearchApiSavedSearchesViewsHandlerFieldName::render_as_link	public	function	Render this field as a link, with info from a fieldset set by the user. Overrides views_handler_field::render_as_link
SearchApiSavedSearchesViewsHandlerFieldName::render_text	public	function	Perform an advanced text render for the item. Overrides views_handler_field::render_text
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_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 SearchApiSavedSearchesViewsHandlerFieldName in Search API Saved Searches 7

Hierarchy

File

Members

API Navigation