class views_fields_on_off_form in Views Fields On/Off 7
Provides a handler that adds the form for Fields On/Off.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_field
- class \views_fields_on_off_form
- class \views_handler_field
- class \views_handler
Expanded class hierarchy of views_fields_on_off_form
2 string references to 'views_fields_on_off_form'
- views_fields_on_off_views_data in includes/
views/ views_fields_on_off.views.inc - Implements hook_views_data().
- views_fields_on_off_views_pre_view in ./
views_fields_on_off.module - Implements hook_views_pre_view().
File
- includes/
views/ views_fields_on_off_form.inc, line 11 - Definition of views_fields_on_off_form.
View source
class views_fields_on_off_form extends views_handler_field {
function can_expose() {
return TRUE;
}
function is_exposed() {
return TRUE;
}
function exposed_form(&$form, &$form_state) {
$fields = $this->options['fields'];
$options = array();
$checked = array();
$all_fields = $this
->get_field_labels_no_relationship_names($this->view->display_handler);
// Grab the fields_on_off values that have been submitted already.
$params = drupal_get_query_parameters();
$on_off_submitted = array_key_exists('fields_on_off_hidden_submitted', $params);
$checked_fields = array_key_exists('fields_on_off', $params) ? $params['fields_on_off'] : array();
// Now loop through the fields defined in the view.
foreach ($fields as $field) {
if ($field) {
$id = $field;
if (array_key_exists($id, $all_fields)) {
$label = $all_fields[$id];
$options[$id] = $label;
// If the field is included on the querystring...
$check_me = !count($checked_fields) && !$on_off_submitted || array_key_exists($id, $checked_fields);
if ($check_me) {
// Check it because it has already been selected
$checked[$id] = TRUE;
}
}
}
}
// Form API to build the checkboxes.
$form['fields_on_off'] = array(
'#type' => 'checkboxes',
'#title' => t('Show Fields'),
'#description' => t('Select the fields you want to display'),
'#options' => $options,
'#value' => $options,
);
$form["fields_on_off_hidden_submitted"] = array(
'#type' => 'hidden',
'#default_value' => 1,
);
// Have to use $form_state['input'] because setting the default values on
// the form field itself doesn't work.
// Because of how Views handles the exposed filters,
// this is how we set our values in the form.
$form_state['input']['fields_on_off'] = $checked;
}
function option_definition() {
$options = parent::option_definition();
$options['fields'] = array(
'default' => array(),
);
return $options;
}
/**
* Retrieve a list of fields for the current display.
*
* @param $display_handler
* @return array
* array of Views options
*/
function get_field_labels_no_relationship_names($display_handler) {
$groupable_only = FALSE;
$options = array();
foreach ($display_handler
->get_handlers('field') as $id => $handler) {
if ($groupable_only && !$handler
->use_string_group_by()) {
// Continue to next handler if it's not groupable.
continue;
}
if ($label = $handler
->label()) {
$options[$id] = $label;
}
else {
$options[$id] = $handler
->ui_name();
}
}
return $options;
}
function options_form(&$form, &$form_state) {
$all_fields = $this
->get_field_labels_no_relationship_names($this->view->display_handler);
// Remove any field that have been excluded from the display from the list.
foreach ($all_fields as $key => $field) {
$exclude = $this->view->display_handler->handlers['field'][$key]->options['exclude'];
if ($exclude) {
unset($all_fields[$key]);
}
}
// Offer to include only those fields that follow this one.
$field_options = array_slice($all_fields, 0, array_search($this->options['id'], array_keys($all_fields)));
$form['fields'] = array(
'#type' => 'checkboxes',
'#title' => t('Fields'),
'#description' => t('Fields to be turned on and off.'),
'#options' => $field_options,
'#default_value' => $this->options['fields'],
);
}
function query() {
// This is not a real field and it only affects the query by excluding
// fields from the display. But Views won't render if the query()
// method is not present. This doesn't do anything, but it has to be here.
// This function is a void so it doesn't return anything.
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
views_fields_on_off_form:: |
function |
Determine if a handler can be exposed. Overrides views_handler:: |
||
views_fields_on_off_form:: |
function |
Render our chunk of the exposed handler form when selecting. Overrides views_handler:: |
||
views_fields_on_off_form:: |
function | Retrieve a list of fields for the current display. | ||
views_fields_on_off_form:: |
function |
Determine if this item is 'exposed', meaning it provides form elements
to let users modify the view. Overrides views_handler:: |
||
views_fields_on_off_form:: |
function |
Default options form provides the label widget that all fields should have. Overrides views_handler_field:: |
||
views_fields_on_off_form:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_field:: |
||
views_fields_on_off_form:: |
function |
Called to add the field to a query. Overrides views_handler_field:: |
||
views_handler:: |
public | property | The type of the handler, for example filter/footer/field. | |
views_handler:: |
public | property | Where the $query object will reside:. | 1 |
views_handler:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
views_handler:: |
public | property | The relationship used for this field. | |
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. | |
views_handler:: |
public | property |
The top object of a view. Overrides views_object:: |
|
views_handler:: |
public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
views_handler:: |
public | function | Check whether current user has access to this handler. | 10 |
views_handler:: |
public | function | Determine if the handler is considered 'broken'. | 6 |
views_handler:: |
public | function | Transform a string by a certain method. | |
views_handler:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
views_handler:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
views_handler:: |
public | function | Submit the exposed handler form. | |
views_handler:: |
public | function | Validate the exposed handler form. | 4 |
views_handler:: |
public | function | Form for exposed handler options. | 2 |
views_handler:: |
public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 |
views_handler:: |
public | 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:: |
public | function | Validate the options form. | 1 |
views_handler:: |
public | function | Provide defaults for the handler. | |
views_handler:: |
public | function | Provide a form for setting options. | 1 |
views_handler:: |
public | 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:: |
public | function | Validate the options form. | |
views_handler:: |
public | function | Shortcut to get a handler's raw field value. | |
views_handler:: |
public | function | Get the join object that should be used for this handler. | |
views_handler:: |
public | function | Provide a form for aggregation settings. | 1 |
views_handler:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | 1 |
views_handler:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
views_handler:: |
public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 |
views_handler:: |
public | function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | 1 |
views_handler:: |
public | function | Determine if the argument needs a style plugin. | 1 |
views_handler:: |
public | function | Validate the options form. | 4 |
views_handler:: |
public | function | Provides a unique placeholders for handlers. | |
views_handler:: |
public | function | Run after the view is executed, before the result is cached. | 1 |
views_handler:: |
public | function | Run before the view is built. | 1 |
views_handler:: |
public | function | Sanitize the value for output. | |
views_handler:: |
public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
public | function | Shortcut to display the expose/hide button. | 2 |
views_handler:: |
public | function | Shortcut to display the exposed options form. | |
views_handler:: |
public | function | If set to remember exposed input in the session, store it there. | 1 |
views_handler:: |
public | function | Provides the handler some groupby. | 2 |
views_handler:: |
public | function | Validates the handler against the complete View. | 1 |
views_handler_field:: |
public | property | Stores additional fields which get added to the query. The generated aliases are stored in $aliases. | |
views_handler_field:: |
public | property | ||
views_handler_field:: |
public | property | ||
views_handler_field:: |
protected | property | Keeps track of the last render index. | |
views_handler_field:: |
public | property | The field value prior to any rewriting. | |
views_handler_field:: |
public | function | Add 'additional' fields to the query. | |
views_handler_field:: |
public | function | Add any special tokens this field might use for itself. | 4 |
views_handler_field:: |
public | function |
Provide extra data to the administration form Overrides views_handler:: |
|
views_handler_field:: |
public | function | Render a field using advanced settings. | |
views_handler_field:: |
public | function | Determine if this field can allow advanced rendering. | 1 |
views_handler_field:: |
public | function | Called to determine what to tell the clicksorter. | 1 |
views_handler_field:: |
public | function | Determine if this field is click sortable. | 1 |
views_handler_field:: |
public | function |
Construct a new field handler. Overrides views_object:: |
17 |
views_handler_field:: |
public | function | Document any special tokens this field might use for itself. | 4 |
views_handler_field:: |
public | function | Return the class of the field. | |
views_handler_field:: |
public | function | Return the class of the field's label. | |
views_handler_field:: |
public | function | Return an HTML element for the label based upon the field's element type. | |
views_handler_field:: |
public | function | Return an HTML element based upon the field's element type. | 2 |
views_handler_field:: |
public | function | Return the class of the field's wrapper. | |
views_handler_field:: |
public | function | Return an HTML element for the wrapper based upon the field's element type. | |
views_handler_field:: |
public | function | Provide a list of elements valid for field HTML. | |
views_handler_field:: |
public | function | Get the 'render' tokens to use for advanced rendering. | |
views_handler_field:: |
public | function | Recursive function to add replacements for nested query string parameters. | |
views_handler_field:: |
public | function | Get the value that's supposed to be rendered. | 3 |
views_handler_field:: |
public | function |
Init the handler with necessary data. Overrides views_handler:: |
11 |
views_handler_field:: |
public | function | Checks if a field value is empty. | |
views_handler_field:: |
public | function | Get this field's label. | |
views_handler_field:: |
public | function |
Performs some cleanup tasks on the options array before saving it. Overrides views_handler:: |
1 |
views_handler_field:: |
public | function | Run before any fields are rendered. | 8 |
views_handler_field:: |
public | function | Render the field. | 42 |
views_handler_field:: |
public | function | Render this field as altered text, from a fieldset set by the user. | |
views_handler_field:: |
public | function | Render this field as a link, with info from a fieldset set by the user. | |
views_handler_field:: |
public | function | Perform an advanced text render for the item. | |
views_handler_field:: |
public | function | Trim the field down to the specified length. | |
views_handler_field:: |
public | function | Call out to the theme() function. | |
views_handler_field:: |
public | function | Build a list of suitable theme functions for this view. | |
views_handler_field:: |
public | function | Replace a value with tokens from the last field. | |
views_handler_field:: |
public | function |
Return a string representing this handler's name in the UI. Overrides views_handler:: |
1 |
views_handler_field:: |
public | function | Determines if this field will be available as an option to group the result by in the style settings. | |
views_object:: |
public | property | Handler's definition. | |
views_object:: |
public | property | Except for displays, options for the object will be held here. | 1 |
views_object:: |
function | Collect this handler's option definition and alter them, ready for use. | ||
views_object:: |
public | function | Destructor. | 2 |
views_object:: |
public | function | 1 | |
views_object:: |
public | function | ||
views_object:: |
public | function | Always exports the option, regardless of the default value. | |
views_object:: |
public | function | Set default options on this object. | 1 |
views_object:: |
public | function | Set default options. | |
views_object:: |
public | function | Let the handler know what its full definition is. | |
views_object:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
public | function | Unpack a single option definition. | |
views_object:: |
public | function | Unpacks each handler to store translatable texts. | |
views_object:: |
public | function |