' . t('Configuration is being provided by code.') . '
', - ); - return $form; - } - - // Build the standard form. - $form['#attached']['js'][] = drupal_get_path('module', 'menu_block') . '/menu-block.js'; - $form['#attached']['css'][] = drupal_get_path('module', 'menu_block') . '/menu-block.admin.css'; - $form['#attached']['library'][] = array('system', 'ui.button'); - - $form['menu-block-wrapper-start'] = array( - '#markup' => ''); - - // Set visibility of advanced options. - foreach (array('title_link', 'follow', 'follow_parent', 'expanded', 'sort', 'parent') as $key) { - $form[$key]['#states']['visible'][':input[name=display_options]'] = array('value' => 'advanced'); - } - if ($config['title_link'] || $follow || $config['expanded'] || $config['sort'] || $config['parent_mlid']) { - $form['display_options']['#default_value'] = 'advanced'; - } + menu_block_export_ui_form($form, $form_state); return $form; } /** - * Validates the parent element of the block configuration form. - */ -function menu_block_configure_form_parent_validate($element, &$form_state) { - // Determine the fixed parent item's menu and mlid. - list($menu_name, $parent_mlid) = explode(':', $form_state['values']['parent']); - $form_state['values']['parent_mlid'] = (int) $parent_mlid; - - if ($parent_mlid) { - // If mlid is set, its menu overrides the menu_name option. - $form_state['values']['menu_name'] = $menu_name; - } -} - -/** - * Validates the follow element of the block configuration form. - */ -function menu_block_configure_form_follow_validate($element, &$form_state) { - // The value of "follow" stored in the database/config array is either FALSE - // or the value of the "follow_parent" form element. - if ($form_state['values']['follow'] && !empty($form_state['values']['follow_parent'])) { - $form_state['values']['follow'] = $form_state['values']['follow_parent']; - } -} - -/** * Implements hook_block_save(). */ function _menu_block_block_save($delta = '', $edit = array()) { if (!empty($delta)) { - // Don't save values for an exported block. - $config = menu_block_get_config($delta); - if (empty($config['exported_to_code'])) { - variable_set("menu_block_{$delta}_title_link", $edit['title_link']); - variable_set("menu_block_{$delta}_admin_title", $edit['admin_title']); - variable_set("menu_block_{$delta}_parent", $edit['parent']); - variable_set("menu_block_{$delta}_level", $edit['level']); - variable_set("menu_block_{$delta}_follow", $edit['follow']); - variable_set("menu_block_{$delta}_depth", $edit['depth']); - variable_set("menu_block_{$delta}_expanded", $edit['expanded']); - variable_set("menu_block_{$delta}_sort", $edit['sort']); + ctools_include('export'); + $menu_block = ctools_export_crud_load('menu_blocks', $delta); + foreach (array_keys((array) $menu_block) as $key) { + if (isset($edit[$key])) { + $menu_block->{$key} = $edit[$key]; + } } + ctools_export_crud_save('menu_blocks', $menu_block); } } diff --git a/menu_block.info b/menu_block.info index a237932..e791662 100644 --- a/menu_block.info +++ b/menu_block.info @@ -2,6 +2,7 @@ name = "Menu Block" description = "Provides configurable blocks of menu items." core = 7.x +dependencies[] = ctools dependencies[] = menu (>7.11) configure = admin/config/user-interface/menu-block diff --git a/menu_block.install b/menu_block.install index 3dfcf2f..2082194 100644 --- a/menu_block.install +++ b/menu_block.install @@ -4,19 +4,97 @@ * Provides install, upgrade and un-install functions for menu_block. */ + /** + * Implements hook_schema(). + */ +function menu_block_schema() { + $schema['menu_blocks'] = array( + 'export' => array( + 'key' => 'name', + 'key name' => 'Name', + 'admin_title' => 'label', + 'primary key' => 'name', + 'identifier' => 'menu_block', + 'default hook' => 'menu_block_defaults', + 'api' => array( + 'owner' => 'menu_block', + 'api' => 'menu_block', + 'minimum_version' => 1, + 'current_version' => 1, + ), + ), + 'fields' => array( + 'name' => array( + 'type' => 'varchar', + 'length' => 64, + 'not null' => TRUE, + 'default' => '', + ), + 'label' => array( + 'type' => 'varchar', + 'length' => 64, + 'not null' => TRUE, + 'default' => '', + ), + 'description' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => FALSE, + 'default' => '', + ), + 'depth' => array( + 'type' => 'int', + 'not null' => TRUE, + 'size' => 'small', + 'default' => 0, + ), + 'expanded' => array( + 'type' => 'int', + 'not null' => TRUE, + 'size' => 'small', + 'default' => 0, + ), + 'follow' => array( + 'type' => 'varchar', + 'length' => 16, + 'default' => '', + ), + 'level' => array( + 'type' => 'int', + 'not null' => TRUE, + 'size' => 'small', + 'default' => 1, + ), + 'parent' => array( + 'type' => 'varchar', + 'length' => 64, + 'default' => '', + ), + 'sort' => array( + 'type' => 'int', + 'not null' => TRUE, + 'size' => 'small', + 'default' => 0, + ), + 'title_link' => array( + 'type' => 'int', + 'not null' => TRUE, + 'size' => 'small', + 'default' => 0, + ), + ), + 'primary key' => array('name'), + ); + + return $schema; +} + + /** * Implements hook_uninstall(). */ function menu_block_uninstall() { // Delete menu block variables. - drupal_load('module', 'menu_block'); - $variable_keys = array_keys(menu_block_default_config()); - foreach (variable_get('menu_block_ids', array()) as $delta) { - foreach ($variable_keys as $key) { - variable_del("menu_block_{$delta}_{$key}"); - } - } - variable_del('menu_block_ids'); variable_del('menu_block_suppress_core'); variable_del('menu_block_menu_order'); @@ -194,3 +272,115 @@ function menu_block_update_7202() { function menu_block_update_7203() { // Nothing needed here. } + + +/** + * Add database table, migrate variables into database and enable CTools if + * availble. + */ +function menu_block_update_7204() { + // Add database table. + $schema['menu_blocks'] = array( + 'fields' => array( + 'name' => array( + 'type' => 'varchar', + 'length' => 64, + 'not null' => TRUE, + 'default' => '', + ), + 'label' => array( + 'type' => 'varchar', + 'length' => 64, + 'not null' => TRUE, + 'default' => '', + ), + 'description' => array( + 'type' => 'varchar', + 'length' => 255, + 'not null' => FALSE, + 'default' => '', + ), + 'depth' => array( + 'type' => 'int', + 'not null' => TRUE, + 'size' => 'small', + 'default' => 0, + ), + 'expanded' => array( + 'type' => 'int', + 'not null' => TRUE, + 'size' => 'small', + 'default' => 0, + ), + 'follow' => array( + 'type' => 'varchar', + 'length' => 16, + 'default' => '', + ), + 'level' => array( + 'type' => 'int', + 'not null' => TRUE, + 'size' => 'small', + 'default' => 1, + ), + 'parent' => array( + 'type' => 'varchar', + 'length' => 64, + 'default' => '', + ), + 'sort' => array( + 'type' => 'int', + 'not null' => TRUE, + 'size' => 'small', + 'default' => 0, + ), + 'title_link' => array( + 'type' => 'int', + 'not null' => TRUE, + 'size' => 'small', + 'default' => 0, + ), + ), + 'primary key' => array('name'), + ); + db_create_table('menu_blocks', $schema['menu_blocks']); + // Migrate variables into database. + foreach (variable_get('menu_block_ids', array()) AS $delta) { + $config = menu_block_get_config($delta); + db_insert('menu_blocks') + ->fields(array( + 'name' => $delta, + 'label' => $config['admin_title'], + 'description' => NULL, + 'depth' => $config['depth'], + 'expanded' => $config['expanded'], + 'follow' => $config['active'], + 'level' => $config['level'], + 'parent' => "{$config['menu_name']}:{$config['parent_mlid']}", + 'sort' => $config['sort'], + 'title_link' => $config['title_link'], + )) + ->execute(); + + // Delete old variables. + variable_del("menu_block_{$delta}_title_link"); + variable_del("menu_block_{$delta}_admin_title"); + variable_del("menu_block_{$delta}_parent"); + variable_del("menu_block_{$delta}_level"); + variable_del("menu_block_{$delta}_follow"); + variable_del("menu_block_{$delta}_depth"); + variable_del("menu_block_{$delta}_expanded"); + variable_del("menu_block_{$delta}_sort"); + } + variable_del('menu_block_ids'); + + // Enable CTools if availble. + if (!module_exists('ctools')) { + module_enable(array('ctools')); + if (!module_exists('ctools')) { + drupal_set_message(t('The Chaos tool suite (ctools) module is required for Menu Block. Menu Block has been disabled.')); + module_disable(array('menu_block')); + } + } + drupal_flush_all_caches(); +} diff --git a/menu_block.module b/menu_block.module index 8611fbf..c841c9a 100644 --- a/menu_block.module +++ b/menu_block.module @@ -31,13 +31,12 @@ function menu_block_form_block_admin_display_form_alter(&$form, $form_state) { * Implements hook_menu(). */ function menu_block_menu() { - // @todo Remove this check if block module is re-added as a dependency. if (module_exists('block')) { $items['admin/structure/block/add-menu-block'] = array( 'title' => 'Add menu block', 'description' => 'Add a new menu block.', - 'page callback' => 'drupal_get_form', - 'page arguments' => array('menu_block_add_block_form'), + 'page callback' => 'drupal_goto', + 'page arguments' => array('admin/structure/menu_block/add'), 'access callback' => 'menu_block_access', 'type' => MENU_LOCAL_ACTION, 'file' => 'menu_block.admin.inc', @@ -48,31 +47,23 @@ function menu_block_menu() { $items['admin/structure/block/list/' . $key . '/add-menu-block'] = array( 'title' => 'Add menu block', 'description' => 'Add a new menu block.', - 'page callback' => 'drupal_get_form', - 'page arguments' => array('menu_block_add_block_form'), + 'page callback' => 'drupal_goto', + 'page arguments' => array('admin/structure/menu_block/add'), 'access callback' => 'menu_block_access', 'type' => MENU_LOCAL_ACTION, 'file' => 'menu_block.admin.inc', ); } } - $items['admin/structure/block/delete-menu-block'] = array( - 'title' => 'Delete menu block', - 'page callback' => 'drupal_get_form', - 'page arguments' => array('menu_block_delete_form'), - 'access callback' => 'menu_block_access', - 'type' => MENU_CALLBACK, - 'file' => 'menu_block.admin.inc', - ); } - $items['admin/config/user-interface/menu-block'] = array( - 'title' => 'Menu block', + $items['admin/structure/menu_block/settings'] = array( + 'title' => 'Settings', 'description' => 'Configure menu block.', 'page callback' => 'drupal_get_form', 'page arguments' => array('menu_block_admin_settings_form'), 'access callback' => 'menu_block_access', - 'type' => MENU_NORMAL_ITEM, + 'type' => MENU_LOCAL_TASK, 'file' => 'menu_block.admin.inc', ); return $items; @@ -100,7 +91,7 @@ function menu_block_menu_alter(&$items) { * Implements hook_ctools_plugin_directory(). */ function menu_block_ctools_plugin_directory($module, $plugin) { - if ($plugin == 'content_types') { + if ($module == 'ctools' && !empty($plugin)) { return 'plugins/' . $plugin; } } @@ -160,8 +151,52 @@ function menu_block_help($path, $arg) { * Implements hook_block_view(). */ function menu_block_block_view($delta = '') { - $config = menu_block_get_config($delta); - return menu_tree_build($config); + $config = menu_block_config_load($delta); + if ($config) { + $data = menu_tree_build($config); + // Add contextual links for this block. + if (!empty($data['content'])) { + if (in_array($config['menu_name'], array_keys(menu_get_menus()))) { + $data['content']['#contextual_links']['menu_block'] = array('admin/structure/menu/manage', array($config['menu_name'])); + } + elseif (strpos($config['menu_name'], 'book-toc-') === 0) { + $node = str_replace('book-toc-', '', $config['menu_name']); + $data['content']['#contextual_links']['menu_block'] = array('admin/content/book', array($node)); + } + } + return $data; + } + return FALSE; +} + +/** + * CRUD function; Load all menu blocks. + */ +function menu_block_load_all($disabled = FALSE) { + $menu_blocks = array(); + + ctools_include('export'); + foreach (ctools_export_crud_load_all('menu_blocks') as $menu_block) { + if (empty($menu_block->disabled) || TRUE == $disabled) { + $menu_blocks[$menu_block->name] = $menu_block; + } + } + return $menu_blocks; +} + +/** + * Load the menu block configuration. + */ +function menu_block_config_load($delta) { + ctools_include('export'); + $config = ctools_export_crud_load('menu_blocks', $delta); + if ($config) { + $config->admin_title = $config->name; + $config->delta = $delta; + list($config->menu_name, $config->parent_mlid) = explode(':', $config->parent, 2); + return (array) $config; + } + return FALSE; } /** @@ -281,6 +316,7 @@ function menu_block_get_exported_blocks() { */ function menu_block_get_config($delta = NULL) { static $defaults, $exported; + watchdog('menu_block', 'menu_block_get_config() is deprecated and will be removed in the future'); if (!isset($defaults)) { $defaults = menu_block_default_config(); @@ -322,7 +358,7 @@ function menu_block_get_config($delta = NULL) { // Split out the 'parent' item into 'menu_name' and 'parent_mlid'. if (!isset($config['menu_name']) && !isset($config['parent_mlid'])) { - list($config['menu_name'], $config['parent_mlid']) = explode(':', $config['parent']); + list($config['menu_name'], $config['parent_mlid']) = explode(':', $config['parent'], 2); } $config['delta'] = $delta; @@ -371,7 +407,7 @@ function menu_tree_block_data(array &$config) { // Prune the tree along the active trail to the specified level. if ($config['level'] > 1 || $config['parent_mlid']) { if ($config['parent_mlid']) { - $parent_item = menu_link_load($config['parent_mlid']); + $parent_item = menu_block_menu_link_load($config['menu_name'].":".$config['parent_mlid']); if (!$parent_item) { watchdog('menu_block', "Menu block @delta is set to use parent menu link @plid but the menu link was not loadable or does not exist.", array( '@delta' => $config['delta'], @@ -410,6 +446,26 @@ function menu_tree_block_data(array &$config) { } /** + * Load a menu link by its menu_name:link_path identifier. + */ +function menu_block_menu_link_load($identifier) { + //dpm(debug_backtrace()); + list($menu_name, $link_path) = explode(':', $identifier, 2); + $link = db_select('menu_links') + ->fields('menu_links', array('mlid')) + ->condition('menu_name', $menu_name) + ->condition('link_path', $link_path) + ->addTag('features_menu_link') + ->execute() + ->fetchAssoc(); + if ($link) { + //$link['options'] = unserialize($link['options']); + return menu_link_load($link['mlid']); + } + return FALSE; +} + +/** * Returns the current page's menu. * * @return string|bool @@ -950,36 +1006,6 @@ function menu_block_menu_delete($menu) { menu_block_menu_order_set_menu($menu['menu_name'], FALSE); } -/** - * Delete a menu block. - * - * @param string $delta - * The delta of the menu block. - */ -function menu_block_delete($delta) { - // Since this used to be a form callback, prevent unintentional uses. - if (is_array($delta)) { - variable_set('menu_rebuild_needed', TRUE); - return; - } - - $block_ids = variable_get('menu_block_ids', array()); - $index = array_search($delta, $block_ids); - if ($index !== FALSE && $config = menu_block_get_config($delta)) { - module_invoke_all('menu_block_delete', $config); - - // Remove the delta from the list of custom IDs. - unset($block_ids[$index]); - sort($block_ids); - variable_set('menu_block_ids', $block_ids); - - // Remove all the individual variables. - $variable_keys = array_keys(menu_block_default_config()); - foreach ($variable_keys as $key) { - variable_del("menu_block_{$delta}_{$key}"); - } - } -} /** * Implements hook_menu_block_delete() on behalf of block.module. diff --git a/plugins/content_types/menu_tree/menu_tree.inc b/plugins/content_types/menu_tree/menu_tree.inc index e57eded..f15dbaa 100644 --- a/plugins/content_types/menu_tree/menu_tree.inc +++ b/plugins/content_types/menu_tree/menu_tree.inc @@ -18,7 +18,7 @@ $plugin = array( ); // Load the standard config form. -module_load_include('inc', 'menu_block', 'menu_block.admin'); +module_load_include('inc', 'menu_block', 'plugins/export_ui/menu_block'); /** * Supplies a list of menu tree content sub-types. @@ -107,21 +107,21 @@ function menu_block_menu_tree_content_type_edit_form($form, &$form_state) { $conf = $form_state['conf']; // Create a pseudo form state. - $sub_form_state = array('values' => $conf); - $form += menu_block_configure_form($form, $sub_form_state); + $sub_form_state = array('item' => (object)$conf); + menu_block_export_ui_form($form, $sub_form_state); // Hide the menu selector. $form['menu_name']['#type'] = 'hidden'; // Set the options to a simple list of menu links for the configured menu. $menus = menu_block_get_all_menus(); - $form['parent']['#options'] = menu_parent_options(array($conf['menu_name'] => $menus[$conf['menu_name']]), array('mlid' => 0)); + $form['parent_mlid']['#options'] = menu_parent_options(array($conf['menu_name'] => $menus[$conf['menu_name']]), array('mlid' => 0)); // Hide the Parent item option for the special "active" menu. if ($conf['menu_name'] == MENU_TREE__CURRENT_PAGE_MENU) { - $form['parent']['#type'] = 'hidden'; + $form['parent_mlid']['#type'] = 'hidden'; } // Remove CSS class hooks for jQuery script on parent select. - unset($form['parent']['#attributes']); + unset($form['parent_mlid']['#attributes']); return $form; } @@ -134,7 +134,7 @@ function menu_block_menu_tree_content_type_edit_form_submit(&$form, &$form_state $form_state['conf'][$key] = $form_state['values'][$key]; } if (!empty($form_state['values']['parent'])) { - list($form_state['conf']['menu_name'], $form_state['conf']['parent_mlid']) = explode(':', $form_state['values']['parent']); + list($form_state['conf']['menu_name'], $form_state['conf']['parent_mlid']) = explode(':', $form_state['values']['parent'], 2); } } @@ -147,7 +147,8 @@ function menu_block_menu_tree_content_type_admin_title($subtype, $conf, $context } else { // Build the menu tree. - $output = _menu_block_format_title($conf); + $menus = menu_block_get_all_menus(); + $output = t('Menu tree') . ': ' . $menus[$conf['menu_name']]; } return $output; } diff --git a/plugins/export_ui/menu_block.inc b/plugins/export_ui/menu_block.inc new file mode 100644 index 0000000..3573937 --- /dev/null +++ b/plugins/export_ui/menu_block.inc @@ -0,0 +1,232 @@ + 'menu_blocks', + + 'menu' => array( + 'menu prefix' => 'admin/structure', + 'menu item' => 'menu_block', + 'menu title' => 'Menu Blocks', + 'menu description' => 'Administer Menu Blocks.', + ), + + 'title singular' => t('menu block'), + 'title singular proper' => t('Menu Block'), + 'title plural' => t('menu blocks'), + 'title plural proper' => t('Menu Blocks'), + + 'handler' => 'menu_block_ui', + + 'form' => array( + 'settings' => 'menu_block_export_ui_form', + ), + + 'export' => array( + 'admin_title' => 'label', + 'admin_description' => 'description', + ), + ); +} + +/** + * Menu Block settings form. + */ +function menu_block_export_ui_form(&$form, &$form_state) { + list($form_state['item']->menu_name, $form_state['item']->parent_mlid) = explode(':', !empty($form_state['item']->parent) ? $form_state['item']->parent : 'main-menu:0'); + + $form['#attached']['js'][] = drupal_get_path('module', 'menu_block') . '/menu-block.js'; + $form['#attached']['css'][] = drupal_get_path('module', 'menu_block') . '/menu-block.admin.css'; + $form['#attached']['library'][] = array('system', 'ui.button'); + + $form['menu-block-wrapper-start'] = array( + '#markup' => ''); + + // Set visibility of advanced options. + foreach (array('title_link', 'follow', 'follow_parent', 'expanded', 'sort', 'parent_mlid') as $key) { + $form[$key]['#states']['visible'][':input[name=display_options]'] = array('value' => 'advanced'); + if (!empty($form_state['item']->{$key})) { + $form['display_options']['#default_value'] = 'advanced'; + } + } +} + +/** + * Validates the parent element of the block configuration form. + */ +function menu_block_configure_form_parent_validate($element, &$form_state) { + // Determine the fixed parent item's menu and mlid. + list($menu_name, $parent_mlid) = explode(':', $form_state['values']['parent_mlid'], 2); + if ($parent_mlid) { + // If mlid is set, its menu overrides the menu_name option. + $form_state['values']['menu_name'] = $menu_name; + } + else { + // Otherwise the menu_name overrides the parent item option. + $form_state['values']['parent_mlid'] = $menu_name . ':0'; + } + // The value of "parent" stored in the database/config array is the menu name + // combined with the optional parent menu item's mlid. + $form_state['values']['parent'] = $form_state['values']['parent_mlid']; +} + +/** + * Validates the follow element of the block configuration form. + */ +function menu_block_configure_form_follow_validate($element, &$form_state) { + // The value of "follow" stored in the database/config array is either FALSE + // or the value of the "follow_parent" form element. + if ($form_state['values']['follow'] && !empty($form_state['values']['follow_parent'])) { + $form_state['values']['follow'] = $form_state['values']['follow_parent']; + } +} \ No newline at end of file diff --git a/plugins/export_ui/menu_block_ui.class.php b/plugins/export_ui/menu_block_ui.class.php new file mode 100644 index 0000000..df11f6c --- /dev/null +++ b/plugins/export_ui/menu_block_ui.class.php @@ -0,0 +1,27 @@ +condition('module', 'menu_block') + ->condition('delta', $item->name) + ->execute(); + } + + ctools_export_crud_delete($this->plugin['schema'], $item); + $export_key = $this->plugin['export']['key']; + $message = str_replace('%title', check_plain($item->{$export_key}), $this->plugin['strings']['confirmation'][$form_state['op']]['success']); + drupal_set_message($message); + } +}