class views_plugin_argument_default in Views (for Drupal 7) 6.3
Same name and namespace in other branches
- 6.2 plugins/views_plugin_argument_default.inc \views_plugin_argument_default
- 7.3 plugins/views_plugin_argument_default.inc \views_plugin_argument_default
The fixed argument default handler; also used as the base.
Hierarchy
- class \views_object
- class \views_plugin
Expanded class hierarchy of views_plugin_argument_default
Related topics
1 string reference to 'views_plugin_argument_default'
- views_views_plugins in includes/
plugins.inc - Implementation of hook_views_plugins
File
- plugins/
views_plugin_argument_default.inc, line 20 - Contains the fixed argument default plugin.
View source
class views_plugin_argument_default extends views_plugin {
/**
* Return the default argument.
*
* This needs to be overridden by every default argument handler to properly do what is needed.
*/
function get_argument() {
}
/**
* Initialize this plugin with the view and the argument
* it is linked to.
*/
function init(&$view, &$argument, $options) {
$this->view =& $view;
$this->argument =& $argument;
$this
->convert_options($options);
$this
->unpack_options($this->options, $options);
}
/**
* Retrieve the options when this is a new access
* control plugin
*/
function option_definition() {
return array();
}
/**
* Provide the default form for setting options.
*/
function options_form(&$form, &$form_state) {
}
/**
* Provide the default form form for validating options
*/
function options_validate(&$form, &$form_state) {
}
/**
* Provide the default form form for submitting options
*/
function options_submit($form, &$form_state) {
}
/**
* Determine if the administrator has the privileges to use this
* plugin
*/
function access() {
return TRUE;
}
/**
* If we don't have access to the form but are showing it anyway, ensure that
* the form is safe and cannot be changed from user input.
*
* This is only called by child objects if specified in the options_form(),
* so it will not always be used.
*/
function check_access(&$form, $option_name) {
if (!$this
->access()) {
$form[$option_name]['#disabled'] = TRUE;
$form[$option_name]['#value'] = $form[$this->option_name]['#default_value'];
$form[$option_name]['#description'] .= ' <strong>' . t('Note: you do not have permission to modify this. If you change the default argument type, this setting will be lost and you will NOT be able to get it back.') . '</strong>';
}
}
/**
* Convert options from the older style.
*
* In Views 3, the method of storing default argument options has changed
* and each plugin now gets its own silo. This method can be used to
* move arguments from the old style to the new style. See
* views_plugin_argument_default_fixed for a good example of this method.
*/
function convert_options(&$options) {
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
views_object:: |
property | Handler's definition | ||
views_object:: |
property | Except for displays, options for the object will be held here. | 1 | |
views_object:: |
function | Views handlers use a special construct function so that we can more easily construct them with variable arguments. | 6 | |
views_object:: |
function | 2 | ||
views_object:: |
function | 1 | ||
views_object:: |
function | |||
views_object:: |
function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | 1 | |
views_object:: |
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:: |
function | Let the handler know what its full definition is. | ||
views_object:: |
function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | ||
views_object:: |
function | Unpack a single option definition. | ||
views_object:: |
function | Unpacks each handler to store translatable texts. | ||
views_object:: |
function | |||
views_plugin:: |
property | The current used views display. | ||
views_plugin:: |
property | The plugin type of this plugin, for example style or query. | ||
views_plugin:: |
property |
The top object of a view. Overrides views_object:: |
1 | |
views_plugin:: |
function | Provide a list of additional theme functions for the theme information page | ||
views_plugin:: |
function | Add anything to the query that we might need to. | 7 | |
views_plugin:: |
function | Provide a full list of possible theme templates used by this style. | ||
views_plugin:: |
function | Validate that the plugin is correct and can be saved. | 2 | |
views_plugin_argument_default:: |
function | Determine if the administrator has the privileges to use this plugin | 1 | |
views_plugin_argument_default:: |
function | If we don't have access to the form but are showing it anyway, ensure that the form is safe and cannot be changed from user input. | ||
views_plugin_argument_default:: |
function | Convert options from the older style. | 4 | |
views_plugin_argument_default:: |
function | Return the default argument. | 7 | |
views_plugin_argument_default:: |
function | Initialize this plugin with the view and the argument it is linked to. | ||
views_plugin_argument_default:: |
function |
Provide the default form for setting options. Overrides views_plugin:: |
5 | |
views_plugin_argument_default:: |
function |
Provide the default form form for submitting options Overrides views_plugin:: |
1 | |
views_plugin_argument_default:: |
function |
Provide the default form form for validating options Overrides views_plugin:: |
||
views_plugin_argument_default:: |
function |
Retrieve the options when this is a new access
control plugin Overrides views_object:: |
5 |