class views_handler_sort_menu_hierarchy

  1. 3.x handlers/views_handler_sort_menu_hierarchy.inc views_handler_sort_menu_hierarchy
  2. 2.x 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. This is only really useful for the {menu_links} table.

Hierarchy

Expanded class hierarchy of views_handler_sort_menu_hierarchy

Related topics

Views' sort handlers
Handlers to tell Views how to sort queries
2 string references to 'views_handler_sort_menu_hierarchy'
book_views_data in modules/book.views.inc
Implementation of hook_views_data()
views_views_handlers in includes/handlers.inc
Implementation of hook_views_handlers() to register all of the basic handlers views uses.

File

handlers/views_handler_sort_menu_hierarchy.inc, line 11

View source
class views_handler_sort_menu_hierarchy extends views_handler_sort {
  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) {
      $this->query->add_orderby($this->table_alias, $this->field . $i, $this->options['order']);
    }
  }
}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
views_handler::accept_exposed_input function Take input from exposed filters and assign to this handler, if necessary.
views_handler::access function Check whether current user has access to this handler.
views_handler::broken function Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found.
views_handler::can_expose function Determine if a handler can be exposed.
views_handler::ensure_my_table function Ensure the main table for this handler is in the query. This is used a lot.
views_handler::exposed_form function Render our chunk of the exposed filter form when selecting
views_handler::exposed_info function Get information about the exposed form for the form renderer.
views_handler::exposed_submit function Submit the exposed filter form
views_handler::exposed_validate function Validate the exposed filter form
views_handler::expose_options function Set new exposed option defaults when exposed setting is flipped on.
views_handler::extra_options function Provide defaults for the handler.
views_handler::extra_options_form function Provide a form for setting options.
views_handler::extra_options_submit 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::extra_options_validate function Validate the options form.
views_handler::get_join function Get the join object that should be used for this handler.
views_handler::has_extra_options function If a handler has 'extra options' it will get a little settings widget and another form called extra_options.
views_handler::init function init the handler with necessary data.
views_handler::is_exposed function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::needs_style_plugin function Determine if the argument needs a style plugin.
views_handler::options_submit 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::options_validate function Validate the options form.
views_handler::pre_query function Run before the view is built.
views_handler::set_relationship function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::store_exposed_input function If set to remember exposed input in the session, store it there.
views_handler::ui_name function Return a string representing this handler's name in the UI.
views_handler::validate function Validates the handler against the complete View.
views_handler_sort::admin_summary function Display whether or not the sort order is ascending or descending Overrides views_handler::admin_summary
views_handler_sort::options_form function Basic options for all sort criteria Overrides views_handler::options_form
views_handler_sort::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_object::option_definition
views_handler_sort_menu_hierarchy::query function Called to add the sort to a query. Overrides views_handler_sort::query
views_object::construct function Views handlers use a special construct function so that we can more easily construct them with variable arguments.
views_object::destroy function
views_object::options function Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.
views_object::set_default_options 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::set_definition function Let the handler know what its full definition is.
views_object::unpack_options function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::_set_option_defaults function