views_plugin_style_list Class Reference
[Views' style plugins]

Inheritance diagram for views_plugin_style_list:

views_plugin_style views_plugin views_object List of all members.

Detailed Description

Style plugin to render each item in an ordered or unordered list.

Definition at line 13 of file views_plugin_style_list.inc.

Public Member Functions

 option_definition ()
 Set default options.
 options_form (&$form, &$form_state)
 Render the given style.
 init (&$view, &$display, $options=NULL)
 Initialize a style plugin.
 init (&$view, &$display)
 Init will be called after construct, when the plugin is attached to a view and a display.
 destroy ()
 uses_row_plugin ()
 Return TRUE if this style also uses a row plugin.
 uses_fields ()
 Return TRUE if this style also uses fields.
 build_sort ()
 Called by the view builder to see if this style handler wants to interfere with the sorts.
 build_sort_post ()
 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.
 pre_render ($result)
 Allow the style to do stuff before each row is rendered.
 render ()
 Render the display in this style.
 render_grouping ($records, $grouping_field= '')
 Group records as needed for rendering.
 render_fields ($result)
 Render all of the fields for a given style and store them on the object.
 get_field ($index, $field)
 Get a rendered field.
 validate ()
 Validate that the plugin is correct and can be saved.
 query ()
 Add anything to the query that we might need to.
 options_validate (&$form, &$form_state)
 Validate the options form.
 options_submit (&$form, &$form_state)
 Handle any special handling on the validate form.
 theme_functions ()
 Provide a full list of possible theme templates used by this style.
 additional_theme_functions ()
 Provide a list of additional theme functions for the theme information page.
 construct ()
 Views handlers use a special construct function so that we can more easily construct them with variable arguments.
 options ()
 Set default options on this object.
 set_default_options ()
 Set default options.
 _set_option_defaults (&$storage, $options, $level=0)
 unpack_options (&$storage, $options, $definition=NULL)
 Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
 set_definition ($definition)
 Let the handler know what its full definition is.

Public Attributes

 $options = array()
 Except for displays, options for the object will be held here.

Member Function Documentation

views_plugin::additional_theme_functions (  )  [inherited]

Provide a list of additional theme functions for the theme information page.

Definition at line 386 of file plugins.inc.

Referenced by views_plugin_display::options_form().

00386                                         {
00387     $funcs = array();
00388     if (!empty($this->definition['additional themes'])) {
00389       foreach ($this->definition['additional themes'] as $theme => $type) {
00390         $funcs[] = views_theme_functions($theme, $this->view, $this->display);
00391       }
00392     }
00393     return $funcs;
00394   }

views_plugin_style::build_sort (  )  [inherited]

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.

Reimplemented in views_plugin_style_table.

Definition at line 120 of file views_plugin_style.inc.

00120 { return TRUE; }

views_plugin_style::build_sort_post (  )  [inherited]

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.

Reimplemented in views_plugin_style_table.

Definition at line 126 of file views_plugin_style.inc.

00126 { }

views_object::construct (  )  [inherited]

Views handlers use a special construct function so that we can more easily construct them with variable arguments.

Reimplemented in views_handler_argument, views_handler_argument_formula, views_handler_field, views_handler_field_markup, views_handler_filter_boolean_operator, views_handler_filter_in_operator, views_handler_sort_formula, views_handler_field_aggregator_category, views_handler_field_aggregator_title_link, views_handler_field_comment_link, views_handler_field_comment_link_edit, views_handler_field_comment_node_link, views_handler_field_node_new_comments, views_handler_field_filter_format_name, views_handler_argument_locale_group, views_handler_argument_locale_language, views_handler_field_locale_link_edit, views_handler_argument_node_created_fulldate, views_handler_argument_node_created_year, views_handler_argument_node_created_year_month, views_handler_argument_node_created_month, views_handler_argument_node_created_day, views_handler_argument_node_created_week, views_handler_argument_node_language, views_handler_argument_node_type, views_handler_field_node, views_handler_field_node_link, views_handler_field_node_link_delete, views_handler_field_node_link_edit, views_handler_field_node_revision_link_delete, views_handler_field_node_revision_link_revert, views_handler_field_taxonomy, views_handler_argument_node_language, views_handler_field_node_translation_link, views_handler_field_upload_fid, views_handler_filter_upload_fid, views_handler_field_user_link, views_handler_field_user_picture, views_handler_field_user_roles, and views_handler_filter_user_current.

Definition at line 40 of file base.inc.

References views_object::set_default_options().

00040 { $this->set_default_options(); }

views_plugin_style::get_field ( $  index,
$  field 
) [inherited]

Get a rendered field.

Parameters:
$index The index count of the row.
$field The id of the field.

Definition at line 245 of file views_plugin_style.inc.

References $field, and views_plugin_style::render_fields().

Referenced by views_plugin_style_jump_menu::render(), and views_plugin_style::render_grouping().

00245                                      {
00246     if (!isset($this->rendered_fields)) {
00247       $this->render_fields($this->view->result);
00248     }
00249 
00250     if (isset($this->rendered_fields[$index][$field])) {
00251       return $this->rendered_fields[$index][$field];
00252     }
00253   }

views_plugin::init ( &$  view,
&$  display 
) [inherited]

Init will be called after construct, when the plugin is attached to a view and a display.

Reimplemented in views_plugin_access, and views_plugin_cache.

Definition at line 351 of file plugins.inc.

00351                                    {
00352     $this->view = &$view;
00353     $this->display = &$display;
00354   }

views_plugin_style::init ( &$  view,
&$  display,
$  options = NULL 
) [inherited]

Initialize a style plugin.

Parameters:
$view 
$display 
$options The style options might come externally as the style can be sourced from at least two locations. If it's not included, look on the display.

Definition at line 31 of file views_plugin_style.inc.

References views_object::$options, views_object::options(), views_object::unpack_options(), and views_plugin_style::uses_row_plugin().

00031                                                     {
00032     $this->view = &$view;
00033     $this->display = &$display;
00034 
00035     // Overlay incoming options on top of defaults
00036     $this->unpack_options($this->options, isset($options) ? $options : $display->handler->get_option('style_options'));
00037 
00038     if ($this->uses_row_plugin() && $display->handler->get_option('row_plugin')) {
00039       $this->row_plugin = $display->handler->get_plugin('row');
00040     }
00041 
00042     $this->options += array(
00043       'grouping' => '',
00044     );
00045 
00046     $this->definition += array(
00047       'uses grouping' => TRUE,
00048     );
00049   }

views_plugin_style_list::option_definition (  ) 

Set default options.

Reimplemented from views_plugin_style.

Definition at line 17 of file views_plugin_style_list.inc.

References views_object::$options.

00017                                {
00018     $options = parent::option_definition();
00019 
00020     $options['type'] = array('default' => 'ul');
00021 
00022     return $options;
00023   }

views_object::options (  )  [inherited]

Set default options on this object.

Called by the constructor in a complex chain to deal with backward compatibility.

Definition at line 46 of file base.inc.

Referenced by views_handler_filter_term_node_tid::accept_exposed_input(), views_handler_filter_numeric::accept_exposed_input(), views_handler_filter_in_operator::accept_exposed_input(), views_handler_filter_date::accept_exposed_input(), views_handler_filter::accept_exposed_input(), views_plugin_access_role::access(), views_plugin_access_perm::access(), views_handler_field_term_node_tid::add_self_tokens(), views_handler_filter_history_user_timestamp::admin_summary(), views_handler_sort::admin_summary(), views_handler_filter_string::admin_summary(), views_handler_filter_numeric::admin_summary(), views_handler_filter_in_operator::admin_summary(), views_handler_filter_boolean_operator::admin_summary(), views_plugin_argument_default_php::argument_form(), views_plugin_argument_default::argument_form(), views_plugin_argument_default_user::argument_form(), views_plugin_style_table::build_sort(), views_plugin_style_table::build_sort_post(), views_plugin_cache_time::cache_expire(), views_handler_filter_string::case_transform(), views_handler_argument_string::case_transform(), views_handler_field::construct(), views_handler_argument::default_action(), views_handler_argument_date::default_argument_form(), views_handler_argument::default_argument_form(), views_handler_argument::default_summary(), views_plugin_display_attachment::displays_exposed(), views_handler_field_term_node_tid::document_self_tokens(), views_handler_filter::expose_form_left(), views_handler_filter_term_node_tid::expose_form_right(), views_handler_filter_in_operator::expose_form_right(), views_handler_filter::expose_form_right(), views_handler_filter_in_operator::expose_options(), views_handler_filter_boolean_operator::expose_options(), views_handler_filter::expose_options(), views_handler_filter::expose_validate(), views_handler_filter_search::exposed_form(), views_handler_filter::exposed_form(), views_handler_filter::exposed_info(), views_handler_filter::exposed_translate(), views_handler_filter_user_name::exposed_validate(), views_handler_filter_term_node_tid::exposed_validate(), views_handler_filter_search::exposed_validate(), views_handler_filter_date::exposed_validate(), views_handler_filter_term_node_tid_depth::extra_options_form(), views_handler_filter_term_node_tid::extra_options_form(), views_plugin_access_role::get_access_callback(), views_plugin_access_perm::get_access_callback(), views_handler_argument_date::get_default_argument(), views_handler_argument::get_default_argument(), views_handler_argument_string::get_formula(), views_plugin_display::get_option(), views_handler_filter_profile_selection::get_value_options(), views_handler_filter_in_operator::get_value_options(), views_handler_argument::has_default_argument(), views_plugin_style::init(), views_plugin_row::init(), views_plugin_display::init(), views_plugin_cache::init(), views_plugin_access::init(), views_handler_field_user_name::init(), views_handler_field_user::init(), views_plugin_row_node_view::init(), views_handler_field_history_user_timestamp::init(), views_handler_field_node_new_comments::init(), views_handler_field_comment::init(), views_handler::init(), views_handler_filter::init(), views_handler_field::init(), views_plugin_display::is_defaulted(), views_handler::is_exposed(), views_plugin_display::is_identifier_unique(), views_handler_argument::is_wildcard(), views_handler_relationship::label(), views_handler_field::label(), views_handler_argument::needs_style_plugin(), views_handler_filter_numeric::op_between(), views_handler_filter_float::op_between(), views_handler_filter_date::op_between(), views_handler_filter_string::op_contains(), views_handler_filter_string::op_empty(), views_handler_filter_numeric::op_empty(), views_handler_filter_in_operator::op_empty(), views_handler_filter_string::op_ends(), views_handler_filter_string::op_equal(), views_handler_filter_string::op_not(), views_handler_filter_string::op_not_ends(), views_handler_filter_string::op_not_starts(), views_handler_filter_numeric::op_simple(), views_handler_filter_in_operator::op_simple(), views_handler_filter_float::op_simple(), views_handler_filter_date::op_simple(), views_handler_filter_string::op_starts(), views_handler_filter_string::op_word(), views_handler_filter_node_tnid::operator_form(), views_handler_filter_search::operator_form(), views_handler_filter::operator_form(), views_plugin_style_table::options_form(), views_plugin_style_summary_unformatted::options_form(), views_plugin_style_summary_jump_menu::options_form(), views_plugin_style_summary::options_form(), views_plugin_style_rss::options_form(), options_form(), views_plugin_style_jump_menu::options_form(), views_plugin_style_grid::options_form(), views_plugin_style::options_form(), views_plugin_row_fields::options_form(), views_plugin_row::options_form(), views_plugin_display_page::options_form(), views_plugin_display_feed::options_form(), views_plugin_display_block::options_form(), views_plugin_display_attachment::options_form(), views_plugin_display::options_form(), views_plugin_cache_time::options_form(), views_plugin_access_role::options_form(), views_plugin_access_perm::options_form(), views_handler_field_user_name::options_form(), views_handler_field_user_mail::options_form(), views_handler_field_user_link::options_form(), views_handler_field_is_online::options_form(), views_handler_field_upload_fid::options_form(), views_handler_field_upload_description::options_form(), views_handler_relationship_translation::options_form(), views_handler_relationship_node_term_data::options_form(), views_handler_field_term_node_tid::options_form(), views_handler_field_taxonomy::options_form(), views_handler_argument_term_node_tid_depth::options_form(), views_handler_argument_term_node_tid::options_form(), views_handler_field_file::options_form(), views_handler_field_accesslog_path::options_form(), views_plugin_row_search_view::options_form(), views_handler_field_search_score::options_form(), views_handler_field_profile_date::options_form(), views_plugin_row_node_view::options_form(), views_plugin_row_node_rss::options_form(), views_handler_field_node_link::options_form(), views_handler_field_node::options_form(), views_handler_field_history_user_timestamp::options_form(), views_handler_field_locale_link_edit::options_form(), views_handler_field_contact_link::options_form(), views_plugin_row_comment_view::options_form(), views_handler_field_comment_username::options_form(), views_handler_field_comment_node_link::options_form(), views_handler_field_comment_link::options_form(), views_plugin_row_aggregator_rss::options_form(), views_handler_field_aggregator_title_link::options_form(), views_handler_field_aggregator_category::options_form(), views_handler_sort_date::options_form(), views_handler_sort::options_form(), views_handler_relationship::options_form(), views_handler_filter_string::options_form(), views_handler_field_url::options_form(), views_handler_field_prerender_list::options_form(), views_handler_field_numeric::options_form(), views_handler_field_date::options_form(), views_handler_field_counter::options_form(), views_handler_field_boolean::options_form(), views_handler_field_file_size::options_form(), views_handler_field::options_form(), views_handler_argument_string::options_form(), views_handler_argument_numeric::options_form(), views_handler_argument_null::options_form(), views_handler_argument_many_to_one::options_form(), views_handler_argument::options_form(), views_plugin_display::options_submit(), views_handler_filter::options_submit(), views_plugin_display::options_summary(), views_handler_filter_date::options_validate(), views_handler_filter::options_validate(), views_handler_argument_term_node_tid_depth_modifier::pre_query(), views_handler_field_upload_description::pre_render(), views_handler_field_term_node_tid::pre_render(), views_plugin_style_summary::query(), views_plugin_row::query(), views_handler_filter_user_current::query(), views_handler_filter_upload_fid::query(), views_handler_relationship_translation::query(), views_handler_filter_node_tnid_child::query(), views_handler_filter_node_tnid::query(), views_handler_relationship_node_term_data::query(), views_handler_filter_term_node_tid_depth::query(), views_handler_argument_term_node_tid_depth::query(), views_handler_sort_search_score::query(), views_handler_filter_search::query(), views_handler_field_search_score::query(), views_handler_filter_node_status::query(), views_handler_filter_history_user_timestamp::query(), views_handler_sort_ncs_last_updated::query(), views_handler_sort_ncs_last_comment_name::query(), views_handler_sort_comment_thread::query(), views_handler_filter_comment_user_uid::query(), views_handler_sort_random::query(), views_handler_sort_formula::query(), views_handler_sort_date::query(), views_handler_sort::query(), views_handler_relationship::query(), views_handler_filter_boolean_operator_string::query(), views_handler_filter_boolean_operator::query(), views_handler_filter::query(), views_handler_argument_string::query(), views_handler_argument_numeric::query(), views_handler_argument_many_to_one::query(), views_handler_filter_in_operator::reduce_value_options(), views_plugin_style_summary_jump_menu::render(), views_plugin_style_summary::render(), views_plugin_style_rss::render(), views_plugin_style_jump_menu::render(), views_plugin_style::render(), views_plugin_row::render(), views_handler_field_user_mail::render(), views_handler_field_user_link_edit::render(), views_handler_field_user_link_delete::render(), views_handler_field_user_link::render(), views_handler_field_accesslog_path::render(), views_plugin_row_search_view::render(), views_handler_field_profile_date::render(), views_handler_field_node_link::render(), views_handler_field_locale_link_edit::render(), views_plugin_row_comment_rss::render(), views_handler_field_ncs_last_comment_name::render(), views_handler_field_comment_link_reply::render(), views_handler_field_comment_link_delete::render(), views_handler_field_comment_link::render(), views_plugin_row_aggregator_rss::render(), views_handler_field_counter::render(), views_handler_field_file_size::render(), views_handler_field_user_name::render_link(), views_handler_field_user_language::render_link(), views_handler_field_user::render_link(), views_handler_field_upload_description::render_link(), views_handler_field_taxonomy::render_link(), views_handler_field_file::render_link(), views_handler_field_node::render_link(), views_handler_field_comment_username::render_link(), views_handler_field_comment::render_link(), views_handler_field_aggregator_category::render_link(), views_handler_argument_term_node_tid_depth::set_breadcrumb(), views_handler_argument_term_node_tid::set_breadcrumb(), views_object::set_default_options(), views_plugin_display::set_option(), views_plugin_display::set_override(), views_handler::set_relationship(), views_handler_filter::show_expose_button(), views_handler_filter::show_expose_form(), views_handler_filter::store_exposed_input(), views_handler_argument_string::summary_argument(), views_handler_argument_string::summary_query(), views_handler_argument_many_to_one::summary_query(), views_plugin_cache_time::summary_title(), views_plugin_access_role::summary_title(), views_plugin_access_perm::summary_title(), views_handler_argument_string::title(), views_handler_argument_numeric::title(), views_handler_argument_many_to_one::title(), views_handler_argument::uses_breadcrumb(), views_plugin_display_attachment::uses_exposed(), views_plugin_display::validate(), views_handler_argument_null::validate_argument_basic(), views_handler_argument::validate_fail(), views_plugin_argument_validate_php::validate_form(), views_plugin_argument_validate_user::validate_form(), views_plugin_argument_validate_taxonomy_term::validate_form(), views_plugin_argument_validate_node::validate_form(), views_handler_filter_term_node_tid::validate_term_strings(), views_handler_filter_user_name::value_form(), views_handler_filter_term_node_tid::value_form(), views_handler_filter_history_user_timestamp::value_form(), views_handler_filter_string::value_form(), views_handler_filter_numeric::value_form(), views_handler_filter_in_operator::value_form(), views_handler_filter_equality::value_form(), views_handler_filter_date::value_form(), views_handler_filter_boolean_operator::value_form(), views_handler_filter_in_operator::value_submit(), views_handler_filter_user_name::value_validate(), views_handler_filter_term_node_tid::value_validate(), views_handler_filter_boolean_operator::value_validate(), and views_handler_argument::wildcard_title().

00046 { }

views_plugin_style_list::options_form ( &$  form,
&$  form_state 
)

Render the given style.

Reimplemented from views_plugin_style.

Definition at line 28 of file views_plugin_style_list.inc.

References views_object::options().

00028                                               {
00029     parent::options_form($form, $form_state);
00030     $form['type'] = array(
00031       '#type' => 'radios',
00032       '#title' => t('List type'),
00033       '#options' => array('ul' => t('Unordered list'), 'ol' => t('Ordered list')),
00034       '#default_value' => $this->options['type'],
00035     );
00036   }

views_plugin::options_submit ( &$  form,
&$  form_state 
) [inherited]

Handle any special handling on the validate form.

Reimplemented in views_plugin_access, views_plugin_access_role, views_plugin_display, views_plugin_display_attachment, views_plugin_display_block, views_plugin_display_feed, and views_plugin_display_page.

Definition at line 369 of file plugins.inc.

00369 { }

views_plugin::options_validate ( &$  form,
&$  form_state 
) [inherited]

Validate the options form.

Reimplemented in views_plugin_access, views_plugin_access_role, views_plugin_display, and views_plugin_display_page.

Definition at line 364 of file plugins.inc.

00364 { }

views_plugin_style::pre_render ( $  result  )  [inherited]

Allow the style to do stuff before each row is rendered.

Parameters:
$result The full array of results from the query.

Definition at line 134 of file views_plugin_style.inc.

00134                                {
00135     if (!empty($this->row_plugin)) {
00136       $this->row_plugin->pre_render($result);
00137     }
00138   }

views_plugin_style::query (  )  [inherited]

Add anything to the query that we might need to.

Reimplemented from views_plugin.

Reimplemented in views_plugin_style_summary, and views_plugin_style_summary_jump_menu.

Definition at line 267 of file views_plugin_style.inc.

Referenced by views_plugin_style_rss::attach_to().

00267                    {
00268     parent::query();
00269     if (isset($this->row_plugin)) {
00270       $this->row_plugin->query();
00271     }
00272   }

views_plugin_style::render (  )  [inherited]

Render the display in this style.

Reimplemented in views_plugin_style_jump_menu, views_plugin_style_rss, views_plugin_style_summary, and views_plugin_style_summary_jump_menu.

Definition at line 143 of file views_plugin_style.inc.

References $title, views_object::options(), views_plugin_style::render_grouping(), views_plugin::theme_functions(), and views_plugin_style::uses_row_plugin().

00143                     {
00144     if ($this->uses_row_plugin() && empty($this->row_plugin)) {
00145       vpr('views_plugin_style_default: Missing row plugin');
00146       return;
00147     }
00148 
00149     // Group the rows according to the grouping field, if specified.
00150     $sets = $this->render_grouping($this->view->result, $this->options['grouping']);
00151 
00152     // Render each group separately and concatenate.  Plugins may override this
00153     // method if they wish some other way of handling grouping.
00154     $output = '';
00155     foreach ($sets as $title => $records) {
00156       if ($this->uses_row_plugin()) {
00157         $rows = array();
00158         foreach ($records as $row_index => $row) {
00159           $this->view->row_index = $row_index;
00160           $rows[] = $this->row_plugin->render($row);
00161         }
00162       }
00163       else {
00164         $rows = $records;
00165       }
00166 
00167       $output .= theme($this->theme_functions(), $this->view, $this->options, $rows, $title);
00168     }
00169     unset($this->view->row_index);
00170     return $output;
00171   }

views_plugin_style::render_fields ( $  result  )  [inherited]

Render all of the fields for a given style and store them on the object.

Parameters:
$result The result array from $view->result

Definition at line 216 of file views_plugin_style.inc.

References views_plugin_style::uses_fields().

Referenced by views_plugin_style::get_field(), views_plugin_style_jump_menu::render(), and views_plugin_style::render_grouping().

00216                                   {
00217     if (!$this->uses_fields()) {
00218       return;
00219     }
00220 
00221     $start = views_microtime();
00222     if (isset($this->rendered_fields)) {
00223       return $this->rendered_fields;
00224     }
00225 
00226     $this->view->row_index = 0;
00227     $keys = array_keys($this->view->field);
00228     foreach ($result as $count => $row) {
00229       $this->view->row_index = $count;
00230       foreach ($keys as $id) {
00231         $this->rendered_fields[$count][$id] = $this->view->field[$id]->theme($row);
00232       }
00233     }
00234     unset($this->view->row_index);
00235   }

views_plugin_style::render_grouping ( $  records,
$  grouping_field = '' 
) [inherited]

Group records as needed for rendering.

Parameters:
$records An array of records from the view to group.
$grouping_field The field id on which to group. If empty, the result set will be given a single group with an empty string as a label.
Returns:
The grouped record set.

Definition at line 184 of file views_plugin_style.inc.

References views_plugin_style::get_field(), and views_plugin_style::render_fields().

Referenced by views_plugin_style::render().

00184                                                            {
00185     // Make sure fields are rendered
00186     $this->render_fields($this->view->result);
00187     $sets = array();
00188     if ($grouping_field) {
00189       foreach ($records as $index => $row) {
00190         $grouping = '';
00191         // Group on the rendered version of the field, not the raw.  That way,
00192         // we can control any special formatting of the grouping field through
00193         // the admin or theme layer or anywhere else we'd like.
00194         if (isset($this->view->field[$grouping_field])) {
00195           $grouping = $this->get_field($index, $grouping_field);
00196           if ($this->view->field[$grouping_field]->options['label']) {
00197             $grouping = $this->view->field[$grouping_field]->options['label'] . ': ' . $grouping;
00198           }
00199         }
00200         $sets[$grouping][$index] = $row;
00201       }
00202     }
00203     else {
00204       // Create a single group with an empty grouping field.
00205       $sets[''] = $records;
00206     }
00207     return $sets;
00208   }

views_object::set_default_options (  )  [inherited]

Set default options.

For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.

Definition at line 53 of file base.inc.

References views_object::_set_option_defaults(), views_object::option_definition(), and views_object::options().

Referenced by views_object::construct().

00053                                  {
00054     $this->_set_option_defaults($this->options, $this->option_definition());
00055 
00056     // Retained for complex defaults plus backward compatibility.
00057     $this->options($this->options);
00058   }

views_object::set_definition ( $  definition  )  [inherited]

Let the handler know what its full definition is.

Definition at line 108 of file base.inc.

00108                                        {
00109     $this->definition = $definition;
00110     if (isset($definition['field'])) {
00111       $this->real_field = $definition['field'];
00112     }
00113   }

views_plugin::theme_functions (  )  [inherited]

Provide a full list of possible theme templates used by this style.

Definition at line 379 of file plugins.inc.

Referenced by views_plugin_display::options_form(), views_plugin_style_summary::render(), views_plugin_style_rss::render(), views_plugin_style::render(), views_plugin_row::render(), views_plugin_display::render(), views_plugin_row_search_view::render(), views_plugin_row_comment_rss::render(), and views_plugin_row_aggregator_rss::render().

00379                              {
00380     return views_theme_functions($this->definition['theme'], $this->view, $this->display);
00381   }

views_object::unpack_options ( &$  storage,
$  options,
$  definition = NULL 
) [inherited]

Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.

Definition at line 79 of file base.inc.

References views_object::$options, and views_object::option_definition().

Referenced by views_plugin_style::init(), views_plugin_row::init(), views_plugin_display::init(), and views_handler::init().

00079                                                                    {
00080     if (!is_array($options)) {
00081       return;
00082     }
00083 
00084     if (!isset($definition)) {
00085       $definition = $this->option_definition();
00086     }
00087 
00088     foreach ($options as $key => $value) {
00089       if (is_array($value)) {
00090         if (!isset($storage[$key]) || !is_array($storage[$key])) {
00091           $storage[$key] = array();
00092         }
00093 
00094         $this->unpack_options($storage[$key], $value, isset($definition[$key]['contains']) ? $definition[$key]['contains'] : array());
00095       }
00096       else if (!empty($definition[$key]['translatable']) && !empty($value)) {
00097         $storage[$key] = t($value);
00098       }
00099       else {
00100         $storage[$key] = $value;
00101       }
00102     }
00103   }

views_plugin_style::uses_fields (  )  [inherited]

Return TRUE if this style also uses fields.

Definition at line 69 of file views_plugin_style.inc.

References views_plugin_style::uses_row_plugin().

Referenced by views_plugin_style::options_form(), and views_plugin_style::render_fields().

00069                          {
00070     // If we use a row plugin, ask the row plugin. Chances are, we don't
00071     // care, it does.
00072     if ($this->uses_row_plugin() && !empty($this->row_plugin)) {
00073       return $this->row_plugin->uses_fields();
00074     }
00075     // Otherwise, maybe we do.
00076     return !empty($this->definition['uses fields']);
00077   }

views_plugin_style::uses_row_plugin (  )  [inherited]

Return TRUE if this style also uses a row plugin.

Definition at line 62 of file views_plugin_style.inc.

Referenced by views_plugin_style::init(), views_plugin_style::render(), views_plugin_style::uses_fields(), and views_plugin_style::validate().

00062                              {
00063     return !empty($this->definition['uses row plugin']);
00064   }

views_plugin_style::validate (  )  [inherited]

Validate that the plugin is correct and can be saved.

Returns:
An array of error strings to tell the user what is wrong with this plugin.

Reimplemented from views_plugin.

Definition at line 255 of file views_plugin_style.inc.

References views_plugin_style::uses_row_plugin().

00255                       {
00256     $errors = parent::validate();
00257 
00258     if ($this->uses_row_plugin()) {
00259       $plugin = $this->display->handler->get_plugin('row');
00260       if (empty($plugin)) {
00261         $errors[] = t('Style @style requires a row style but the row plugin is invalid.', array('@style' => $this->definition['title']));
00262       }
00263     }
00264     return $errors;
00265   }

Member Data Documentation

views_object::$options = array() [inherited]

Except for displays, options for the object will be held here.

Definition at line 16 of file base.inc.

Referenced by views_plugin_display::_set_option_defaults(), views_object::_set_option_defaults(), views_handler_filter_string::admin_summary(), views_handler_filter_numeric::admin_summary(), views_handler_argument::default_argument_form(), views_handler_filter_term_node_tid::extra_options_form(), views_plugin_display::get_plugin(), views_handler_filter_node_type::get_value_options(), views_plugin_style::init(), views_plugin_row::init(), views_plugin_display::init(), views_handler_field_upload_description::init(), views_handler_field_term_node_tid::init(), views_handler_field_file::init(), views_plugin_row_node_view::init(), views_handler_field_history_user_timestamp::init(), views_handler_field_node_new_comments::init(), views_handler_field_comment::init(), views_handler::init(), views_handler_relationship::init(), views_handler_filter_many_to_one::init(), views_handler_filter::init(), views_handler_field::init(), views_handler_argument_string::init(), views_handler_argument_many_to_one::init(), views_handler_argument::init(), views_handler_filter::operator_form(), views_handler_filter_string::operator_options(), views_handler_filter_numeric::operator_options(), views_handler_filter_in_operator::operator_options(), views_handler_filter_string::operator_values(), views_handler_filter_numeric::operator_values(), views_handler_filter_in_operator::operator_values(), views_plugin_cache_time::option_defaults(), views_plugin_access_role::option_defaults(), views_plugin_access_perm::option_defaults(), views_plugin_style_table::option_definition(), views_plugin_style_summary_unformatted::option_definition(), views_plugin_style_summary_jump_menu::option_definition(), views_plugin_style_summary::option_definition(), views_plugin_style_rss::option_definition(), option_definition(), views_plugin_style_jump_menu::option_definition(), views_plugin_style_grid::option_definition(), views_plugin_style::option_definition(), views_plugin_row_fields::option_definition(), views_plugin_row::option_definition(), views_plugin_display_page::option_definition(), views_plugin_display_feed::option_definition(), views_plugin_display_block::option_definition(), views_plugin_display_attachment::option_definition(), views_plugin_display::option_definition(), views_handler_field_user_name::option_definition(), views_handler_field_user_mail::option_definition(), views_handler_field_user_link::option_definition(), views_handler_field_user::option_definition(), views_handler_field_is_online::option_definition(), views_handler_field_upload_fid::option_definition(), views_handler_field_upload_description::option_definition(), views_handler_relationship_translation::option_definition(), views_handler_filter_node_tnid::option_definition(), views_handler_relationship_node_term_data::option_definition(), views_handler_filter_term_node_tid_depth::option_definition(), views_handler_filter_term_node_tid::option_definition(), views_handler_field_term_node_tid::option_definition(), views_handler_field_taxonomy::option_definition(), views_handler_argument_term_node_tid_depth::option_definition(), views_handler_argument_term_node_tid::option_definition(), views_handler_field_file::option_definition(), views_handler_field_accesslog_path::option_definition(), views_plugin_row_search_view::option_definition(), views_handler_filter_search::option_definition(), views_handler_field_search_score::option_definition(), views_plugin_row_node_view::option_definition(), views_plugin_row_node_rss::option_definition(), views_handler_field_node_link::option_definition(), views_handler_field_node::option_definition(), views_handler_field_history_user_timestamp::option_definition(), views_handler_field_locale_link_edit::option_definition(), views_handler_field_contact_link::option_definition(), views_plugin_row_comment_view::option_definition(), views_handler_field_node_new_comments::option_definition(), views_handler_field_ncs_last_comment_name::option_definition(), views_handler_field_comment_username::option_definition(), views_handler_field_comment_node_link::option_definition(), views_handler_field_comment_link::option_definition(), views_handler_field_comment::option_definition(), views_plugin_row_aggregator_rss::option_definition(), views_handler_field_aggregator_title_link::option_definition(), views_handler_field_aggregator_category::option_definition(), views_handler_sort_date::option_definition(), views_handler_sort::option_definition(), views_handler_relationship::option_definition(), views_handler_filter_string::option_definition(), views_handler_filter_numeric::option_definition(), views_handler_filter_many_to_one::option_definition(), views_handler_filter_in_operator::option_definition(), views_handler_filter_date::option_definition(), views_handler_filter_boolean_operator::option_definition(), views_handler_filter::option_definition(), views_handler_field_url::option_definition(), views_handler_field_prerender_list::option_definition(), views_handler_field_numeric::option_definition(), views_handler_field_date::option_definition(), views_handler_field_custom::option_definition(), views_handler_field_counter::option_definition(), views_handler_field_boolean::option_definition(), views_handler_field_file_size::option_definition(), views_handler_field::option_definition(), views_handler_argument_string::option_definition(), views_handler_argument_numeric::option_definition(), views_handler_argument_null::option_definition(), views_handler_argument_many_to_one::option_definition(), views_handler_argument::option_definition(), views_plugin_style_default::options(), views_plugin_style_jump_menu::options_form(), views_plugin_style::options_form(), views_plugin_row_fields::options_form(), views_plugin_display::options_form(), views_plugin_cache_time::options_form(), views_handler_relationship_translation::options_form(), views_handler_relationship_node_term_data::options_form(), views_handler_field_term_node_tid::options_form(), views_handler_field_search_score::options_form(), views_plugin_row_node_view::options_form(), views_handler_field::options_form(), views_handler_argument::options_form(), views_plugin_display_page::options_summary(), views_plugin_display_feed::options_summary(), views_plugin_display_block::options_summary(), views_plugin_display_attachment::options_summary(), views_plugin_display::options_summary(), views_handler_filter_in_operator::reduce_value_options(), views_plugin_style_summary_jump_menu::render(), views_plugin_style_jump_menu::render(), views_plugin_style_jump_menu::render_set(), views_plugin_display::set_override(), views_object::unpack_options(), views_plugin_argument_validate_taxonomy_term::validate_form(), views_plugin_argument_validate_node::validate_form(), views_handler_filter_term_node_tid::value_form(), and views_handler_filter_in_operator::value_form().

The documentation for this class was generated from the following file:
Generated on Mon Nov 30 15:07:01 2009 for Views by  doxygen 1.4.7