function views_plugin_display_page::execute_hook_menu

Add this display's path information to Drupal's menu system.

File

plugins/views_plugin_display_page.inc, line 66

Class

views_plugin_display_page

The plugin that handles a full page.

Code

public function execute_hook_menu($callbacks) {
    $items = array();
    // Replace % with the link to our standard views argument loader
    // views_arg_load -- which lives in views.module.
    $bits = explode('/', $this->get_option('path'));
    $page_arguments = array(
        $this->view->name,
        $this->display->id,
    );
    $this->view
        ->init_handlers();
    $view_arguments = $this->view->argument;
    // Replace % with %views_arg for menu autoloading and add to the
    // page arguments so the argument actually comes through.
    foreach ($bits as $pos => $bit) {
        if ($bit == '%') {
            $argument = array_shift($view_arguments);
            if (!empty($argument->options['specify_validation']) && $argument->options['validate']['type'] != 'none') {
                $bits[$pos] = '%views_arg';
            }
            $page_arguments[] = $pos;
        }
    }
    $path = implode('/', $bits);
    $access_plugin = $this->get_plugin('access');
    if (!$access_plugin) {
        $access_plugin = views_get_plugin('access', 'none');
    }
    // Get access callback might return an array of the callback + the dynamic
    // arguments.
    $access_plugin_callback = $access_plugin->get_access_callback();
    if (is_array($access_plugin_callback)) {
        $access_arguments = array();
        // Find the plugin arguments.
        $access_plugin_method = array_shift($access_plugin_callback);
        $access_plugin_arguments = array_shift($access_plugin_callback);
        if (!is_array($access_plugin_arguments)) {
            $access_plugin_arguments = array();
        }
        $access_arguments[0] = array(
            $access_plugin_method,
            &$access_plugin_arguments,
        );
        // Move the plugin arguments to the access arguments array.
        $i = 1;
        foreach ($access_plugin_arguments as $key => $value) {
            if (is_int($value)) {
                $access_arguments[$i] = $value;
                $access_plugin_arguments[$key] = $i;
                $i++;
            }
        }
    }
    else {
        $access_arguments = array(
            $access_plugin_callback,
        );
    }
    if ($path) {
        $items[$path] = array(
            // Default views page entry.
'page callback' => 'views_page',
            'page arguments' => $page_arguments,
            // Default access check (per display)
'access callback' => 'views_access',
            'access arguments' => $access_arguments,
            // Identify URL embedded arguments and correlate them to a handler.
'load arguments' => array(
                $this->view->name,
                $this->display->id,
                '%index',
            ),
            // Make sure the menu router knows where views_page is.
'module' => 'views',
        );
        $menu = $this->get_option('menu');
        if (empty($menu)) {
            $menu = array(
                'type' => 'none',
            );
        }
        // Set the title and description if we have one.
        if ($menu['type'] != 'none') {
            $items[$path]['title'] = $menu['title'];
            $items[$path]['description'] = $menu['description'];
        }
        if (isset($menu['weight'])) {
            $items[$path]['weight'] = intval($menu['weight']);
        }
        switch ($menu['type']) {
            case 'none':
            default:
                $items[$path]['type'] = MENU_CALLBACK;
                break;
            case 'normal':
                $items[$path]['type'] = MENU_NORMAL_ITEM;
                // Insert item into the proper menu.
                $items[$path]['menu_name'] = $menu['name'];
                break;
            case 'tab':
                $items[$path]['type'] = MENU_LOCAL_TASK;
                break;
            case 'default tab':
                $items[$path]['type'] = MENU_DEFAULT_LOCAL_TASK;
                break;
            case 'local action':
                $items[$path]['type'] = MENU_LOCAL_ACTION;
                break;
        }
        // Add context for contextual links.
        // @see menu_contextual_links()
        if (!empty($menu['context'])) {
            $items[$path]['context'] = !empty($menu['context_only_inline']) ? MENU_CONTEXT_INLINE : MENU_CONTEXT_PAGE | MENU_CONTEXT_INLINE;
        }
        // If this is a 'default' tab, check to see if we have to create teh
        // parent menu item.
        if ($menu['type'] == 'default tab') {
            $tab_options = $this->get_option('tab_options');
            if (!empty($tab_options['type']) && $tab_options['type'] != 'none') {
                $bits = explode('/', $path);
                // Remove the last piece.
                $bit = array_pop($bits);
                // We can't do this if they tried to make the last path bit variable.
                // @todo We can validate this.
                if ($bit != '%views_arg' && !empty($bits)) {
                    $default_path = implode('/', $bits);
                    $items[$default_path] = array(
                        // Default views page entry.
'page callback' => 'views_page',
                        'page arguments' => $page_arguments,
                        // Default access check (per display)
'access callback' => 'views_access',
                        'access arguments' => $access_arguments,
                        // Identify URL embedded arguments and correlate them to a handler.
'load arguments' => array(
                            $this->view->name,
                            $this->display->id,
                            '%index',
                        ),
                        'title' => $tab_options['title'],
                        'description' => $tab_options['description'],
                        'menu_name' => $tab_options['name'],
                        // Make sure the menu router knows where views_page is.
'module' => 'views',
                    );
                    switch ($tab_options['type']) {
                        default:
                        case 'normal':
                            $items[$default_path]['type'] = MENU_NORMAL_ITEM;
                            break;
                        case 'tab':
                            $items[$default_path]['type'] = MENU_LOCAL_TASK;
                            break;
                    }
                    if (isset($tab_options['weight'])) {
                        $items[$default_path]['weight'] = intval($tab_options['weight']);
                    }
                }
            }
        }
    }
    return $items;
}