class views_plugin

class views_plugin extends views_object {
    
    /**
     * The top object of a view.
     *
     * @var view
     */
    public $view = NULL;
    
    /**
     * The current used views display.
     *
     * @var views_display
     */
    public $display = NULL;
    
    /**
     * The plugin type of this plugin, for example style or query.
     */
    public $plugin_type = NULL;
    
    /**
     * The plugin name of this plugin, for example table or full.
     */
    public $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.
     */
    public 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.
     */
    public function options_validate(&$form, &$form_state) {
    }
    
    /**
     * Handle any special handling on the validate form.
     */
    public function options_submit(&$form, &$form_state) {
    }
    
    /**
     * Add anything to the query that we might need to.
     */
    public function query() {
    }
    
    /**
     * Provide a full list of possible theme templates used by this style.
     */
    public function theme_functions() {
        if (empty($this->definition['theme'])) {
            $this->definition['theme'] = 'views_view';
        }
        return views_theme_functions($this->definition['theme'], $this->view, $this->display);
    }
    
    /**
     * Provide a list of additional theme functions for the theme info page.
     */
    public 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 array
     *   An array of error strings to tell the user what is wrong with this
     *   plugin.
     */
    public function validate() {
        return array();
    }
    
    /**
     * Returns the summary of the settings in the display.
     */
    public 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.
     */
    public function plugin_title() {
        if (isset($this->definition['short title'])) {
            return check_plain($this->definition['short title']);
        }
        return check_plain($this->definition['title']);
    }

}