abstract class flag_handler_relationship in Flag 7.2
Same name and namespace in other branches
- 6.2 includes/flag_handler_relationships.inc \flag_handler_relationship
- 7.3 includes/views/flag_handler_relationships.inc \flag_handler_relationship
Base class for all our relationship classes.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_relationship
- class \flag_handler_relationship
- class \views_handler_relationship
- class \views_handler
Expanded class hierarchy of flag_handler_relationship
File
- includes/
flag_handler_relationships.inc, line 13 - Contains various relationship handlers.
View source
abstract class flag_handler_relationship extends views_handler_relationship {
/**
* Every relationship has a 'flag' option.
*/
function option_definition() {
$options = parent::option_definition();
$options['flag'] = array(
'default' => NULL,
);
$options['required'] = array(
'default' => 1,
);
return $options;
}
/**
* Make sure the flag exists.
*
* When importing views, or when deleting flags, inconsistent views may
* result. This validator is called by Views before saving or previewing a
* view.
*/
function validate() {
$errors = array();
$tokens = array(
'@relationship-name' => $this
->ui_name() . ' ' . $this
->admin_summary(),
'@flag-name' => $this->options['flag'],
);
if (!$this->options['flag']) {
$errors[] = t('You must pick a flag to use for the relationship "@relationship-name".', $tokens);
}
elseif (!flag_get_flag($this->options['flag'])) {
$errors[] = t('This view is looking for a flag by the name "@flag-name", but there is no such flag. Perhaps it was deleted. Please update the relationship "@relationship-name" in this view to use an existing flag.', $tokens);
}
return $errors;
}
function get_flag_type() {
return isset($this->definition['flag type']) ? $this->definition['flag type'] : NULL;
}
/**
* Returns the flag object.
*/
function get_flag() {
// Backward compatibility: There may exist old views on the system whose
// 'flag' option isn't set. (This happens if the admin had skippped
// clicking the 'Update' button.) When run, these views should behave as
// if the first flag was selected.
if (!isset($this->options['flag'])) {
$this->options['flag'] = flag_views_flag_default($this
->get_flag_type());
}
// Validation: Since validate() is called only when in Views's
// administrative UI, we need to do validation at "run time" ourselves.
if ($errors = $this
->validate()) {
foreach ($errors as $error) {
drupal_set_message($error, 'error');
}
}
return flag_get_flag($this->options['flag']);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
flag_handler_relationship:: |
function | Returns the flag object. | ||
flag_handler_relationship:: |
function | |||
flag_handler_relationship:: |
function |
Every relationship has a 'flag' option. Overrides views_handler_relationship:: |
1 | |
flag_handler_relationship:: |
function |
Make sure the flag exists. Overrides views_handler:: |
||
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 | Provide text for the administrative summary. | 4 |
views_handler:: |
public | function | Determine if the handler is considered 'broken'. | 6 |
views_handler:: |
public | function | Determine if a handler can be exposed. | 2 |
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 | Render our chunk of the exposed handler form when selecting. | 1 |
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 | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
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 | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | 5 |
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 | Return a string representing this handler's name in the UI. | 9 |
views_handler_relationship:: |
public | function |
Let relationships live on tables other than the table they operate on. Overrides views_handler:: |
2 |
views_handler_relationship:: |
public | function | Get this field's label. | |
views_handler_relationship:: |
public | function |
Provide the label widget that all fields should have. Overrides views_handler:: |
4 |
views_handler_relationship:: |
public | function | Called to implement a relationship in a query. | 5 |
views_handler_relationship:: |
public | function |
You can't groupby a relationship. Overrides views_handler:: |
|
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 | Views handlers use a special construct function. | 4 |
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 |