class SarniaViewsHandlerField in Sarnia 7

Field handler for displaying Solr fields in Views.

Hierarchy

class \views_object
- class \views_handler
  - class \views_handler_field
    class \SarniaViewsHandlerField

Expanded class hierarchy of SarniaViewsHandlerField

1 string reference to 'SarniaViewsHandlerField'

sarnia_field_views_data in ./sarnia.views.inc: Implements hook_field_views_data().

File

handlers/handler_field.inc, line 6

View source

class SarniaViewsHandlerField extends views_handler_field {

  /**
   * This property is used by views_handler_field::render_text() without
   * without checking to see whether it's set, which throws errors.
   * @var
   */
  public $original_value = NULL;

  /**
   * A Sarnia entity bundle info array.
   * @var array
   */
  protected $sarnia_type_info;

  /**
   * Initialize the handler and load Sarnia entity type info.
   */
  function init(&$view, &$options) {
    parent::init($view, $options);
    $this->sarnia_type_info = sarnia_entity_type_load_by_index($this->definition['search_api_index']);
  }

  /**
   * Provide a custom UI name for the field based on the Solr property.
   */
  function ui_name($short = FALSE) {
    if (!empty($this->options['ui_name'])) {
      $title = check_plain($this->options['ui_name']);
      return $title;
    }
    $title = $short && isset($this->definition['title short']) ? $this->definition['title short'] : $this->definition['title'];
    $title .= ': ' . $this->options['solr_property'];
    if (!$short) {
      $title = $this->definition['group'] . ': ' . $title;
    }
    return $title;
  }

  /**
   * Specify handler options, adding formatter-specific properties.
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['solr_property'] = array(
      'default' => NULL,
    );
    $options['formatter'] = array(
      'default' => NULL,
    );
    $options['settings'] = array(
      'default' => array(),
    );
    $options['is_multivalue'] = array(
      'default' => FALSE,
    );
    $options['multivalue'] = array(
      'contains' => array(
        'count' => array(
          'default' => 0,
        ),
        'list_type' => array(
          'default' => 'ul',
        ),
        'list_separator' => array(
          'default' => ', ',
        ),
      ),
    );
    return $options;
  }

  /**
   * Build the handler configuration form.
   *
   * Adds a Solr property select dropdown, and summons up a formatter settings
   * form.
   *
   * @see views_handler_field_field::options_form()
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form_url = views_ui_build_form_url($form_state);
    $form['solr_property'] = array(
      '#type' => 'select',
      '#title' => t('Solr property'),
      '#options' => sarnia_index_get_field_options($this->definition['search_api_index']),
      '#default_value' => $this->options['solr_property'],
      '#ajax' => array(
        'path' => $form_url,
      ),
      '#submit' => array(
        'views_ui_config_item_form_submit_temporary',
      ),
      '#executes_submit_callback' => TRUE,
    );
    sarnia_element_add_combobox($form['solr_property']);

    // Multivalue property settings
    $server = search_api_server_load($this->sarnia_type_info['search_api_server']);
    $solr_fields = $server
      ->getRemoteFields();
    if (!empty($solr_fields[$this->options['solr_property']]) && $solr_fields[$this->options['solr_property']]
      ->isMultivalued()) {
      $form['multivalue'] = array(
        '#type' => 'fieldset',
        '#tree' => TRUE,
        '#title' => t('Multivalue property settings'),
      );
      $form['multivalue']['count'] = array(
        '#type' => 'textfield',
        '#title' => t('Number of values to display'),
        '#description' => t('Maximum number of field values to display. Leave this at 0 to display all values.'),
        '#default_value' => $this->options['multivalue']['count'],
        '#element_validate' => array(
          'views_element_validate_integer',
        ),
        '#size' => 5,
      );
      $form['multivalue']['list_type'] = array(
        '#type' => 'select',
        '#title' => t('List type'),
        '#options' => array(
          'ul' => 'Unordered list',
          'ol' => 'Ordered list',
          'separator' => 'Separator',
        ),
        '#default_value' => $this->options['multivalue']['list_type'],
      );
      $form['multivalue']['list_separator'] = array(
        '#type' => 'textfield',
        '#title' => t('Seperator'),
        '#default_value' => $this->options['multivalue']['list_separator'],
        '#states' => array(
          'visible' => array(
            'select[name="options[multivalue][list_type]"]' => array(
              'value' => 'separator',
            ),
          ),
        ),
      );
    }

    // Field formatter configuration, from
    // views/modules/field/views_handler_field_field.inc
    module_load_include('inc', 'views', 'modules/field/views_handler_field_field');
    $field = field_info_field($this->definition['field_name']);
    $formatters = array(
      t('- None -'),
    ) + _field_view_formatter_options($field['type']);
    $form['formatter'] = array(
      '#type' => 'select',
      '#title' => t('Formatter'),
      '#options' => $formatters,
      '#default_value' => $this->options['formatter'],
      '#ajax' => array(
        'path' => $form_url,
      ),
      '#submit' => array(
        'views_ui_config_item_form_submit_temporary',
      ),
      '#executes_submit_callback' => TRUE,
    );

    // Get the currently selected formatter.
    $format = $this->options['formatter'];
    $formatter = field_info_formatter_types($format);
    $settings = $this->options['settings'] + field_info_formatter_settings($format);

    // Provide an instance array for hook_field_formatter_settings_form(). This
    // mimics ctools_fields_fake_field_instance(), except it gets a real
    // instance since we know our entity type.
    $entity_type = $this->sarnia_type_info['machine_name'];
    $instance = field_info_instance($entity_type, $this->definition['field_name'], $entity_type);
    $instance['display']['_dummy'] = array(
      'type' => $formatter,
      'settings' => $settings,
    );

    // Store the settings in a '_dummy' view mode.
    $instance['display']['_dummy'] = array(
      'type' => $format,
      'settings' => $settings,
    );

    // Get the settings form.
    $settings_form = array(
      '#value' => array(),
    );
    $function = (isset($formatter['module']) ? $formatter['module'] : '') . '_field_formatter_settings_form';
    if (function_exists($function)) {

      // views_handler_field_field.inc passes $form instead of array()
      $settings_form = $function($field, $instance, '_dummy', array(), $form_state);
      unset($settings_form['solr_property']);
    }
    $form['settings'] = $settings_form;
  }
  function options_submit(&$form, &$form_state) {
    parent::options_submit($form, $form_state);

    // Set a reasonable label if it is the first save and none was specified, or
    // if the the previous label matched the previous property name and has not
    // been changed.
    if (!isset($this->options['solr_property']) && $form_state['values']['options']['label'] == $this->definition['title'] || $this->options['solr_property'] == $this->options['label'] && $this->options['label'] == $form_state['values']['options']['label']) {
      $form_state['values']['options']['label'] = $form_state['values']['options']['solr_property'];
    }

    // Check whether the field we're saving is multivalue, so that we don't have
    // to check every single time we render the field.
    $server = search_api_server_load($this->sarnia_type_info['search_api_server']);
    $solr_fields = $server
      ->getRemoteFields();
    $solr_property = $form_state['values']['options']['solr_property'];
    $form_state['values']['options']['is_multivalue'] = !empty($solr_fields[$solr_property]) && $solr_fields[$solr_property]
      ->isMultivalued();
  }

  /**
   * Add this handler's data to the query.
   *
   * By default Solr returns all of the fields in a Solr doc. All that this
   * method needs to do is specify the field alias.
   */
  public function query() {
    $this->field_alias = $this->options['solr_property'];
  }

  /**
   * Load any entities that aren't present for use with field formatters, if
   * necessary.
   *
   * @param $results
   *   An array of views result objects.
   */
  function post_execute(&$results) {

    // Don't bother trying to load entities if the formatter doesn't need them.
    if (!empty($this->options['formatter'])) {

      // Get a list of unloaded entities.
      $ids = array();
      foreach ($results as $result_id => $result) {
        $entity_id =& $result->entity;
        if (!is_object($entity_id)) {
          $ids[$result_id] = $entity_id;
        }
      }

      // Load whatever unloaded entities we found.
      if (!empty($ids)) {
        $entities = entity_load($this->sarnia_type_info['machine_name'], array_values($ids));
        foreach ($ids as $result_id => $entity_id) {
          if ($entities[$entity_id]) {
            $results[$result_id]->entity = $entities[$entity_id];
          }
        }
      }
    }
    $this->item_key = 'item__' . $this->options['id'];
    foreach ($results as $row_id => $result) {
      $result->{$this->item_key} = $this
        ->set_items($result, $row_id);
    }
  }

  /**
   * Fallback method to render the field.
   *
   * In general this should not be called anymore!
   *
   * @param $values
   *   The values retrieved from the database.
   */
  function render($values) {
    $output = '';
    $value = $this
      ->get_value($values);
    if (is_array($value)) {
      $value = array_map(array(
        $this,
        'sanitize_value',
      ), $value);
      $output = implode(' ', $value);
    }
    else {
      $output = $this
        ->sanitize_value($value);
    }
    return $output;
  }

  /**
   * Extract the value of this field from the solr properties.
   *
   * @param $values
   *   An object containing all retrieved values.
   * @param $field
   *   Optional name of the field where the value is stored. Not used by this
   *   handler.
   *
   * @return
   *   An array of scalars, or a scalar.
   */
  public function get_value($values, $field = NULL) {
    if (!empty($values->_entity_properties[$this->options['solr_property']])) {
      return $values->_entity_properties[$this->options['solr_property']];
    }
    return NULL;
  }

  /**
   * Re-title tokens from Sarnia field handlers with their Solr property names.
   */
  function document_self_tokens(&$tokens) {
    foreach ($this->view->display_handler
      ->get_handlers('field') as $field => $handler) {
      if ($handler instanceof SarniaViewsHandlerField) {
        $token_name = "[{$field}]";
        if (isset($tokens[$token_name]) && isset($handler->options['solr_property'])) {
          $tokens[$token_name] = $handler
            ->admin_summary();
        }
      }
    }
  }

  /**
   * Check whether this field is sortable.
   */
  function click_sortable() {
    $name = $this->options['solr_property'];
    $server = search_api_server_load($this->sarnia_type_info['search_api_server']);
    $fields = $server
      ->getSortFields();
    return isset($fields[$name]);
  }

  /**
   * Add a click sort to the query.
   */
  public function click_sort($order) {
    $this->query
      ->sort($this->field_alias, $order);
  }

  /**
   * Extract the field values as an array of items.
   *
   * @param stdclass $values
   *   A views result.
   * @param $row_id
   *   Who knows. <-- @TODO
   *
   * @return array
   *   An array of item arrays. Each item array should contain two properties:
   *     'raw': an unfiltered value for use in tokens
   *     'rendered': sanitized rendered HTML for display
   */
  public function set_items($values, $row_id) {
    $items = array();
    $entity = $values->entity;
    $properties = $values->_entity_properties;
    $solr_property = $this->options['solr_property'];

    // Are we using a Field API field formatter, and is our entity loaded in the results?
    $id_field = $this->sarnia_type_info['id_field'];
    if (!empty($this->options['formatter']) && !empty($entity)) {

      // Build arguments for the Field API field formatter.
      $display = array(
        'type' => $this->options['formatter'],
        'settings' => $this->options['settings'] + array(
          'solr_property' => $solr_property,
        ),
        'label' => 'hidden',
        // Pass the View object in the display so that fields can act on it.
        'views_view' => $this->view,
        'views_field' => $this,
        'views_row_id' => $entity->id,
      );
      $render_array = field_view_field($entity->type, $entity, $this->definition['field_name'], $display, LANGUAGE_NONE);

      // Extract the rendered field values from the render array.
      foreach (element_children($render_array) as $i) {
        $items[$i]['rendered'] = $render_array[$i];
        if (isset($render_array['#access'])) {
          $items[$i]['rendered']['#access'] = $render_array['#access'];
        }
        if ((!isset($items[$i]['rendered']['#access']) || $items[$i]['rendered']['#access']) && !empty($render_array['#items'][$i])) {
          $items[$i]['raw'] = $render_array['#items'][$i];
        }
      }
    }
    else {

      // Return an unprocessed value.
      $value = $this
        ->get_value($values);
      if (is_array($value)) {
        foreach ($properties[$solr_property] as $value) {
          $items[] = array(
            'raw' => $value,
            'rendered' => $this
              ->sanitize_value($value),
          );
        }
      }
      elseif (!empty($value)) {
        $items[] = array(
          'raw' => $properties[$solr_property],
          'rendered' => $this
            ->sanitize_value($properties[$solr_property]),
        );
      }
    }

    // Trim the items based on the multivalue count setting, if present.
    if ($this->options['is_multivalue'] && $this->options['multivalue']['count'] > 0) {
      $items = array_slice($items, 0, $this->options['multivalue']['count']);
    }
    return $items;
  }
  public function get_items($values) {
    return $values->{$this->item_key};
  }

  /**
   * Render a single item.
   *
   * @param scalar $key
   *   The row number or row id (???)
   * @param array $item
   *   An array containing a 'raw' and a 'rendered' parameter. This is one item
   *   from the array returned by ::get_items().
   *
   * @return string
   *   Rendered content.
   */
  public function render_item($key, $item) {
    return $item['rendered'];
  }

  /**
   * Render a list of items.
   *
   * @param array $items
   *   A flat array of field items. Each value in this array is the output of
   *   the ::render_item() method.
   *
   * @return string
   *   Rendered content.
   */
  public function render_items($items) {
    $output = '';
    if (!empty($items)) {
      if (!$this->options['is_multivalue']) {
        $output = current($items);
      }
      elseif ($this->options['multivalue']['list_type'] == 'separator') {
        $output = implode(check_plain($this->options['multivalue']['list_separator']), $items);
      }
      else {
        $output = theme('item_list', array(
          'type' => $this->options['multivalue']['list_type'],
          'title' => NULL,
          'items' => $items,
        ));
      }
    }
    return $output;
  }

  /**
   * Sanitize the value for output.
   *
   * @param string $value
   *   The value being rendered.
   * @param string $type
   *   The type of sanitization needed. If not provided, no processing is done.
   *
   * @return string
   *   Returns the safe value.
   *
   * @see search_api_sanitize_field_value()
   */
  public function sanitize_value($value, $type = NULL) {

    // Value is sanitized by Search API regardless of type - no other processing
    // needs to be done.
    return $value;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
SarniaViewsHandlerField::$original_value	public	property	This property is used by views_handler_field::render_text() without without checking to see whether it's set, which throws errors. @var Overrides views_handler_field::$original_value
SarniaViewsHandlerField::$sarnia_type_info	protected	property	A Sarnia entity bundle info array.
SarniaViewsHandlerField::click_sort	public	function	Add a click sort to the query. Overrides views_handler_field::click_sort
SarniaViewsHandlerField::click_sortable		function	Check whether this field is sortable. Overrides views_handler_field::click_sortable
SarniaViewsHandlerField::document_self_tokens		function	Re-title tokens from Sarnia field handlers with their Solr property names. Overrides views_handler_field::document_self_tokens
SarniaViewsHandlerField::get_items	public	function
SarniaViewsHandlerField::get_value	public	function	Extract the value of this field from the solr properties. Overrides views_handler_field::get_value
SarniaViewsHandlerField::init		function	Initialize the handler and load Sarnia entity type info. Overrides views_handler_field::init
SarniaViewsHandlerField::options_form	public	function	Build the handler configuration form. Overrides views_handler_field::options_form
SarniaViewsHandlerField::options_submit		function	Performs some cleanup tasks on the options array before saving it. Overrides views_handler_field::options_submit
SarniaViewsHandlerField::option_definition	public	function	Specify handler options, adding formatter-specific properties. Overrides views_handler_field::option_definition
SarniaViewsHandlerField::post_execute		function	Load any entities that aren't present for use with field formatters, if necessary. Overrides views_handler::post_execute
SarniaViewsHandlerField::query	public	function	Add this handler's data to the query. Overrides views_handler_field::query
SarniaViewsHandlerField::render		function	Fallback method to render the field. Overrides views_handler_field::render
SarniaViewsHandlerField::render_item	public	function	Render a single item.
SarniaViewsHandlerField::render_items	public	function	Render a list of items.
SarniaViewsHandlerField::sanitize_value	public	function	Sanitize the value for output. Overrides views_handler::sanitize_value
SarniaViewsHandlerField::set_items	public	function	Extract the field values as an array of items.
SarniaViewsHandlerField::ui_name		function	Provide a custom UI name for the field based on the Solr property. Overrides views_handler_field::ui_name
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::pre_query	public	function	Run before the view is built.	1
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::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::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::pre_render	public	function	Run before any fields are rendered.	8
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::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 SarniaViewsHandlerField in Sarnia 7

Hierarchy

File

Members

API Navigation