You are here

class views_menu_children_argument in Views Menu Node Children Filter 7

Hierarchy

Expanded class hierarchy of views_menu_children_argument

1 string reference to 'views_menu_children_argument'
views_menu_children_filter_views_data_alter in ./views_menu_children_filter.views.inc
Implements hook_views_data_alter().

File

includes/views_menu_children_argument.inc, line 3

View source
class views_menu_children_argument extends views_handler_argument_numeric {

  /**
   * The operator used for the query: or|and.
   * @var string
   */
  var $operator;

  /**
   * The actual value which is used for querying.
   * @var array
   */
  var $value;
  function option_definition() {
    $options = parent::option_definition();
    $options['target_menu'] = array(
      'default' => '',
    );
    $options['filter_disabled_items'] = array(
      'default' => '0',
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['default_action']["#options"]['root_nodes'] = t('Display root nodes only.');
    unset($form['not']);
    unset($form['break_phrase']);

    // Add the target menu config element.
    self::buildMenuSelectForm($form, $form_state, $this->options['target_menu']);

    // Add the checkbox to conditionally honor the menu item enabled state.
    $form['filter_disabled_items'] = array(
      '#type' => 'checkbox',
      '#title' => t('Hide nodes whose menu link is disabled?'),
      '#return_value' => "1",
      '#default_value' => !empty($this->options['filter_disabled_items']),
    );
  }
  public static function buildMenuSelectForm(&$form, &$form_state, $default_menu) {
    foreach (menu_load_all() as $menu) {
      $menus[$menu['menu_name']] = $menu['title'];
    }
    asort($menus);
    $form['target_menu'] = array(
      '#type' => 'select',
      '#title' => t('Target menu'),
      '#description' => t('Select the menu to scan for child nodes.'),
      '#default_value' => $default_menu,
      '#required' => TRUE,
      '#options' => array_merge(array(
        '' => t('-- Select menu --'),
      ), $menus),
    );
  }
  function title() {
    return parent::title();
  }

  /**
   * Override for specific title lookups.
   * @return array
   *    Returns all titles, if it's just one title it's an array with one entry.
   */
  function title_query() {
    return $this->value;
  }
  function query($group_by = FALSE) {
    $this
      ->ensure_my_table();
    $menu_name = $this->options['target_menu'];

    // The magic sauce! Joining the menu_links table onto the node table ;)
    self::joinMenuLinksTableToNode($this->query, $menu_name);
    if (!empty($this->options['break_phrase'])) {
      views_break_phrase($this->argument, $this);
    }
    else {
      $this->value = array(
        $this->argument,
      );
    }
    $page_identifier = reset($this->value);

    // If the value is an integer, we assume it is a node ID.
    if (is_numeric($page_identifier) && $page_identifier != "0") {
      $page_identifier = "node/{$page_identifier}";
    }
    self::filterByParentPage($page_identifier, $menu_name, $this->query);
    $this
      ->filterDisabledNodesLinks($this->query);
  }
  public function filterDisabledNodesLinks(\views_plugin_query $query) {
    if (!empty($this->options['filter_disabled_items'])) {
      $query
        ->add_where_expression(0, 'menu_links.hidden <> 1', array());
    }
  }

  /**
   * Filter the query by either a: parent node, page page via its link_path, or null and limit to root nodes.
   *
   * @param null|string|integer $page_identifier The menu_item table's link_path. I.e.: node/100 (Supports an integer to default to node/%)
   * @param string $menu_name The menu's machine name we want to filter by.
   * @param \views_plugin_query $query The query we're going to alter.
   */
  public static function filterByParentPage($page_identifier, $menu_name, \views_plugin_query $query) {

    // If not page identifier is provided, select only root nodes of the menu.
    if (empty($page_identifier)) {
      $parent['mlid'] = 0;
    }
    else {

      // Convert potential aliases to the system path.
      $page_identifier = drupal_get_normal_path($page_identifier);

      // Get the parent page menu item details.
      $parent = menu_link_get_preferred($page_identifier, $menu_name);

      // When a link was not found for the $page_identifier,
      // return zero results.
      if ($parent === FALSE) {
        $parent['mlid'] = -1;
      }
    }
    $query
      ->add_where_expression(0, 'menu_links.plid = :parent_lid', array(
      ':parent_lid' => $parent['mlid'],
    ));
  }

  /**
   * @param \views_plugin_query $query
   * @param string $menu_name The menu's machine name we want to filter by.
   * @param bool $allow_duplicate_join If "false", prevents this join from joining more than once if this function is called repeatedly.
   */
  public static function joinMenuLinksTableToNode(\views_plugin_query $query, $menu_name, $allow_duplicate_join = false) {

    // Because this can be called from the argument and sort handlers,
    // first check to see if the join as already been applied.
    if (!$allow_duplicate_join && isset($query->tables['node']['menu_links'])) {
      return;
    }

    // We need to join on the menu_links table.
    // Use our special views_join object to accomplish this.
    $join = new views_menu_children_join();
    $join->prefixes[] = 'node/';
    drupal_alter('views_menu_children_filter_join', $join->prefixes, $menu_name, $query);
    $query
      ->queue_table("menu_links", "node", $join);
    $query
      ->add_where_expression(0, "menu_links.menu_name = :targetmenu", array(
      ':targetmenu' => $menu_name,
    ));
  }

  /**
   * Determine if the argument is set to provide a default argument.
   */
  function has_default_argument() {
    return $this->options['default_action'] == 'root_nodes' ? true : parent::has_default_argument();
  }

  /**
   * Overrides the views_handler_argument_numeric::get_default_argument().
   *
   * If the default action is root_nodes defined here, returns the appropriate
   * value.
   */
  function get_default_argument() {
    if ($this->options['default_action'] == 'root_nodes') {
      return '0';
    }
    return parent::get_default_argument();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
views_handler::$handler_type public property The type of the handler, for example filter/footer/field.
views_handler::$query public property Where the $query object will reside:. 1
views_handler::$real_field public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
views_handler::$relationship public property The relationship used for this field.
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
views_handler::$view public property The top object of a view. Overrides views_object::$view
views_handler::accept_exposed_input public function Take input from exposed handlers and assign to this handler, if necessary. 1
views_handler::access public function Check whether current user has access to this handler. 10
views_handler::admin_summary public function Provide text for the administrative summary. 4
views_handler::broken public function Determine if the handler is considered 'broken'. 6
views_handler::can_expose public function Determine if a handler can be exposed. 2
views_handler::case_transform public function Transform a string by a certain method.
views_handler::ensure_my_table public function Ensure the main table for this handler is in the query. This is used a lot. 8
views_handler::exposed_form public function Render our chunk of the exposed handler form when selecting. 1
views_handler::exposed_info public function Get information about the exposed form for the form renderer. 1
views_handler::exposed_submit public function Submit the exposed handler form.
views_handler::exposed_validate public function Validate the exposed handler form. 4
views_handler::expose_form public function Form for exposed handler options. 2
views_handler::expose_options public function Set new exposed option defaults when exposed setting is flipped on. 2
views_handler::expose_submit 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::expose_validate public function Validate the options form. 1
views_handler::extra_options public function Provide defaults for the handler.
views_handler::extra_options_form public function Provide a form for setting options. 1
views_handler::extra_options_submit 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::extra_options_validate public function Validate the options form.
views_handler::get_field public function Shortcut to get a handler's raw field value.
views_handler::get_join public function Get the join object that should be used for this handler.
views_handler::groupby_form public function Provide a form for aggregation settings. 1
views_handler::groupby_form_submit 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::has_extra_options public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
views_handler::is_a_group public function Returns TRUE if the exposed filter works like a grouped filter. 1
views_handler::is_exposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::multiple_exposed_input 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::placeholder public function Provides a unique placeholders for handlers.
views_handler::post_execute public function Run after the view is executed, before the result is cached. 1
views_handler::pre_query public function Run before the view is built. 1
views_handler::sanitize_value public function Sanitize the value for output.
views_handler::set_relationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_button public function Shortcut to display the expose/hide button. 2
views_handler::show_expose_form public function Shortcut to display the exposed options form.
views_handler::store_exposed_input public function If set to remember exposed input in the session, store it there. 1
views_handler::ui_name public function Return a string representing this handler's name in the UI. 9
views_handler::use_group_by public function Provides the handler some groupby. 2
views_handler::validate public function Validates the handler against the complete View. 1
views_handler_argument::$argument public property
views_handler_argument::$name_field public property The field to use for the name to use in the summary.
views_handler_argument::$name_table public property The table to use for the name, if not the same table as the argument.
views_handler_argument::$validator public property
views_handler_argument::construct public function Views handlers use a special construct function. Overrides views_object::construct 5
views_handler_argument::default_access_denied public function Default action: access denied.
views_handler_argument::default_action public function Handle the default action, which means our argument wasn't present.
views_handler_argument::default_actions public function List of default behaviors for this argument if the argument is not present. 4
views_handler_argument::default_argument_form public function Provide a form for selecting the default argument. 1
views_handler_argument::default_default public function This just returns true.
views_handler_argument::default_empty public function Default action: empty.
views_handler_argument::default_ignore public function Default action: ignore.
views_handler_argument::default_not_found public function Default action: not found.
views_handler_argument::default_summary public function Default action: summary.
views_handler_argument::default_summary_form public function Form for selecting further summary options.
views_handler_argument::exception_title public function Work out which title to use.
views_handler_argument::export_plugin public function Generic plugin export handler. 1
views_handler_argument::export_summary public function Export handler for summary export.
views_handler_argument::export_validation public function Export handler for validation export.
views_handler_argument::get_plugin public function Get the display or row plugin, if it exists.
views_handler_argument::get_title public function Called by the view object to get the title.
views_handler_argument::get_value public function Get the value of this argument.
views_handler_argument::init public function Init the handler with necessary data. Overrides views_handler::init 3
views_handler_argument::is_exception public function
views_handler_argument::needs_style_plugin public function Determine if the argument needs a style plugin. Overrides views_handler::needs_style_plugin
views_handler_argument::options_submit 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. Overrides views_handler::options_submit
views_handler_argument::options_validate public function Validate the options form. Overrides views_handler::options_validate
views_handler_argument::process_summary_arguments public function Process the summary arguments for display.
views_handler_argument::set_argument public function Set the input for this argument.
views_handler_argument::set_breadcrumb public function Give an argument the opportunity to modify the breadcrumb, if it wants. 3
views_handler_argument::summary_argument public function Provide the argument to use to link from the summary to the next level. 4
views_handler_argument::summary_basics public function Some basic summary behavior.
views_handler_argument::summary_name public function Provides the name to use for the summary. 10
views_handler_argument::summary_name_field public function Add the name field, which is the field displayed in summary queries.
views_handler_argument::summary_query public function Build the info for the summary query. 3
views_handler_argument::summary_sort public function Sorts the summary based upon the user's selection.
views_handler_argument::uses_breadcrumb public function Determine if the argument can generate a breadcrumb.
views_handler_argument::validate_arg public function Validate that this argument works. By default, all arguments are valid.
views_handler_argument::validate_argument public function Called by the menu system to validate an argument.
views_handler_argument::validate_argument_basic public function Provide a basic argument validation. 1
views_handler_argument::validate_fail public function How to act if validation fails.
views_handler_argument_numeric::get_sort_name public function Return a description of how the argument would normally be sorted. Overrides views_handler_argument::get_sort_name
views_menu_children_argument::$operator property The operator used for the query: or|and. Overrides views_handler_argument_numeric::$operator
views_menu_children_argument::$value property The actual value which is used for querying. Overrides views_handler_argument_numeric::$value
views_menu_children_argument::buildMenuSelectForm public static function
views_menu_children_argument::filterByParentPage public static function Filter the query by either a: parent node, page page via its link_path, or null and limit to root nodes.
views_menu_children_argument::filterDisabledNodesLinks public function
views_menu_children_argument::get_default_argument function Overrides the views_handler_argument_numeric::get_default_argument(). Overrides views_handler_argument::get_default_argument
views_menu_children_argument::has_default_argument function Determine if the argument is set to provide a default argument. Overrides views_handler_argument::has_default_argument
views_menu_children_argument::joinMenuLinksTableToNode public static function
views_menu_children_argument::options_form function Build the options form. Overrides views_handler_argument_numeric::options_form
views_menu_children_argument::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler_argument_numeric::option_definition
views_menu_children_argument::query function Set up the query for this argument. Overrides views_handler_argument_numeric::query
views_menu_children_argument::title function Get the title this argument will assign the view, given the argument. Overrides views_handler_argument_numeric::title
views_menu_children_argument::title_query function Override for specific title lookups. Overrides views_handler_argument_numeric::title_query
views_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition function Collect this handler's option definition and alter them, ready for use.
views_object::destroy public function Destructor. 2
views_object::export_option public function 1
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function