class views_handler_sort_menu_hierarchy in Views (for Drupal 7) 6.3
Same name and namespace in other branches
- 6.2 handlers/views_handler_sort_menu_hierarchy.inc \views_handler_sort_menu_hierarchy
- 7.3 handlers/views_handler_sort_menu_hierarchy.inc \views_handler_sort_menu_hierarchy
Sort in menu hierarchy order.
Given a field name of 'p' this produces an ORDER BY on p1, p2, ..., p9; and optionally injects multiple joins to {menu_links} to sort by weight and title as well.
This is only really useful for the {menu_links} table.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_sort
- class \views_handler
Expanded class hierarchy of views_handler_sort_menu_hierarchy
Related topics
1 string reference to 'views_handler_sort_menu_hierarchy'
- book_views_data in modules/
book.views.inc - Implementation of hook_views_data()
File
- handlers/
views_handler_sort_menu_hierarchy.inc, line 14
View source
class views_handler_sort_menu_hierarchy extends views_handler_sort {
function option_definition() {
$options = parent::option_definition();
$options['sort_within_level'] = array(
'default' => FALSE,
);
return $options;
}
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['sort_within_level'] = array(
'#type' => 'checkbox',
'#title' => t('Sort within each hierarchy level'),
'#description' => t('Enable this to sort the items within each level of the hierarchy by weight and title. Warning: this may produce a slow query.'),
'#default_value' => $this->options['sort_within_level'],
);
}
function query() {
$this
->ensure_my_table();
$max_depth = isset($this->definition['max depth']) ? $this->definition['max depth'] : MENU_MAX_DEPTH;
for ($i = 1; $i <= $max_depth; ++$i) {
if ($this->options['sort_within_level']) {
$join = new views_join();
$join
->construct('menu_links', $this->table_alias, $this->field . $i, 'mlid');
$menu_links = $this->query
->add_table('menu_links', NULL, $join);
$this->query
->add_orderby($menu_links, 'weight', $this->options['order']);
$this->query
->add_orderby($menu_links, 'link_title', $this->options['order']);
}
// We need this even when also sorting by weight and title, to make sure
// that children of two parents with the same weight and title are
// correctly separated.
$this->query
->add_orderby($this->table_alias, $this->field . $i, $this->options['order']);
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
views_handler:: |
property | The type of the handler, for example filter/footer/field. | ||
views_handler:: |
property | Where the $query object will reside: | 6 | |
views_handler:: |
property |
The top object of a view. Overrides views_object:: |
||
views_handler:: |
function | Take input from exposed handlers and assign to this handler, if necessary. | 1 | |
views_handler:: |
function | Check whether current user has access to this handler. | 6 | |
views_handler:: |
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:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | 8 | |
views_handler:: |
function | Get information about the exposed form for the form renderer. | 1 | |
views_handler:: |
function | Submit the exposed handler form | ||
views_handler:: |
function | Validate the exposed handler form | 4 | |
views_handler:: |
function | Overridable form for exposed handler options. | ||
views_handler:: |
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:: |
function | Validate the options form. | 1 | |
views_handler:: |
function | Provide defaults for the handler. | ||
views_handler:: |
function | Provide a form for setting options. | 1 | |
views_handler:: |
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:: |
function | Validate the options form. | ||
views_handler:: |
function | Shortcut to get a handler's raw field value. | ||
views_handler:: |
function | Get the join object that should be used for this handler. | ||
views_handler:: |
function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 | |
views_handler:: |
function | init the handler with necessary data. | 5 | |
views_handler:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | ||
views_handler:: |
function | Determine if the argument needs a style plugin. | 1 | |
views_handler:: |
function | Run before the view is built. | 1 | |
views_handler:: |
function | Sanitize the value for output. | ||
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | ||
views_handler:: |
function | Shortcut to display the expose/hide button. | ||
views_handler:: |
function | Shortcut to display the exposed options form. | ||
views_handler:: |
function | If set to remember exposed input in the session, store it there. | 1 | |
views_handler:: |
function | Return a string representing this handler's name in the UI. | 10 | |
views_handler:: |
function | Provides the handler some groupby. | 2 | |
views_handler:: |
function | Validates the handler against the complete View. | 1 | |
views_handler_sort:: |
function |
Display whether or not the sort order is ascending or descending Overrides views_handler:: |
||
views_handler_sort:: |
function |
Determine if a sort can be exposed. Overrides views_handler:: |
||
views_handler_sort:: |
function |
Since all exposed sorts are grouped into one select box.
We don't return nothing when views call to exposed_form() Overrides views_handler:: |
||
views_handler_sort:: |
function |
Handle the 'left' side fo the exposed options form. Overrides views_handler:: |
||
views_handler_sort:: |
function |
Handle the 'right' side fo the exposed options form. Overrides views_handler:: |
||
views_handler_sort:: |
function |
Provide default options for exposed sorts. Overrides views_handler:: |
||
views_handler_sort:: |
function |
Simple submit handler Overrides views_handler:: |
||
views_handler_sort:: |
function |
Simple validate handler Overrides views_handler:: |
||
views_handler_sort:: |
function | Shortcut to display the value form. | ||
views_handler_sort:: |
function | Provide a list of options for the default sort form. Should be overridden by classes that don't override sort_form | ||
views_handler_sort:: |
function | |||
views_handler_sort:: |
function | |||
views_handler_sort_menu_hierarchy:: |
function |
Basic options for all sort criteria Overrides views_handler_sort:: |
||
views_handler_sort_menu_hierarchy:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_sort:: |
||
views_handler_sort_menu_hierarchy:: |
function |
Called to add the sort to a query. Overrides views_handler_sort:: |
||
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 |