diff --git a/includes/handlers.inc b/includes/handlers.inc
index 4796ffc4a18b5ea58d39b90646a0b1edf6e46fb1..0a1d317959aae8c62190e523a674441783ba88b3 100644
--- a/includes/handlers.inc
+++ b/includes/handlers.inc
@@ -118,603 +118,6 @@ function views_get_table_join($table, $base_table) {
vpr("Missing join: @table @base_table", array('@table' => $table, '@base_table' => $base_table));
}
-/**
- * Base handler, from which all the other handlers are derived.
- * It creates a common interface to create consistency amongst
- * handlers and data.
- *
- * Definition terms:
- * - table: The actual table this uses; only specify if different from
- * the table this is attached to.
- * - real field: The actual field this uses; only specify if different from
- * the field this item is attached to.
- * - group: A text string representing the 'group' this item is attached to,
- * for display in the UI. Examples: "Node", "Taxonomy", "Comment",
- * "User", etc. This may be inherited from the parent definition or
- * the 'table' definition.
- * - title: The title for this handler in the UI. This may be inherited from
- * the parent definition or the 'table' definition.
- * - help: A more informative string to give to the user to explain what this
- * field/handler is or does.
- * - access callback: If this field should have access control, this could
- * be a function to use. 'user_access' is a common
- * function to use here. If not specified, no access
- * control is provided.
- * - access arguments: An array of arguments for the access callback.
- */
-abstract class views_handler extends ViewsObject {
- /**
- * The top object of a view.
- *
- * @var view
- */
- var $view = NULL;
-
- /**
- * Where the $query object will reside:
- *
- * @var views_plugin_query
- */
- var $query = NULL;
-
- /**
- * The type of the handler, for example filter/footer/field.
- */
- var $handler_type = NULL;
-
- /**
- * The alias of the table of this handler which is used in the query.
- */
- public $table_alias;
-
- /**
- * The actual field in the database table, maybe different
- * on other kind of query plugins/special handlers.
- */
- var $real_field;
-
- /**
- * The relationship used for this field.
- */
- var $relationship = NULL;
-
- /**
- * init the handler with necessary data.
- * @param $view
- * The $view object this handler is attached to.
- * @param $options
- * The item from the database; the actual contents of this will vary
- * based upon the type of handler.
- */
- function init(&$view, &$options) {
- $this->view = &$view;
- $display_id = $this->view->current_display;
- // Check to see if this handler type is defaulted. Note that
- // we have to do a lookup because the type is singular but the
- // option is stored as the plural.
-
- // If the 'moved to' keyword moved our handler, let's fix that now.
- if (isset($this->actual_table)) {
- $options['table'] = $this->actual_table;
- }
-
- if (isset($this->actual_field)) {
- $options['field'] = $this->actual_field;
- }
-
- $types = View::views_object_types();
- $plural = $this->handler_type;
- if (isset($types[$this->handler_type]['plural'])) {
- $plural = $types[$this->handler_type]['plural'];
- }
- if ($this->view->display_handler->is_defaulted($plural)) {
- $display_id = 'default';
- }
-
- $this->localization_keys = array(
- $display_id,
- $this->handler_type,
- $options['table'],
- $options['id']
- );
-
- $this->unpack_options($this->options, $options);
-
- // This exist on most handlers, but not all. So they are still optional.
- if (isset($options['table'])) {
- $this->table = $options['table'];
- }
-
- if (isset($this->definition['real field'])) {
- $this->real_field = $this->definition['real field'];
- }
-
- if (isset($this->definition['field'])) {
- $this->real_field = $this->definition['field'];
- }
-
- if (isset($options['field'])) {
- $this->field = $options['field'];
- if (!isset($this->real_field)) {
- $this->real_field = $options['field'];
- }
- }
-
- $this->query = &$view->query;
- }
-
- function option_definition() {
- $options = parent::option_definition();
-
- $options['id'] = array('default' => '');
- $options['table'] = array('default' => '');
- $options['field'] = array('default' => '');
- $options['relationship'] = array('default' => 'none');
- $options['group_type'] = array('default' => 'group');
- $options['ui_name'] = array('default' => '');
-
- return $options;
- }
-
- /**
- * Return a string representing this handler's name in the UI.
- */
- 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'];
- return t('!group: !title', array('!group' => $this->definition['group'], '!title' => $title));
- }
-
- /**
- * Shortcut to get a handler's raw field value.
- *
- * This should be overridden for handlers with formulae or other
- * non-standard fields. Because this takes an argument, fields
- * overriding this can just call return parent::get_field($formula)
- */
- function get_field($field = NULL) {
- if (!isset($field)) {
- if (!empty($this->formula)) {
- $field = $this->get_formula();
- }
- else {
- $field = $this->table_alias . '.' . $this->real_field;
- }
- }
-
- // If grouping, check to see if the aggregation method needs to modify the field.
- if ($this->view->display_handler->use_group_by()) {
- $this->view->init_query();
- if ($this->query) {
- $info = $this->query->get_aggregation_info();
- if (!empty($info[$this->options['group_type']]['method']) && function_exists($info[$this->options['group_type']]['method'])) {
- return $info[$this->options['group_type']]['method']($this->options['group_type'], $field);
- }
- }
- }
-
- return $field;
- }
-
- /**
- * Sanitize the value for output.
- *
- * @param $value
- * The value being rendered.
- * @param $type
- * The type of sanitization needed. If not provided, check_plain() is used.
- *
- * @return string
- * Returns the safe value.
- */
- function sanitize_value($value, $type = NULL) {
- switch ($type) {
- case 'xss':
- $value = filter_xss($value);
- break;
- case 'xss_admin':
- $value = filter_xss_admin($value);
- break;
- case 'url':
- $value = check_url($value);
- break;
- default:
- $value = check_plain($value);
- break;
- }
- return $value;
- }
-
- /**
- * Transform a string by a certain method.
- *
- * @param $string
- * The input you want to transform.
- * @param $option
- * How do you want to transform it, possible values:
- * - upper: Uppercase the string.
- * - lower: lowercase the string.
- * - ucfirst: Make the first char uppercase.
- * - ucwords: Make each word in the string uppercase.
- *
- * @return string
- * The transformed string.
- */
- function case_transform($string, $option) {
- global $multibyte;
-
- switch ($option) {
- default:
- return $string;
- case 'upper':
- return drupal_strtoupper($string);
- case 'lower':
- return drupal_strtolower($string);
- case 'ucfirst':
- return drupal_strtoupper(drupal_substr($string, 0, 1)) . drupal_substr($string, 1);
- case 'ucwords':
- if ($multibyte == UNICODE_MULTIBYTE) {
- return mb_convert_case($string, MB_CASE_TITLE);
- }
- else {
- return ucwords($string);
- }
- }
- }
-
- /**
- * Validate the options form.
- */
- function options_validate(&$form, &$form_state) { }
-
- /**
- * Build the options form.
- */
- function options_form(&$form, &$form_state) {
- // Some form elements belong in a fieldset for presentation, but can't
- // be moved into one because of the form_state['values'] hierarchy. Those
- // elements can add a #fieldset => 'fieldset_name' property, and they'll
- // be moved to their fieldset during pre_render.
- $form['#pre_render'][] = 'views_ui_pre_render_add_fieldset_markup';
-
- $form['ui_name'] = array(
- '#type' => 'textfield',
- '#title' => t('Administrative title'),
- '#description' => t('This title will be displayed on the views edit page instead of the default one. This might be useful if you have the same item twice.'),
- '#default_value' => $this->options['ui_name'],
- '#fieldset' => 'more',
- );
-
- // This form is long and messy enough that the "Administrative title" option
- // belongs in a "more options" fieldset at the bottom of the form.
- $form['more'] = array(
- '#type' => 'fieldset',
- '#title' => t('More'),
- '#collapsible' => TRUE,
- '#collapsed' => TRUE,
- '#weight' => 150,
- );
- // Allow to alter the default values brought into the form.
- drupal_alter('views_handler_options', $this->options, $view);
- }
-
- /**
- * Perform any necessary changes to the form values prior to storage.
- * There is no need for this function to actually store the data.
- */
- function options_submit(&$form, &$form_state) { }
-
- /**
- * Provides the handler some groupby.
- */
- function use_group_by() {
- return TRUE;
- }
- /**
- * Provide a form for aggregation settings.
- */
- function groupby_form(&$form, &$form_state) {
- $view = &$form_state['view'];
- $display_id = $form_state['display_id'];
- $types = View::views_object_types();
- $type = $form_state['type'];
- $id = $form_state['id'];
-
- $form['#title'] = check_plain($view->display[$display_id]->display_title) . ': ';
- $form['#title'] .= t('Configure aggregation settings for @type %item', array('@type' => $types[$type]['lstitle'], '%item' => $this->ui_name()));
-
- $form['#section'] = $display_id . '-' . $type . '-' . $id;
-
- $view->init_query();
- $info = $view->query->get_aggregation_info();
- foreach ($info as $id => $aggregate) {
- $group_types[$id] = $aggregate['title'];
- }
-
- $form['group_type'] = array(
- '#type' => 'select',
- '#title' => t('Aggregation type'),
- '#default_value' => $this->options['group_type'],
- '#description' => t('Select the aggregation function to use on this field.'),
- '#options' => $group_types,
- );
- }
-
- /**
- * Perform any necessary changes to the form values prior to storage.
- * There is no need for this function to actually store the data.
- */
- function groupby_form_submit(&$form, &$form_state) {
- $item =& $form_state['handler']->options;
-
- $item['group_type'] = $form_state['values']['options']['group_type'];
- }
-
- /**
- * If a handler has 'extra options' it will get a little settings widget and
- * another form called extra_options.
- */
- function has_extra_options() { return FALSE; }
-
- /**
- * Provide defaults for the handler.
- */
- function extra_options(&$option) { }
-
- /**
- * Provide a form for setting options.
- */
- function extra_options_form(&$form, &$form_state) { }
-
- /**
- * Validate the options form.
- */
- function extra_options_validate($form, &$form_state) { }
-
- /**
- * Perform any necessary changes to the form values prior to storage.
- * There is no need for this function to actually store the data.
- */
- function extra_options_submit($form, &$form_state) { }
-
- /**
- * Determine if a handler can be exposed.
- */
- function can_expose() { return FALSE; }
-
- /**
- * Set new exposed option defaults when exposed setting is flipped
- * on.
- */
- function expose_options() { }
-
- /**
- * Get information about the exposed form for the form renderer.
- */
- function exposed_info() { }
-
- /**
- * Render our chunk of the exposed handler form when selecting
- */
- function exposed_form(&$form, &$form_state) { }
-
- /**
- * Validate the exposed handler form
- */
- function exposed_validate(&$form, &$form_state) { }
-
- /**
- * Submit the exposed handler form
- */
- function exposed_submit(&$form, &$form_state) { }
-
- /**
- * Form for exposed handler options.
- */
- function expose_form(&$form, &$form_state) { }
-
- /**
- * Validate the options form.
- */
- function expose_validate($form, &$form_state) { }
-
- /**
- * Perform any necessary changes to the form exposes prior to storage.
- * There is no need for this function to actually store the data.
- */
- function expose_submit($form, &$form_state) { }
-
- /**
- * Shortcut to display the expose/hide button.
- */
- function show_expose_button(&$form, &$form_state) { }
-
- /**
- * Shortcut to display the exposed options form.
- */
- function show_expose_form(&$form, &$form_state) {
- if (empty($this->options['exposed'])) {
- return;
- }
-
- $this->expose_form($form, $form_state);
-
- // When we click the expose button, we add new gadgets to the form but they
- // have no data in $_POST so their defaults get wiped out. This prevents
- // these defaults from getting wiped out. This setting will only be TRUE
- // during a 2nd pass rerender.
- if (!empty($form_state['force_expose_options'])) {
- foreach (element_children($form['expose']) as $id) {
- if (isset($form['expose'][$id]['#default_value']) && !isset($form['expose'][$id]['#value'])) {
- $form['expose'][$id]['#value'] = $form['expose'][$id]['#default_value'];
- }
- }
- }
- }
-
- /**
- * Check whether current user has access to this handler.
- *
- * @return boolean
- */
- function access() {
- if (isset($this->definition['access callback']) && function_exists($this->definition['access callback'])) {
- if (isset($this->definition['access arguments']) && is_array($this->definition['access arguments'])) {
- return call_user_func_array($this->definition['access callback'], $this->definition['access arguments']);
- }
- return $this->definition['access callback']();
- }
-
- return TRUE;
- }
-
- /**
- * Run before the view is built.
- *
- * This gives all the handlers some time to set up before any handler has
- * been fully run.
- */
- function pre_query() { }
-
- /**
- * Run after the view is executed, before the result is cached.
- *
- * This gives all the handlers some time to modify values. This is primarily
- * used so that handlers that pull up secondary data can put it in the
- * $values so that the raw data can be utilized externally.
- */
- function post_execute(&$values) { }
-
- /**
- * Provides a unique placeholders for handlers.
- */
- function placeholder() {
- return $this->query->placeholder($this->options['table'] . '_' . $this->options['field']);
- }
-
- /**
- * Called just prior to query(), this lets a handler set up any relationship
- * it needs.
- */
- function set_relationship() {
- // Ensure this gets set to something.
- $this->relationship = NULL;
-
- // Don't process non-existant relationships.
- if (empty($this->options['relationship']) || $this->options['relationship'] == 'none') {
- return;
- }
-
- $relationship = $this->options['relationship'];
-
- // Ignore missing/broken relationships.
- if (empty($this->view->relationship[$relationship])) {
- return;
- }
-
- // Check to see if the relationship has already processed. If not, then we
- // cannot process it.
- if (empty($this->view->relationship[$relationship]->alias)) {
- return;
- }
-
- // Finally!
- $this->relationship = $this->view->relationship[$relationship]->alias;
- }
-
- /**
- * Ensure the main table for this handler is in the query. This is used
- * a lot.
- */
- function ensure_my_table() {
- if (!isset($this->table_alias)) {
- if (!method_exists($this->query, 'ensure_table')) {
- vpr(t('Ensure my table called but query has no ensure_table method.'));
- return;
- }
- $this->table_alias = $this->query->ensure_table($this->table, $this->relationship);
- }
- return $this->table_alias;
- }
-
- /**
- * Provide text for the administrative summary
- */
- function admin_summary() { }
-
- /**
- * Determine if the argument needs a style plugin.
- *
- * @return TRUE/FALSE
- */
- function needs_style_plugin() { return FALSE; }
-
- /**
- * Determine if this item is 'exposed', meaning it provides form elements
- * to let users modify the view.
- *
- * @return TRUE/FALSE
- */
- function is_exposed() {
- return !empty($this->options['exposed']);
- }
-
- /**
- * Take input from exposed handlers and assign to this handler, if necessary.
- */
- function accept_exposed_input($input) { return TRUE; }
-
- /**
- * If set to remember exposed input in the session, store it there.
- */
- function store_exposed_input($input, $status) { return TRUE; }
-
- /**
- * Get the join object that should be used for this handler.
- *
- * This method isn't used a great deal, but it's very handy for easily
- * getting the join if it is necessary to make some changes to it, such
- * as adding an 'extra'.
- */
- function get_join() {
- // get the join from this table that links back to the base table.
- // Determine the primary table to seek
- if (empty($this->query->relationships[$this->relationship])) {
- $base_table = $this->query->base_table;
- }
- else {
- $base_table = $this->query->relationships[$this->relationship]['base'];
- }
-
- $join = views_get_table_join($this->table, $base_table);
- if ($join) {
- return clone $join;
- }
- }
-
- /**
- * Validates the handler against the complete View.
- *
- * This is called when the complete View is being validated. For validating
- * the handler options form use options_validate().
- *
- * @see views_handler::options_validate()
- *
- * @return
- * Empty array if the handler is valid; an array of error strings if it is not.
- */
- function validate() { return array(); }
-
- /**
- * Determine if the handler is considered 'broken', meaning it's a
- * a placeholder used when a handler can't be found.
- */
- function broken() { }
-}
-
/**
* This many to one helper object is used on both arguments and filters.
*
diff --git a/includes/plugins.inc b/includes/plugins.inc
index 8e72578c8c7c9abb457cebfcfc7981cdd5c10184..a9de287bf8d1838445c2c0e6fde1159c29bf5145 100644
--- a/includes/plugins.inc
+++ b/includes/plugins.inc
@@ -68,110 +68,3 @@ function views_discover_plugins() {
drupal_alter('views_plugins', $cache);
return $cache;
}
-
-/**
- * Abstract base class to provide interface common to all plugins.
- */
-abstract class views_plugin extends ViewsObject {
- /**
- * The top object of a view.
- *
- * @var view
- */
- var $view = NULL;
-
- /**
- * The current used views display.
- *
- * @var views_display
- */
- var $display = NULL;
-
- /**
- * The plugin type of this plugin, for example style or query.
- */
- var $plugin_type = NULL;
-
- /**
- * The plugin name of this plugin, for example table or full.
- */
- var $plugin_name = NULL;
-
- /**
- * Init will be called after construct, when the plugin is attached to a
- * view and a display.
- */
-
- /**
- * Provide a form to edit options for this plugin.
- */
- function options_form(&$form, &$form_state) {
- // Some form elements belong in a fieldset for presentation, but can't
- // be moved into one because of the form_state['values'] hierarchy. Those
- // elements can add a #fieldset => 'fieldset_name' property, and they'll
- // be moved to their fieldset during pre_render.
- $form['#pre_render'][] = 'views_ui_pre_render_add_fieldset_markup';
- }
-
- /**
- * Validate the options form.
- */
- function options_validate(&$form, &$form_state) { }
-
- /**
- * Handle any special handling on the validate form.
- */
- function options_submit(&$form, &$form_state) { }
-
- /**
- * Add anything to the query that we might need to.
- */
- function query() { }
-
- /**
- * Provide a full list of possible theme templates used by this style.
- */
- function theme_functions() {
- return views_theme_functions($this->definition['theme'], $this->view, $this->display);
- }
-
- /**
- * Provide a list of additional theme functions for the theme information page
- */
- function additional_theme_functions() {
- $funcs = array();
- if (!empty($this->definition['additional themes'])) {
- foreach ($this->definition['additional themes'] as $theme => $type) {
- $funcs[] = views_theme_functions($theme, $this->view, $this->display);
- }
- }
- return $funcs;
- }
-
- /**
- * Validate that the plugin is correct and can be saved.
- *
- * @return
- * An array of error strings to tell the user what is wrong with this
- * plugin.
- */
- function validate() { return array(); }
-
- /**
- * Returns the summary of the settings in the display.
- */
- function summary_title() {
- return t('Settings');
- }
- /**
- * Return the human readable name of the display.
- *
- * This appears on the ui beside each plugin and beside the settings link.
- */
- function plugin_title() {
- if (isset($this->definition['short_title'])) {
- return check_plain($this->definition['short_title']);
- }
- return check_plain($this->definition['title']);
- }
-}