'
@@ -1460,7 +1448,7 @@ function sitedoc_node_summary($comment=F
t('Length (KB)'),
);
$output .= ''. t('The sitedoc module allows a site admin to gather extensive information about their site. It may be printed or archived for configuration/change management purposes. It may also be used to add “fancy” and up-to-date information to other site documentation, such as a succession plan') .'
'; - return $output ."\n"; + $output = ''. t('The sitedoc module allows a site admin to gather extensive information about their site. It may be printed or archived for configuration/change management purposes. It may also be used to add "fancy" and up-to-date information to other site documentation, such as a succession plan') .'
'; + return $output; } } @@ -21,21 +20,10 @@ function sitedoc_perm() { } /** - * Implementation of hook_access(). - */ -function sitedoc_access($op, $node) { - global $user; - - if ($op == 'view') { return user_access('view site documentation'); } - else { return FALSE; } -} - -/** * Implementation of hook_menu(). - * add a menu item to the Administer >> Site configuration menu for displaying the sitedoc */ function sitedoc_menu($may_cache) { - $items = array(); + $items = array(); if ($may_cache) { drupal_add_css(drupal_get_path('module', 'sitedoc') .'/sitedoc.css'); @@ -45,7 +33,7 @@ function sitedoc_menu($may_cache) { 'description' => t('Show site documentation'), 'callback' => 'sitedoc_list', 'access' => user_access('view site documentation'), - ); + ); $items[] = array( 'path' => 'admin/settings/sitedoc', 'title' => t('Site documentation settings'), @@ -53,8 +41,8 @@ function sitedoc_menu($may_cache) { 'callback' => 'drupal_get_form', 'callback arguments' => array('sitedoc_settings_form'), 'access' => user_access('view site documentation'), - ); - } + ); + } else { $items[] = array( 'path' => 'admin/build/sitedoc_node_access_view', @@ -64,54 +52,56 @@ function sitedoc_menu($may_cache) { 'callback arguments' => array(arg(3)), 'access' => user_access('view site documentation'), 'type' => MENU_CALLBACK, - ); - } + ); + } + return $items; } -/***************************/ -/** settings function **/ -/***************************/ +/** + * Settings function. + */ function sitedoc_settings_form() { drupal_add_css(drupal_get_path('module', 'sitedoc') .'/sitedoc.css'); $_default_settings = array( - 'drupal_section' => TRUE, - 'kill_cron' => 0, /* kill long-running cron */ - 'table_section' => TRUE, - 'optimize_tables' => FALSE, /* use OPTIMIZE to release overhead */ - 'sequences_section' => FALSE, /* not on because not much interest */ - 'node_section' => FALSE, /* not on because of expense */ - 'include_comment_count' => FALSE, /* comment count on nodes */ - 'include_node_access' => FALSE, /* node access summary */ - 'node_show_size' => 99999, /* show nodes exceeding x KB */ - 'node_max_size' => 50, /* warn if nodes exceeding x KB */ - 'module_section' => TRUE, - 'module_suppress' => FALSE, /* exclude disabled modules */ - 'content_section' => TRUE, - 'vocabulary_section' => TRUE, - 'orphan_term_node' => FALSE, /* not on to allow control */ - 'delete_orphan_term_nodes' => FALSE, /* do not delete orphans */ - 'theme_section' => TRUE, - 'variables_section' => FALSE, /* not on because of expense */ - 'block_section' => TRUE, - 'block_warn' => TRUE, /* warn on missing theme */ - 'block_delete' => FALSE, /* delete those orphan blocks */ - 'roles_section' => TRUE, - 'role_users' => TRUE, /* list users in roles */ - 'role_perms_list' => FALSE, /* do role permissions as stream */ - 'contacts_section' => TRUE, - 'profile_fields_section' => FALSE, /* not on because of interest */ - 'url_alias_section' => FALSE, /* not on because of expense */ - // Archive options - 'archive_frequency' => 0, /* only run manually */ - 'archive_directory' => 'sitedoc', /* archive directory within file setting */ - ); - // merge the defaults with the settings. - // if settings exist, they will replace the defaults. - // this is done in case new functions are added - it will merge in the new default values. + 'drupal_section' => TRUE, + 'kill_cron' => 0, // Kill long-running cron. + 'table_section' => TRUE, + 'optimize_tables' => FALSE, // Use OPTIMIZE to reduce overhead. + 'sequences_section' => FALSE, // Not on because not much interest. + 'node_section' => FALSE, // Not on because of expense. + 'include_comment_count' => FALSE, // Comment count on nodes. + 'include_node_access' => FALSE, // Node access summary. + 'node_show_size' => 99999, // Show nodes exceeding x KB. + 'node_max_size' => 50, // Warn if nodes exceeding x KB. + 'module_section' => TRUE, + 'module_suppress' => FALSE, // Exclude disabled modules. + 'content_section' => TRUE, + 'vocabulary_section' => TRUE, + 'orphan_term_node' => FALSE, // Not on to allow control. + 'delete_orphan_term_nodes' => FALSE, // Do not delete orphans. + 'theme_section' => TRUE, + 'variables_section' => FALSE, // Not on because of expense. + 'block_section' => TRUE, + 'block_warn' => TRUE, // Warn on missing theme. + 'block_delete' => FALSE, // Delete those orphan blocks. + 'roles_section' => TRUE, + 'role_users' => TRUE, // List users in roles. + 'role_perms_list' => FALSE, // Do role permissions as stream. + 'contacts_section' => TRUE, + 'profile_fields_section' => FALSE, // Not on because of interest. + 'url_alias_section' => FALSE, // Not on because of expense. + // Archive options. + 'archive_frequency' => 0, // Only run manually. + 'archive_directory' => 'sitedoc', // Archive directory within file setting. + ); + + // Merge the defaults with the settings. + // If settings exist, they will replace the defaults. + // This is done in case new functions are added - it will merge in the new default values. $sitedoc_settings = array_merge($_default_settings , variable_get('sitedoc_settings', array())); -// ----------------------- Sections Fieldset ----------------------- + // Sections Fieldset. $form['sections'] = array( '#type' => 'fieldset', '#title' => t('Show Sections'), @@ -362,7 +352,7 @@ function sitedoc_settings_form() { ); } -// ----------------------- Archive Fieldset ----------------------- + // Archive Fieldset. $form['archive'] = array( '#type' => 'fieldset', '#title' => t('Archive Options'), @@ -397,7 +387,7 @@ function sitedoc_settings_form() { '#description' => t('This is directory within \'!filepath\' where the Site Documentation module will place the archive file. The current date will be appended to the file name.', array('!filepath' => variable_get('file_directory_path', 'files'))), ); -// ----------------------- Update Button ----------------------- + // Update Button. $form['update']['attach'] = array( '#type' => 'submit', '#value' => t('Update'), @@ -410,61 +400,59 @@ function sitedoc_settings_form() { /** * Validate the submission. - * */ function sitedoc_settings_form_validate($form_id, $form_values) { $archive_path = variable_get('file_directory_path', 'files') .'/'. $form_values['archive_directory']; if (!file_check_directory($archive_path, TRUE, 'archive_directory')) { form_set_error('archive_directory', t('The archive path could not be found or could not be created.')); - } /* end path not found */ + } } /** * Save the settings values. */ function sitedoc_settings_form_submit($form_id, $form_values) { -// update the settings array and save it + // Update the settings array and save it. $sitedoc_settings = array( - 'drupal_section' => $form_values['drupal_section'], - 'kill_cron' => $form_values['kill_cron'], - 'table_section' => $form_values['table_section'], - 'optimize_tables' => $form_values['optimize_tables'], - 'sequences_section' => $form_values['sequences_section'], - 'node_section' => $form_values['node_section'], - 'include_comment_count' => $form_values['include_comment_count'], - 'include_node_access' => $form_values['include_node_access'], - 'node_show_size' => $form_values['node_show_size'], - 'node_max_size' => $form_values['node_max_size'], - 'module_section' => $form_values['module_section'], - 'module_suppress' => $form_values['module_suppress'], - 'content_section' => $form_values['content_section'], - 'vocabulary_section' => $form_values['vocabulary_section'], - 'orphan_term_node' => $form_values['orphan_term_node'], - 'delete_orphan_term_nodes' => $form_values['delete_orphan_term_nodes'], - 'theme_section' => $form_values['theme_section'], - 'variables_section' => $form_values['variables_section'], - 'block_section' => $form_values['block_section'], - 'block_warn' => $form_values['block_warn'], - 'block_delete' => $form_values['block_delete'], - 'roles_section' => $form_values['roles_section'], - 'role_users' => $form_values['role_users'], - 'role_perms_list' => $form_values['role_perms_list'], - 'contacts_section' => $form_values['contacts_section'], - 'profile_fields_section' => $form_values['profile_fields_section'], - 'url_alias_section' => $form_values['url_alias_section'], - - 'archive_frequency' => $form_values['archive_frequency'], - 'archive_directory' => $form_values['archive_directory'], - ); + 'drupal_section' => $form_values['drupal_section'], + 'kill_cron' => $form_values['kill_cron'], + 'table_section' => $form_values['table_section'], + 'optimize_tables' => $form_values['optimize_tables'], + 'sequences_section' => $form_values['sequences_section'], + 'node_section' => $form_values['node_section'], + 'include_comment_count' => $form_values['include_comment_count'], + 'include_node_access' => $form_values['include_node_access'], + 'node_show_size' => $form_values['node_show_size'], + 'node_max_size' => $form_values['node_max_size'], + 'module_section' => $form_values['module_section'], + 'module_suppress' => $form_values['module_suppress'], + 'content_section' => $form_values['content_section'], + 'vocabulary_section' => $form_values['vocabulary_section'], + 'orphan_term_node' => $form_values['orphan_term_node'], + 'delete_orphan_term_nodes' => $form_values['delete_orphan_term_nodes'], + 'theme_section' => $form_values['theme_section'], + 'variables_section' => $form_values['variables_section'], + 'block_section' => $form_values['block_section'], + 'block_warn' => $form_values['block_warn'], + 'block_delete' => $form_values['block_delete'], + 'roles_section' => $form_values['roles_section'], + 'role_users' => $form_values['role_users'], + 'role_perms_list' => $form_values['role_perms_list'], + 'contacts_section' => $form_values['contacts_section'], + 'profile_fields_section' => $form_values['profile_fields_section'], + 'url_alias_section' => $form_values['url_alias_section'], + 'archive_frequency' => $form_values['archive_frequency'], + 'archive_directory' => $form_values['archive_directory'], + ); variable_set('sitedoc_settings', $sitedoc_settings); drupal_set_message(t('Configuration has been updated.'), 'notice'); } -/***********************/ -/** main function **/ -/***********************/ +/** + * Main function. + */ function sitedoc_list() { drupal_add_css(drupal_get_path('module', 'sitedoc') .'/sitedoc.css'); @@ -475,26 +463,26 @@ function sitedoc_list() { $output = '"; + $output .= theme('table', $header, $rows) ."\n
"; $totsize = $datalen + $indexlen; $kb = $totsize / 1024; @@ -976,7 +964,7 @@ function sitedoc_get_modules($exclude_di else { $disabled_count ++; } } /* end foreach module */ - $output .= '
'. $disabled_count . t(' disabled modules exluded.') .'
'; } return $output; } @@ -1013,7 +1001,7 @@ function sitedoc_get_system($type=null) $mod['description'] ); } /* end while */ - $output .= theme_table($header, $rows); + $output .= theme('table', $header, $rows); } /* end if */ else { $output .= t('No entries found! Very curious.'); } return $output ."\n"; @@ -1114,7 +1102,7 @@ function sitedoc_get_blocks($warn=TRUE, else { $del .= $delsql; } } } /* end while */ - $output .= theme_table($header, $rows); + $output .= theme('table', $header, $rows); if ($missing_theme && $warn) { drupal_set_message(t('Blocks defined for non-existent theme(s)'), 'warning'); } if ($missing_theme && !$delete) { $output .= ''. $del .'
'; } @@ -1149,7 +1137,7 @@ function sitedoc_get_boxes() { highlight_string($box['body'], TRUE), ); } - $output .= theme_table($header, $rows); + $output .= theme('table', $header, $rows); return $output ."\n"; } @@ -1212,7 +1200,7 @@ function sitedoc_content_types() { if ($missing) { drupal_set_message($num_contents . t(' content types found. Missing modules identified.'), 'warning'); } else { drupal_set_message($num_contents . t(' content types found.'), 'notice'); } - $output .= theme_table($header, $rows); + $output .= theme('table', $header, $rows); return $output ."\n"; } @@ -1254,7 +1242,7 @@ function sitedoc_get_vocabularies() { $vocabulary->weight, ); } /* end foreach vocab */ - $output .= theme_table($header, $rows); + $output .= theme('table', $header, $rows); return $output ."\n"; } @@ -1279,7 +1267,7 @@ function _terms_list($vid) { } } /* end foreach */ - return "\n". theme_table($thead, $items); + return "\n". theme('table', $thead, $items); } /** @@ -1314,7 +1302,7 @@ function sitedoc_check_orphan_term_node( else { $del .= $delsql; } $rows[] = array($tn['nid'], $tn['tid'], $term->name, $vocab->name, $del); } /* end while */ - $output = theme_table($header, $rows); + $output = theme('table', $header, $rows); if (!$delete_orphans) { $output .= $del; } return $output ."\n"; } @@ -1342,7 +1330,7 @@ function sitedoc_sequences() { ); } /* end while */ - $output .= theme_table($header, $rows); + $output .= theme('table', $header, $rows); return $output ."\n"; } @@ -1445,7 +1433,7 @@ function sitedoc_node_summary($comment=F $comment ? array('data' => $com, 'class' => 'sitedoc_right') : NULL, ); $output = ' '
@@ -1460,7 +1448,7 @@ function sitedoc_node_summary($comment=F
t('Length (KB)'),
);
$output .= '