class tagadelic_plugin_style in Views Tagadelic 7.2

Same name and namespace in other branches

7 includes/tagadelic_plugin_style.inc \tagadelic_plugin_style

Style plugin to render a weighted set of taxonomy terms.

Hierarchy

class \views_object
- class \views_plugin
  - class \views_plugin_style
    class \views_plugin_style_list
    class \tagadelic_plugin_style

Expanded class hierarchy of tagadelic_plugin_style

1 string reference to 'tagadelic_plugin_style'

tagadelic_views_views_plugins in ./tagadelic_views.views.inc: Implements hook_views_plugins().

File

includes/tagadelic_plugin_style.inc, line 13: Contains the tagadelic style plugin.

View source

class tagadelic_plugin_style extends views_plugin_style_list {
  private $cloud_tags = NULL;

  /**
   * Return the token replaced row class for the specified row.
   */
  function get_row_class($row_index) {
    $classes_string = parent::get_row_class($row_index);
    if ($this->cloud_tags) {
      $weight = $this->cloud_tags[$row_index]
        ->get_weight();
      $classes_string = implode(" ", array(
        $classes_string,
        ' level' . $weight,
      ));
    }
    return $classes_string;
  }

  /**
   * Allow the style to do stuff before each row is rendered.
   *
   * @param $result
   *   The full array of results from the query.
   */
  function pre_render($result) {
    parent::pre_render($result);
    $this
      ->build_cloud($result);
  }

  /**
   * Set default options
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['display_field'] = NULL;
    $options['count_field'] = NULL;

    // uses tagadelic ul.tag-cloud CSS class
    $options['class'] = array(
      'default' => 'tag-cloud',
    );
    return $options;
  }

  /**
   * Normalize a list of columns based upon the fields that are
   * available. This compares the fields stored in the style handler
   * to the list of fields actually in the view, removing fields that
   * have been removed and adding new fields in their own column.
   *
   * - Each field must be in a column.
   * - Each column must be based upon a field, and that field
   *   is somewhere in the column.
   * - Any fields not currently represented must be added.
   * - Columns must be re-ordered to match the fields.
   *
   * @param $columns
   *   An array of all fields; the key is the id of the field and the
   *   value is the id of the column the field should be in.
   * @param $fields
   *   The fields to use for the columns. If not provided, they will
   *   be requested from the current display. The running render should
   *   send the fields through, as they may be different than what the
   *   display has listed due to access control or other changes.
   *
   * @return array
   *    An array of all the sanitized columns.
   */
  function sanitize_columns($columns, $fields = NULL) {
    $sanitized = array();
    if ($fields === NULL) {
      $fields = $this->display->handler
        ->get_option('fields');
    }

    // Preconfigure the sanitized array so that the order is retained.
    foreach ($fields as $field => $info) {

      // Set to itself so that if it isn't touched, it gets column
      // status automatically.
      $sanitized[$field] = $field;
    }
    foreach ($columns as $field => $column) {

      // first, make sure the field still exists.
      if (!isset($sanitized[$field])) {
        continue;
      }

      // If the field is the column, mark it so, or the column
      // it's set to is a column, that's ok
      if ($field == $column || $columns[$column] == $column && !empty($sanitized[$column])) {
        $sanitized[$field] = $column;
      }

      // Since we set the field to itself initially, ignoring
      // the condition is ok; the field will get its column
      // status back.
    }
    return $sanitized;
  }

  /**
   * Render the given style.
   */
  function options_form(&$form, &$form_state) {
    $handlers = $this->display->handler
      ->get_handlers('field');
    if (empty($handlers)) {
      $form['error_markup'] = array(
        '#markup' => '<div class="error messages">' . t('You need at least one field before you can configure your tagadelic settings') . '</div>',
      );
      return;
    }

    // Create an array of allowed columns from the data we know:
    $columns = $this
      ->sanitize_columns($this->options['columns']);
    $field_names = $this->display->handler
      ->get_field_labels();
    foreach ($columns as $column_name => $column_label) {
      $columns[$column_name] = $field_names[$column_name];
    }
    $form['count_field'] = array(
      '#type' => 'select',
      '#title' => t('Count field'),
      '#default_value' => $this->options['count_field'],
      '#options' => $columns,
      '#description' => t('The field used to count the results for a row.'),
    );

    // standard settings for list style
    parent::options_form($form, $form_state);
  }
  function build_cloud($result) {
    drupal_add_css(drupal_get_path('module', 'tagadelic') . '/tagadelic.css');
    $count_field = $this->options['count_field'];
    $columns = $this->display->handler
      ->get_option('fields');
    $count_field_alias = NULL;
    if (isset($this->view->field[$count_field])) {
      $count_field_alias = $this->view->field[$count_field]->field_alias;
    }
    if (!$count_field_alias) {
      drupal_set_message("Please set which field you are using for counting results in the tagadelic display.", "error");
      return "";
    }
    $tags = array();
    foreach ($result as $index => $item) {
      $count = floatval($item->{$count_field_alias});
      $tag = new TagadelicTag($index, "", $count);
      $tags[] = $tag;
    }
    $cloud = new TagadelicCloud($this->view->name, $tags);
    $this->cloud_tags = $cloud
      ->get_tags();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
tagadelic_plugin_style::$cloud_tags	private	property
tagadelic_plugin_style::build_cloud		function
tagadelic_plugin_style::get_row_class		function	Return the token replaced row class for the specified row. Overrides views_plugin_style::get_row_class
tagadelic_plugin_style::options_form		function	Render the given style. Overrides views_plugin_style_list::options_form
tagadelic_plugin_style::option_definition		function	Set default options Overrides views_plugin_style_list::option_definition
tagadelic_plugin_style::pre_render		function	Allow the style to do stuff before each row is rendered. Overrides views_plugin_style::pre_render
tagadelic_plugin_style::sanitize_columns		function	Normalize a list of columns based upon the fields that are available. This compares the fields stored in the style handler to the list of fields actually in the view, removing fields that have been removed and adding new fields in their own column.
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::construct	public	function	Views handlers use a special construct function.	4
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_plugin::$display	public	property	The current used views display.
views_plugin::$plugin_name	public	property	The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type	public	property	The plugin type of this plugin, for example style or query.
views_plugin::$view	public	property	The top object of a view. Overrides views_object::$view	1
views_plugin::additional_theme_functions	public	function	Provide a list of additional theme functions for the theme info page.
views_plugin::options_submit	public	function	Handle any special handling on the validate form.	9
views_plugin::plugin_title	public	function	Return the human readable name of the display.
views_plugin::summary_title	public	function	Returns the summary of the settings in the display.	8
views_plugin::theme_functions	public	function	Provide a full list of possible theme templates used by this style.
views_plugin_style::$row_plugin	public	property	The row plugin, if it's initialized and the style itself supports it.
views_plugin_style::$row_tokens	public	property	Store all available tokens row rows.
views_plugin_style::build_sort	public	function	Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query.	1
views_plugin_style::build_sort_post	public	function	Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view.	1
views_plugin_style::destroy	public	function	Destructor. Overrides views_object::destroy
views_plugin_style::even_empty	public	function	Should the output of the style plugin be rendered even if it's empty.	1
views_plugin_style::get_field	public	function	Get a rendered field.
views_plugin_style::get_field_value	public	function	Get the raw field value.
views_plugin_style::init	public	function	Initialize a style plugin.
views_plugin_style::options_validate	public	function	Validate the options form. Overrides views_plugin::options_validate
views_plugin_style::query	public	function	Add anything to the query that we might need to. Overrides views_plugin::query	2
views_plugin_style::render	public	function	Render the display in this style.	5
views_plugin_style::render_fields	public	function	Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping	public	function	Group records as needed for rendering.
views_plugin_style::render_grouping_sets	public	function	Render the grouping sets.
views_plugin_style::tokenize_value	public	function	Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields	public	function	Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class	public	function	Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin	public	function	Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens	public	function	Return TRUE if this style uses tokens.
views_plugin_style::validate	public	function	Validate that the plugin is correct and can be saved. Overrides views_plugin::validate

You are here

class tagadelic_plugin_style in Views Tagadelic 7.2

Hierarchy

File

Members

API Navigation