Mercurial > defr > drupal > core

annotate modules/forum/forum.admin.inc @ 20:e3d20ebd63d1 tip

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added tag 6.9 for changeset 3edae6ecd6c6
author Franck Deroche <franck@defr.org>
date Thu, 15 Jan 2009 10:16:10 +0100
parents c1f4ac30525a
children
rev   line source
webmaster@1 1 <?php
webmaster@1 2 // $Id: forum.admin.inc,v 1.8 2008/01/30 10:14:42 goba Exp $
webmaster@1 3
webmaster@1 4 /**
webmaster@1 5 * @file
webmaster@1 6 * Administrative page callbacks for the forum module.
webmaster@1 7 */
webmaster@1 8
webmaster@1 9 function forum_form_main($type, $edit = array()) {
webmaster@1 10 if ((isset($_POST['op']) && $_POST['op'] == t('Delete')) || !empty($_POST['confirm'])) {
webmaster@1 11 return drupal_get_form('forum_confirm_delete', $edit['tid']);
webmaster@1 12 }
webmaster@1 13 switch ($type) {
webmaster@1 14 case 'forum':
webmaster@1 15 return drupal_get_form('forum_form_forum', $edit);
webmaster@1 16 break;
webmaster@1 17 case 'container':
webmaster@1 18 return drupal_get_form('forum_form_container', $edit);
webmaster@1 19 break;
webmaster@1 20 }
webmaster@1 21 }
webmaster@1 22
webmaster@1 23 /**
webmaster@1 24 * Returns a form for adding a forum to the forum vocabulary
webmaster@1 25 *
webmaster@1 26 * @param $edit Associative array containing a forum term to be added or edited.
webmaster@1 27 * @ingroup forms
webmaster@1 28 * @see forum_form_submit()
webmaster@1 29 */
webmaster@1 30 function forum_form_forum(&$form_state, $edit = array()) {
webmaster@1 31 $edit += array(
webmaster@1 32 'name' => '',
webmaster@1 33 'description' => '',
webmaster@1 34 'tid' => NULL,
webmaster@1 35 'weight' => 0,
webmaster@1 36 );
webmaster@1 37 $form['name'] = array('#type' => 'textfield',
webmaster@1 38 '#title' => t('Forum name'),
webmaster@1 39 '#default_value' => $edit['name'],
webmaster@1 40 '#maxlength' => 255,
webmaster@1 41 '#description' => t('Short but meaningful name for this collection of threaded discussions.'),
webmaster@1 42 '#required' => TRUE,
webmaster@1 43 );
webmaster@1 44 $form['description'] = array('#type' => 'textarea',
webmaster@1 45 '#title' => t('Description'),
webmaster@1 46 '#default_value' => $edit['description'],
webmaster@1 47 '#description' => t('Description and guidelines for discussions within this forum.'),
webmaster@1 48 );
webmaster@1 49 $form['parent']['#tree'] = TRUE;
webmaster@1 50 $form['parent'][0] = _forum_parent_select($edit['tid'], t('Parent'), 'forum');
webmaster@1 51 $form['weight'] = array('#type' => 'weight',
webmaster@1 52 '#title' => t('Weight'),
webmaster@1 53 '#default_value' => $edit['weight'],
webmaster@1 54 '#description' => t('Forums are displayed in ascending order by weight (forums with equal weights are displayed alphabetically).'),
webmaster@1 55 );
webmaster@1 56
webmaster@1 57 $form['vid'] = array('#type' => 'hidden', '#value' => variable_get('forum_nav_vocabulary', ''));
webmaster@1 58 $form['submit' ] = array('#type' => 'submit', '#value' => t('Save'));
webmaster@1 59 if ($edit['tid']) {
webmaster@1 60 $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
webmaster@1 61 $form['tid'] = array('#type' => 'hidden', '#value' => $edit['tid']);
webmaster@1 62 }
webmaster@1 63 $form['#submit'][] = 'forum_form_submit';
webmaster@1 64 $form['#theme'] = 'forum_form';
webmaster@1 65
webmaster@1 66 return $form;
webmaster@1 67 }
webmaster@1 68
webmaster@1 69 /**
webmaster@1 70 * Process forum form and container form submissions.
webmaster@1 71 */
webmaster@1 72 function forum_form_submit($form, &$form_state) {
webmaster@1 73 if ($form['form_id']['#value'] == 'forum_form_container') {
webmaster@1 74 $container = TRUE;
webmaster@1 75 $type = t('forum container');
webmaster@1 76 }
webmaster@1 77 else {
webmaster@1 78 $container = FALSE;
webmaster@1 79 $type = t('forum');
webmaster@1 80 }
webmaster@1 81
webmaster@1 82 $status = taxonomy_save_term($form_state['values']);
webmaster@1 83 switch ($status) {
webmaster@1 84 case SAVED_NEW:
webmaster@1 85 if ($container) {
webmaster@1 86 $containers = variable_get('forum_containers', array());
webmaster@1 87 $containers[] = $form_state['values']['tid'];
webmaster@1 88 variable_set('forum_containers', $containers);
webmaster@1 89 }
webmaster@1 90 drupal_set_message(t('Created new @type %term.', array('%term' => $form_state['values']['name'], '@type' => $type)));
webmaster@1 91 break;
webmaster@1 92 case SAVED_UPDATED:
webmaster@1 93 drupal_set_message(t('The @type %term has been updated.', array('%term' => $form_state['values']['name'], '@type' => $type)));
webmaster@1 94 break;
webmaster@1 95 }
webmaster@1 96 $form_state['redirect'] = 'admin/content/forum';
webmaster@1 97 return;
webmaster@1 98 }
webmaster@1 99
webmaster@1 100 /**
webmaster@1 101 * Returns a form for adding a container to the forum vocabulary
webmaster@1 102 *
webmaster@1 103 * @param $edit Associative array containing a container term to be added or edited.
webmaster@1 104 * @ingroup forms
webmaster@1 105 * @see forum_form_submit()
webmaster@1 106 */
webmaster@1 107 function forum_form_container(&$form_state, $edit = array()) {
webmaster@1 108 $edit += array(
webmaster@1 109 'name' => '',
webmaster@1 110 'description' => '',
webmaster@1 111 'tid' => NULL,
webmaster@1 112 'weight' => 0,
webmaster@1 113 );
webmaster@1 114 // Handle a delete operation.
webmaster@1 115 $form['name'] = array(
webmaster@1 116 '#title' => t('Container name'),
webmaster@1 117 '#type' => 'textfield',
webmaster@1 118 '#default_value' => $edit['name'],
webmaster@1 119 '#maxlength' => 255,
webmaster@1 120 '#description' => t('Short but meaningful name for this collection of related forums.'),
webmaster@1 121 '#required' => TRUE
webmaster@1 122 );
webmaster@1 123
webmaster@1 124 $form['description'] = array(
webmaster@1 125 '#type' => 'textarea',
webmaster@1 126 '#title' => t('Description'),
webmaster@1 127 '#default_value' => $edit['description'],
webmaster@1 128 '#description' => t('Description and guidelines for forums within this container.')
webmaster@1 129 );
webmaster@1 130 $form['parent']['#tree'] = TRUE;
webmaster@1 131 $form['parent'][0] = _forum_parent_select($edit['tid'], t('Parent'), 'container');
webmaster@1 132 $form['weight'] = array(
webmaster@1 133 '#type' => 'weight',
webmaster@1 134 '#title' => t('Weight'),
webmaster@1 135 '#default_value' => $edit['weight'],
webmaster@1 136 '#description' => t('Containers are displayed in ascending order by weight (containers with equal weights are displayed alphabetically).')
webmaster@1 137 );
webmaster@1 138
webmaster@1 139 $form['vid'] = array(
webmaster@1 140 '#type' => 'hidden',
webmaster@1 141 '#value' => variable_get('forum_nav_vocabulary', ''),
webmaster@1 142 );
webmaster@1 143 $form['submit'] = array(
webmaster@1 144 '#type' => 'submit',
webmaster@1 145 '#value' => t('Save')
webmaster@1 146 );
webmaster@1 147 if ($edit['tid']) {
webmaster@1 148 $form['delete'] = array('#type' => 'submit', '#value' => t('Delete'));
webmaster@1 149 $form['tid'] = array('#type' => 'value', '#value' => $edit['tid']);
webmaster@1 150 }
webmaster@1 151 $form['#submit'][] = 'forum_form_submit';
webmaster@1 152 $form['#theme'] = 'forum_form';
webmaster@1 153
webmaster@1 154 return $form;
webmaster@1 155 }
webmaster@1 156
webmaster@1 157 /**
webmaster@1 158 * Returns a confirmation page for deleting a forum taxonomy term.
webmaster@1 159 *
webmaster@1 160 * @param $tid ID of the term to be deleted
webmaster@1 161 */
webmaster@1 162 function forum_confirm_delete(&$form_state, $tid) {
webmaster@1 163 $term = taxonomy_get_term($tid);
webmaster@1 164
webmaster@1 165 $form['tid'] = array('#type' => 'value', '#value' => $tid);
webmaster@1 166 $form['name'] = array('#type' => 'value', '#value' => $term->name);
webmaster@1 167
webmaster@1 168 return confirm_form($form, t('Are you sure you want to delete the forum %name?', array('%name' => $term->name)), 'admin/content/forum', t('Deleting a forum or container will also delete its sub-forums, if any. To delete posts in this forum, visit <a href="@content">content administration</a> first. This action cannot be undone.', array('@content' => url('admin/content/node'))), t('Delete'), t('Cancel'));
webmaster@1 169 }
webmaster@1 170
webmaster@1 171 /**
webmaster@1 172 * Implementation of forms api _submit call. Deletes a forum after confirmation.
webmaster@1 173 */
webmaster@1 174 function forum_confirm_delete_submit($form, &$form_state) {
webmaster@1 175 taxonomy_del_term($form_state['values']['tid']);
webmaster@1 176 drupal_set_message(t('The forum %term and all sub-forums and associated posts have been deleted.', array('%term' => $form_state['values']['name'])));
webmaster@1 177 watchdog('content', 'forum: deleted %term and all its sub-forums and associated posts.', array('%term' => $form_state['values']['name']));
webmaster@1 178
webmaster@1 179 $form_state['redirect'] = 'admin/content/forum';
webmaster@1 180 return;
webmaster@1 181 }
webmaster@1 182
webmaster@1 183 /**
webmaster@1 184 * Form builder for the forum settings page.
webmaster@1 185 *
webmaster@1 186 * @see system_settings_form()
webmaster@1 187 */
webmaster@1 188 function forum_admin_settings() {
webmaster@1 189 $form = array();
webmaster@1 190 $number = drupal_map_assoc(array(5, 10, 15, 20, 25, 30, 35, 40, 50, 60, 80, 100, 150, 200, 250, 300, 350, 400, 500));
webmaster@1 191 $form['forum_hot_topic'] = array('#type' => 'select',
webmaster@1 192 '#title' => t('Hot topic threshold'),
webmaster@1 193 '#default_value' => variable_get('forum_hot_topic', 15),
webmaster@1 194 '#options' => $number,
webmaster@1 195 '#description' => t('The number of posts a topic must have to be considered "hot".'),
webmaster@1 196 );
webmaster@1 197 $number = drupal_map_assoc(array(10, 25, 50, 75, 100));
webmaster@1 198 $form['forum_per_page'] = array('#type' => 'select',
webmaster@1 199 '#title' => t('Topics per page'),
webmaster@1 200 '#default_value' => variable_get('forum_per_page', 25),
webmaster@1 201 '#options' => $number,
webmaster@1 202 '#description' => t('Default number of forum topics displayed per page.'),
webmaster@1 203 );
webmaster@1 204 $forder = array(1 => t('Date - newest first'), 2 => t('Date - oldest first'), 3 => t('Posts - most active first'), 4 => t('Posts - least active first'));
webmaster@1 205 $form['forum_order'] = array('#type' => 'radios',
webmaster@1 206 '#title' => t('Default order'),
webmaster@1 207 '#default_value' => variable_get('forum_order', '1'),
webmaster@1 208 '#options' => $forder,
webmaster@1 209 '#description' => t('Default display order for topics.'),
webmaster@1 210 );
webmaster@1 211 return system_settings_form($form);
webmaster@1 212 }
webmaster@1 213
webmaster@1 214 /**
webmaster@1 215 * Returns an overview list of existing forums and containers
webmaster@1 216 */
webmaster@1 217 function forum_overview(&$form_state) {
webmaster@1 218 module_load_include('inc', 'taxonomy', 'taxonomy.admin');
webmaster@1 219
webmaster@1 220 $vid = variable_get('forum_nav_vocabulary', '');
webmaster@1 221 $vocabulary = taxonomy_vocabulary_load($vid);
webmaster@1 222 $form = taxonomy_overview_terms($form_state, $vocabulary);
webmaster@1 223 drupal_set_title('Forums');
webmaster@1 224
webmaster@1 225 foreach (element_children($form) as $key) {
webmaster@1 226 if (isset($form[$key]['#term'])) {
webmaster@1 227 $term = $form[$key]['#term'];
webmaster@1 228 $form[$key]['view']['#value'] = l($term['name'], 'forum/'. $term['tid']);
webmaster@1 229 if (in_array($form[$key]['#term']['tid'], variable_get('forum_containers', array()))) {
webmaster@1 230 $form[$key]['edit']['#value'] = l(t('edit container'), 'admin/content/forum/edit/container/'. $term['tid']);
webmaster@1 231 }
webmaster@1 232 else {
webmaster@1 233 $form[$key]['edit']['#value'] = l(t('edit forum'), 'admin/content/forum/edit/forum/'. $term['tid']);
webmaster@1 234 }
webmaster@1 235 }
webmaster@1 236 }
webmaster@1 237
webmaster@1 238 // Remove the alphabetical reset.
webmaster@1 239 unset($form['reset_alphabetical']);
webmaster@1 240
webmaster@1 241 // The form needs to have submit and validate handlers set explicitly.
webmaster@1 242 $form['#theme'] = 'taxonomy_overview_terms';
webmaster@1 243 $form['#submit'] = array('taxonomy_overview_terms_submit'); // Use the existing taxonomy overview submit handler.
webmaster@1 244 $form['#validate'] = array('taxonomy_overview_terms_validate');
webmaster@1 245 $form['#empty_text'] = '<em>'. t('There are no existing containers or forums. Containers and forums may be added using the <a href="@container">add container</a> and <a href="@forum">add forum</a> pages.', array('@container' => url('admin/content/forum/add/container'), '@forum' => url('admin/content/forum/add/forum'))) .'</em>';
webmaster@1 246 return $form;
webmaster@1 247 }
webmaster@1 248
webmaster@1 249 /**
webmaster@1 250 * Returns a select box for available parent terms
webmaster@1 251 *
webmaster@1 252 * @param $tid ID of the term which is being added or edited
webmaster@1 253 * @param $title Title to display the select box with
webmaster@1 254 * @param $child_type Whether the child is forum or container
webmaster@1 255 */
webmaster@1 256 function _forum_parent_select($tid, $title, $child_type) {
webmaster@1 257
webmaster@1 258 $parents = taxonomy_get_parents($tid);
webmaster@1 259 if ($parents) {
webmaster@1 260 $parent = array_shift($parents);
webmaster@1 261 $parent = $parent->tid;
webmaster@1 262 }
webmaster@1 263 else {
webmaster@1 264 $parent = 0;
webmaster@1 265 }
webmaster@1 266
webmaster@1 267 $vid = variable_get('forum_nav_vocabulary', '');
webmaster@1 268 $children = taxonomy_get_tree($vid, $tid);
webmaster@1 269
webmaster@1 270 // A term can't be the child of itself, nor of its children.
webmaster@1 271 foreach ($children as $child) {
webmaster@1 272 $exclude[] = $child->tid;
webmaster@1 273 }
webmaster@1 274 $exclude[] = $tid;
webmaster@1 275
webmaster@1 276 $tree = taxonomy_get_tree($vid);
webmaster@1 277 $options[0] = '<'. t('root') .'>';
webmaster@1 278 if ($tree) {
webmaster@1 279 foreach ($tree as $term) {
webmaster@1 280 if (!in_array($term->tid, $exclude)) {
webmaster@1 281 $options[$term->tid] = str_repeat(' -- ', $term->depth) . $term->name;
webmaster@1 282 }
webmaster@1 283 }
webmaster@1 284 }
webmaster@1 285 if ($child_type == 'container') {
webmaster@1 286 $description = t('Containers are usually placed at the top (root) level, but may also be placed inside another container or forum.');
webmaster@1 287 }
webmaster@1 288 else if ($child_type == 'forum') {
webmaster@1 289 $description = t('Forums may be placed at the top (root) level, or inside another container or forum.');
webmaster@1 290 }
webmaster@1 291
webmaster@1 292 return array('#type' => 'select', '#title' => $title, '#default_value' => $parent, '#options' => $options, '#description' => $description, '#required' => TRUE);
webmaster@1 293 }