class nodequeue_handler_relationship_nodequeue in Nodequeue 7.3
Same name and namespace in other branches
- 6.2 includes/views/nodequeue_handler_relationship_nodequeue.inc \nodequeue_handler_relationship_nodequeue
- 7.2 includes/views/nodequeue_handler_relationship_nodequeue.inc \nodequeue_handler_relationship_nodequeue
@file Specialized relationship handler to add nodequeues.
Hierarchy
- class \views_object
- class \views_handler
Expanded class hierarchy of nodequeue_handler_relationship_nodequeue
1 string reference to 'nodequeue_handler_relationship_nodequeue'
- nodequeue_views_data_alter in includes/
views/ nodequeue.views.inc - Implements hook_views_data_alter().
File
- includes/
views/ nodequeue_handler_relationship_nodequeue.inc, line 7 - Specialized relationship handler to add nodequeues.
View source
class nodequeue_handler_relationship_nodequeue extends views_handler_relationship {
/**
* Init handler to let relationships live on tables other than
* the table they operate on.
*/
function init(&$view, &$options) {
parent::init($view, $options);
}
function option_definition() {
$options = parent::option_definition();
$options['limit']['default'] = FALSE;
$options['queues']['default'] = array();
return $options;
}
/**
* 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['limit'] = array(
'#type' => 'checkbox',
'#title' => t('Limit to one or more queues (recommended)'),
'#default_value' => $this->options['limit'],
);
$options = array();
$queues = nodequeue_load_queues(nodequeue_get_all_queues(0, 0, TRUE), TRUE);
foreach ($queues as $queue) {
$options[$queue->name] = $queue->title;
}
$form['queues'] = array(
'#prefix' => '<div><div id="edit-options-queues">',
'#suffix' => '</div></div>',
'#type' => 'checkboxes',
'#title' => t('Queues'),
'#options' => $options,
'#default_value' => $this->options['queues'],
'#process' => array(
'form_process_checkboxes',
'ctools_dependent_process',
),
'#dependency' => array(
'edit-options-limit' => array(
TRUE,
),
),
);
}
/**
* Validate the options form.
*/
function options_validate(&$form, &$form_state) {
parent::options_validate($form, $form_state);
// Check that at least on queue has been selected.
$options = $form_state['values']['options'];
if ($options['limit'] && empty($options['queues'])) {
form_set_error('queues', t('You must check at least one queue.'));
}
}
/**
* Called to implement a relationship in a query.
*/
function query() {
// Figure out what base table this relationship brings to the party.
$join = new views_join();
$join->definition = array(
'table' => 'nodequeue_nodes',
'field' => 'nid',
'left_table' => 'node',
'left_field' => 'nid',
);
if (!empty($this->options['required'])) {
$join->definition['type'] = 'INNER';
}
if (!empty($this->options['limit'])) {
$queues = array_keys(array_filter($this->options['queues']));
$join->definition['extra'] = array(
array(
'field' => 'name',
'value' => $queues,
),
);
}
$join
->construct();
$alias = $join->definition['table'] . '_' . $join->definition['left_table'];
$this->alias = $this->query
->add_relationship($alias, $join, 'nodequeue_nodes', $this->relationship);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
nodequeue_handler_relationship_nodequeue:: |
function |
Init handler to let relationships live on tables other than
the table they operate on. Overrides views_handler_relationship:: |
||
nodequeue_handler_relationship_nodequeue:: |
function |
Default options form that provides the label widget that all fields
should have. Overrides views_handler_relationship:: |
||
nodequeue_handler_relationship_nodequeue:: |
function |
Validate the options form. Overrides views_handler:: |
||
nodequeue_handler_relationship_nodequeue:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_relationship:: |
||
nodequeue_handler_relationship_nodequeue:: |
function |
Called to implement a relationship in a query. Overrides views_handler_relationship:: |
||
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 | 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:: |
public | function | Validates the handler against the complete View. | 1 |
views_handler_relationship:: |
public | function | Get this field's label. | |
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 |