class views_handler_area

Same name in other branches
  1. 7.x-3.x handlers/views_handler_area.inc \views_handler_area

Hierarchy

Expanded class hierarchy of views_handler_area

Related topics

1 string reference to 'views_handler_area'
views_views_handlers in includes/handlers.inc
Implementation of hook_views_handlers() to register all of the basic handlers views uses.

File

handlers/views_handler_area.inc, line 14

View source
class views_handler_area extends views_handler {
    
    /**
     * Get this field's label.
     */
    function label() {
        if (!isset($this->options['label'])) {
            return $this->ui_name();
        }
        return $this->options['label'];
    }
    function option_definition() {
        $options = parent::option_definition();
        $label = !empty($this->definition['label']) ? $this->definition['label'] : $this->definition['title'];
        $options['label'] = array(
            'default' => $label,
            'translatable' => TRUE,
        );
        $options['empty'] = array(
            'default' => 0,
            'bool' => TRUE,
        );
        return $options;
    }
    
    /**
     * Provide extra data to the administration form
     */
    function admin_summary() {
        return $this->label();
    }
    
    /**
     * Default options form that provides the label widget that all fields
     * should have.
     */
    function options_form(&$form, &$form_state) {
        parent::options_form($form, $form_state);
        $form['label'] = array(
            '#type' => 'textfield',
            '#title' => t('Label'),
            '#default_value' => isset($this->options['label']) ? $this->options['label'] : '',
            '#description' => t('The label for this area that will be displayed only administratively.'),
        );
        if ($form_state['type'] != 'empty') {
            $form['empty'] = array(
                '#type' => 'checkbox',
                '#title' => t('Display even if view has no result'),
                '#default_value' => isset($this->options['empty']) ? $this->options['empty'] : 0,
            );
        }
    }
    
    /**
     * Don't run a query
     */
    function query() {
    }
    
    /**
     * Render the area
     */
    function render($empty = FALSE) {
        return '';
    }
    
    /**
     * Area handlers shouldn't have groupby.
     */
    function use_group_by() {
        return FALSE;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
views_handler::$handler_type property The type of the handler, for example filter/footer/field.
views_handler::$query property Where the $query object will reside: 6
views_handler::$view property The top object of a view. Overrides views_object::$view
views_handler::accept_exposed_input function Take input from exposed handlers and assign to this handler, if necessary. 1
views_handler::access function Check whether current user has access to this handler. 6
views_handler::broken function Determine if the handler is considered 'broken', meaning it's a
a placeholder used when a handler can't be found.
6
views_handler::can_expose function Determine if a handler can be exposed. 2
views_handler::ensure_my_table function Ensure the main table for this handler is in the query. This is used
a lot.
8
views_handler::exposed_form function Render our chunk of the exposed handler form when selecting 2
views_handler::exposed_info function Get information about the exposed form for the form renderer. 1
views_handler::exposed_submit function Submit the exposed handler form
views_handler::exposed_validate function Validate the exposed handler form 4
views_handler::expose_form function Overridable form for exposed handler options.
views_handler::expose_form_left function 2
views_handler::expose_form_right function 2
views_handler::expose_options function Set new exposed option defaults when exposed setting is flipped
on.
2
views_handler::expose_submit 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 function Validate the options form. 1
views_handler::extra_options function Provide defaults for the handler.
views_handler::extra_options_form function Provide a form for setting options. 1
views_handler::extra_options_submit 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 function Validate the options form.
views_handler::get_field function Shortcut to get a handler's raw field value.
views_handler::get_join function Get the join object that should be used for this handler.
views_handler::has_extra_options function If a handler has 'extra options' it will get a little settings widget and
another form called extra_options.
1
views_handler::init function init the handler with necessary data. 5
views_handler::is_exposed function Determine if this item is 'exposed', meaning it provides form elements
to let users modify the view.
views_handler::needs_style_plugin function Determine if the argument needs a style plugin. 1
views_handler::options_submit function Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data.
4
views_handler::options_validate function Validate the options form. 4
views_handler::pre_query function Run before the view is built. 1
views_handler::sanitize_value function Sanitize the value for output.
views_handler::set_relationship function Called just prior to query(), this lets a handler set up any relationship
it needs.
views_handler::show_expose_button function Shortcut to display the expose/hide button.
views_handler::show_expose_form function Shortcut to display the exposed options form.
views_handler::store_exposed_input function If set to remember exposed input in the session, store it there. 1
views_handler::ui_name function Return a string representing this handler's name in the UI. 10
views_handler::validate function Validates the handler against the complete View. 1
views_handler_area::admin_summary function Provide extra data to the administration form Overrides views_handler::admin_summary
views_handler_area::label function Get this field's label.
views_handler_area::options_form function Default options form that provides the label widget that all fields
should have.
Overrides views_handler::options_form 2
views_handler_area::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler::option_definition 1
views_handler_area::query function Don't run a query Overrides views_handler::query 1
views_handler_area::render function Render the area 2
views_handler_area::use_group_by function Area handlers shouldn't have groupby. Overrides views_handler::use_group_by
views_object::$definition property Handler's definition
views_object::$options property Except for displays, options for the object will be held here. 1
views_object::construct function Views handlers use a special construct function so that we can more
easily construct them with variable arguments.
6
views_object::destroy function 2
views_object::export_option function 1
views_object::export_options function
views_object::options function Set default options on this object. Called by the constructor in a
complex chain to deal with backward compatibility.
1
views_object::set_default_options function Set default options.
For backward compatibility, it sends the options array; this is a
feature that will likely disappear at some point.
views_object::set_definition function Let the handler know what its full definition is.
views_object::unpack_options function Unpack options over our existing defaults, drilling down into arrays
so that defaults don't get totally blown away.
views_object::unpack_translatable function Unpack a single option definition.
views_object::unpack_translatables function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults function