theme.inc 28.6 KB
Newer Older
Dries's avatar
   
Dries committed
1
<?php
2
// $Id$
Dries's avatar
   
Dries committed
3

4
/**
Dries's avatar
   
Dries committed
5
 * @file
6
 * The theme system, which controls the output of Drupal.
Dries's avatar
   
Dries committed
7
8
9
10
 *
 * The theme system allows for nearly all output of the Drupal system to be
 * customized by user themes.
 *
Dries's avatar
   
Dries committed
11
 * @see <a href="http://drupal.org/node/253">Theme system</a>
Dries's avatar
   
Dries committed
12
13
 * @see themeable
 */
Dries's avatar
   
Dries committed
14

15
16
17
18
19
20
21
22
23
24
25
26
27
 /**
 * @name Content markers
 * @{
 * Markers used by theme_mark() and node_mark() to designate content.
 * @see theme_mark(), node_mark()
 */
define('MARK_READ',    0);
define('MARK_NEW',     1);
define('MARK_UPDATED', 2);
/**
 * @} End of "Content markers".
 */

Dries's avatar
   
Dries committed
28
/**
Dries's avatar
   
Dries committed
29
 * Initialize the theme system by loading the theme.
Dries's avatar
   
Dries committed
30
31
 *
 */
Dries's avatar
   
Dries committed
32
function init_theme() {
33
34
35
36
37
38
  global $theme, $user, $custom_theme, $theme_engine, $theme_key;

  // If $theme is already set, assume the others are set, too, and do nothing
  if (isset($theme)) {
    return;
  }
Dries's avatar
   
Dries committed
39

40
  drupal_bootstrap(DRUPAL_BOOTSTRAP_DATABASE);
Dries's avatar
   
Dries committed
41
42
  $themes = list_themes();

43
44
  // Only select the user selected theme if it is available in the
  // list of enabled themes.
Dries's avatar
   
Dries committed
45
  $theme = $user->theme && $themes[$user->theme]->status ? $user->theme : variable_get('theme_default', 'bluemarine');
Dries's avatar
   
Dries committed
46
47

  // Allow modules to override the present theme... only select custom theme
Dries's avatar
   
Dries committed
48
  // if it is available in the list of installed themes.
49
  $theme = $custom_theme && $themes[$custom_theme] ? $custom_theme : $theme;
Dries's avatar
   
Dries committed
50
51
52
53
54
55

  // Store the identifier for retrieving theme settings with.
  $theme_key = $theme;

  // If we're using a style, load its appropriate theme,
  // which is stored in the style's description field.
56
  // Also load the stylesheet using theme_add_style().
Dries's avatar
   
Dries committed
57
58
  // Otherwise, load the theme.
  if (strpos($themes[$theme]->filename, '.css')) {
59
    // File is a style; loads its CSS.
Dries's avatar
   
Dries committed
60
    // Set theme to its template/theme
61
    theme_add_style($themes[$theme]->filename);
62
    $theme = basename(dirname($themes[$theme]->description));
Dries's avatar
   
Dries committed
63
64
65
  }
  else {
    // File is a template/theme
66
    // Load its CSS, if it exists
Dries's avatar
   
Dries committed
67
    if (file_exists($stylesheet = dirname($themes[$theme]->filename) .'/style.css')) {
68
      theme_add_style($stylesheet);
Dries's avatar
   
Dries committed
69
70
    }
  }
Dries's avatar
   
Dries committed
71

Dries's avatar
   
Dries committed
72
  if (strpos($themes[$theme]->filename, '.theme')) {
73
   // file is a theme; include it
74
   include_once './' . $themes[$theme]->filename;
Dries's avatar
   
Dries committed
75
76
77
  }
  elseif (strpos($themes[$theme]->description, '.engine')) {
    // file is a template; include its engine
78
    include_once './' . $themes[$theme]->description;
Dries's avatar
   
Dries committed
79
80
81
82
83
    $theme_engine = basename($themes[$theme]->description, '.engine');
    if (function_exists($theme_engine .'_init')) {
      call_user_func($theme_engine .'_init', $themes[$theme]);
    }
  }
Dries's avatar
   
Dries committed
84
85
86
}

/**
Dries's avatar
   
Dries committed
87
88
89
 * Provides a list of currently available themes.
 *
 * @param $refresh
90
91
92
 *   Whether to reload the list of themes from the database.
 * @return
 *   An array of the currently available themes.
Dries's avatar
   
Dries committed
93
 */
94
function list_themes($refresh = FALSE) {
Dries's avatar
   
Dries committed
95
96
97
98
99
100
101
102
  static $list;

  if ($refresh) {
    unset($list);
  }

  if (!$list) {
    $list = array();
103
    $result = db_query("SELECT * FROM {system} WHERE type = 'theme'");
Dries's avatar
   
Dries committed
104
105
106
107
108
109
110
111
112
113
    while ($theme = db_fetch_object($result)) {
      if (file_exists($theme->filename)) {
        $list[$theme->name] = $theme;
      }
    }
  }

  return $list;
}

Dries's avatar
   
Dries committed
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
/**
 * Provides a list of currently available theme engines
 *
 * @param $refresh
 *   Whether to reload the list of themes from the database.
 * @return
 *   An array of the currently available theme engines.
 */
function list_theme_engines($refresh = FALSE) {
  static $list;

  if ($refresh) {
    unset($list);
  }

  if (!$list) {
    $list = array();
Dries's avatar
   
Dries committed
131
    $result = db_query("SELECT * FROM {system} WHERE type = 'theme_engine' AND status = '1' ORDER BY name");
Dries's avatar
   
Dries committed
132
133
134
135
136
137
138
139
140
141
    while ($engine = db_fetch_object($result)) {
      if (file_exists($engine->filename)) {
        $list[$engine->name] = $engine;
      }
    }
  }

  return $list;
}

Dries's avatar
   
Dries committed
142
/**
143
 * Generate the themed representation of a Drupal object.
Dries's avatar
   
Dries committed
144
145
146
 *
 * All requests for themed functions must go through this function. It examines
 * the request and routes it to the appropriate theme function. If the current
Dries's avatar
   
Dries committed
147
148
149
 * theme does not implement the requested function, then the current theme
 * engine is checked. If neither the engine nor theme implement the requested
 * function, then the base theme function is called.
150
151
152
 *
 * For example, to retrieve the HTML that is output by theme_page($output), a
 * module should call theme('page', $output).
Dries's avatar
   
Dries committed
153
 *
154
155
156
157
158
159
 * @param $function
 *   The name of the theme function to call.
 * @param ...
 *   Additional arguments to pass along to the theme function.
 * @return
 *   An HTML string that generates the themed output.
Dries's avatar
   
Dries committed
160
 */
Dries's avatar
   
Dries committed
161
function theme() {
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
  $args = func_get_args();
  $function = array_shift($args);

  if ($func = theme_get_function($function)) {
    return call_user_func_array($func, $args);
  }
}

/**
 * Determine if a theme function exists, and if so return which one was found.
 *
 * @param $function
 *   The name of the theme function to test.
 * @return
 *   The name of the theme function that should be used, or false if no function exists.
 */
function theme_get_function($function) {
Dries's avatar
   
Dries committed
179
180
  global $theme, $theme_engine;

181
182
183
184
  // Because theme() is called a lot, calling init_theme() only to have it
  // smartly return is a noticeable performance hit.   Don't do it.
  if (!isset($theme)) {
    init_theme();
Dries's avatar
   
Dries committed
185
  }
Dries's avatar
   
Dries committed
186

Dries's avatar
   
Dries committed
187
188
  if (($theme != '') && function_exists($theme .'_'. $function)) {
    // call theme function
189
    return $theme .'_'. $function;
Dries's avatar
   
Dries committed
190
  }
Dries's avatar
   
Dries committed
191
192
  elseif (($theme != '') && isset($theme_engine) && function_exists($theme_engine .'_'. $function)) {
    // call engine function
193
    return $theme_engine .'_'. $function;
Dries's avatar
   
Dries committed
194
  }
195
  elseif (function_exists('theme_'. $function)){
Dries's avatar
   
Dries committed
196
    // call Drupal function
197
    return 'theme_'. $function;
Dries's avatar
   
Dries committed
198
  }
199
  return false;
Dries's avatar
   
Dries committed
200
201
202
}

/**
203
 * Return the path to the currently selected theme.
Dries's avatar
   
Dries committed
204
 */
Dries's avatar
   
Dries committed
205
206
function path_to_theme() {
  global $theme;
Dries's avatar
   
Dries committed
207
208
209
210

  $themes = list_themes();

  return dirname($themes[$theme]->filename);
Dries's avatar
   
Dries committed
211
212
}

Dries's avatar
   
Dries committed
213
214
215
/**
 * Retrieve an associative array containing the settings for a theme.
 *
216
 * The final settings are arrived at by merging the default settings,
Dries's avatar
   
Dries committed
217
218
219
220
221
222
223
224
225
226
227
228
229
 * the site-wide settings, and the settings defined for the specific theme.
 * If no $key was specified, only the site-wide theme defaults are retrieved.
 *
 * The default values for each of settings are also defined in this function.
 * To add new settings, add their default values here, and then add form elements
 * to system_theme_settings() in system.module.
 *
 * @param $key
 *  The template/style value for a given theme.
 *
 * @return
 *   An associative array containing theme settings.
 */
230
function theme_get_settings($key = NULL) {
Dries's avatar
   
Dries committed
231
232
233
234
  $defaults = array(
    'mission'                       =>  '',
    'default_logo'                  =>  1,
    'logo_path'                     =>  '',
235
236
    'default_favicon'               =>  1,
    'favicon_path'                  =>  '',
Dries's avatar
   
Dries committed
237
    'toggle_logo'                   =>  1,
238
    'toggle_favicon'                =>  1,
Dries's avatar
   
Dries committed
239
240
241
242
243
244
245
246
    'toggle_name'                   =>  1,
    'toggle_search'                 =>  1,
    'toggle_slogan'                 =>  0,
    'toggle_mission'                =>  1,
    'toggle_node_user_picture'      =>  0,
    'toggle_comment_user_picture'   =>  0,
  );

247
  if (module_exist('node')) {
248
    foreach (node_get_types() as $type) {
249
250
      $defaults['toggle_node_info_' . $type] = 1;
    }
Dries's avatar
   
Dries committed
251
252
253
254
255
256
257
  }
  $settings = array_merge($defaults, variable_get('theme_settings', array()));

  if ($key) {
    $settings = array_merge($settings, variable_get(str_replace('/', '_', 'theme_'. $key .'_settings'), array()));
  }

258
  // Only offer search box if search.module is enabled.
259
  if (!module_exist('search') || !user_access('search content')) {
260
261
262
    $settings['toggle_search'] = 0;
  }

Dries's avatar
   
Dries committed
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
  return $settings;
}

/**
 * Retrieve a setting for the current theme.
 * This function is designed for use from within themes & engines
 * to determine theme settings made in the admin interface.
 *
 * Caches values for speed (use $refresh = TRUE to refresh cache)
 *
 * @param $setting_name
 *  The name of the setting to be retrieved.
 *
 * @param $refresh
 *  Whether to reload the cache of settings.
 *
 * @return
 *   The value of the requested setting, NULL if the setting does not exist.
 */
282
function theme_get_setting($setting_name, $refresh = FALSE) {
283
  global $theme_key;
Dries's avatar
   
Dries committed
284
285
286
  static $settings;

  if (empty($settings) || $refresh) {
287
    $settings = theme_get_settings($theme_key);
Dries's avatar
   
Dries committed
288
289
290
291
292
293
294
295
296
297
298
299
300
301

    $themes = list_themes();
    $theme_object = $themes[$theme_key];

    if ($settings['mission'] == '') {
      $settings['mission'] = variable_get('site_mission', '');
    }

    if (!$settings['toggle_mission']) {
      $settings['mission'] = '';
    }

    if ($settings['toggle_logo']) {
      if ($settings['default_logo']) {
302
        $settings['logo'] = base_path() . dirname($theme_object->filename) .'/logo.png';
Dries's avatar
   
Dries committed
303
304
      }
      elseif ($settings['logo_path']) {
305
        $settings['logo'] = base_path() . $settings['logo_path'];
Dries's avatar
   
Dries committed
306
307
308
      }
    }

309
310
311
    if ($settings['toggle_favicon']) {
      if ($settings['default_favicon']) {
        if (file_exists($favicon = dirname($theme_object->filename) .'/favicon.ico')) {
312
          $settings['favicon'] = base_path() . $favicon;
313
314
        }
        else {
315
          $settings['favicon'] = base_path() . 'misc/favicon.ico';
316
317
318
        }
      }
      elseif ($settings['favicon_path']) {
319
        $settings['favicon'] = base_path() . $settings['favicon_path'];
320
321
      }
    }
Dries's avatar
   
Dries committed
322
323
324
325
326
  }

  return isset($settings[$setting_name]) ? $settings[$setting_name] : NULL;
}

327
328
329
330
/**
 * Add a theme stylesheet to be included later. This is handled separately from
 * drupal_set_html_head() to enforce the correct CSS cascading order.
 */
331
function theme_add_style($path = '', $media = 'all') {
332
  static $styles = array();
333

334
  if ($path && !isset($styles["$media:$path"])) {
335
    $style = new stdClass();
336
    $style->path = base_path() . $path;
337
    $style->media = $media;
338
    $styles["$media:$path"] = $style;
339
340
341
342
343
344
345
346
347
348
  }
  return $styles;
}

/**
 * Return the HTML for a theme's stylesheets.
 */
function theme_get_styles() {
  $output = '';
  foreach (theme_add_style() as $style) {
349
    $output .= theme('stylesheet_import', $style->path, $style->media);
350
351
352
353
  }
  return $output;
}

354
355
356
/**
 * @defgroup themeable Themeable functions
 * @{
Dries's avatar
   
Dries committed
357
 * Functions that display HTML, and which can be customized by themes.
358
 *
359
360
361
362
 * All functions that produce HTML for display should be themeable. This means
 * that they should be named with the theme_ prefix, and invoked using theme()
 * rather than being called directly. This allows themes to override the display
 * of any Drupal object.
363
 *
Dries's avatar
   
Dries committed
364
 * The theme system is described and defined in theme.inc.
365
 */
366

367
368
369
370
371
372
373
374
375
376
377
378
379
/**
 * Format a dynamic text string for emphasised display in a placeholder.
 *
 * E.g. t('Added term %term', array('%term' => theme('placeholder', $term)))
 *
 * @param $text
 *   The text to format (plain-text).
 * @return
 *   The formatted text (html).
 */
function theme_placeholder($text) {
  return '<em>'. check_plain($text) .'</em>';
}
Dries's avatar
   
Dries committed
380

Dries's avatar
   
Dries committed
381
/**
382
383
384
385
386
387
 * Return an entire Drupal page displaying the supplied content.
 *
 * @param $content
 *   A string to display in the main content area of the page.
 * @return
 *   A string containing the entire HTML page.
Dries's avatar
   
Dries committed
388
 */
389
function theme_page($content) {
Dries's avatar
   
Dries committed
390
  $output = "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
391
392
  $output .= '<html xmlns="http://www.w3.org/1999/xhtml">';
  $output .= '<head>';
393
  $output .= ' <title>'. (drupal_get_title() ? strip_tags(drupal_get_title()) : variable_get('site_name', 'drupal')) .'</title>';
Dries's avatar
Dries committed
394
  $output .= drupal_get_html_head();
395
  $output .= theme_get_styles();
Dries's avatar
   
Dries committed
396

397
  $output .= ' </head>';
398
  $output .= ' <body style="background-color: #fff; color: #000;">';
399
  $output .= '<table border="0" cellspacing="4" cellpadding="4"><tr><td style="vertical-align: top; width: 170px;">';
Dries's avatar
   
Dries committed
400

401
402
  $output .= theme('blocks', 'all');
  $output .= '</td><td style="vertical-align: top;">';
Dries's avatar
   
Dries committed
403

404
405
  $output .= theme('breadcrumb', drupal_get_breadcrumb());
  $output .= '<h1>' . drupal_get_title() . '</h1>';
Dries's avatar
   
Dries committed
406
407
408
409
410

  if ($tabs = theme('menu_local_tasks')) {
   $output .= $tabs;
  }

411
  $output .= theme('help');
Dries's avatar
   
Dries committed
412

413
  $output .= theme('status_messages');
Dries's avatar
   
Dries committed
414

Dries's avatar
   
Dries committed
415
  $output .= "\n<!-- begin content -->\n";
Dries's avatar
   
Dries committed
416
  $output .= $content;
Dries's avatar
   
Dries committed
417
418
  $output .= "\n<!-- end content -->\n";

419
  $output .= '</td></tr></table>';
Dries's avatar
   
Dries committed
420
  $output .= theme_closure();
421
  $output .= '</body></html>';
Dries's avatar
   
Dries committed
422
423
424
425

  return $output;
}

426
function theme_maintenance_page($content, $messages = TRUE, $partial = FALSE) {
427
428
  drupal_set_header('Content-Type: text/html; charset=utf-8');
  theme('add_style', 'misc/maintenance.css');
429
  drupal_set_html_head('<link rel="shortcut icon" href="'. base_path() .'misc/favicon.ico" type="image/x-icon" />');
430

431
432
433
434
  $output = "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n";
  $output .= '<html xmlns="http://www.w3.org/1999/xhtml">';
  $output .= '<head>';
  $output .= ' <title>'. drupal_get_title() .'</title>';
435
  $output .= drupal_get_html_head();
436
437
438
439
440
  $output .= theme_get_styles();
  $output .= '</head>';
  $output .= '<body>';
  $output .= '<h1>' . drupal_get_title() . '</h1>';

441
442
443
  if ($messages) {
    $output .= theme('status_messages');    
  }
444
445
446
447
448

  $output .= "\n<!-- begin content -->\n";
  $output .= $content;
  $output .= "\n<!-- end content -->\n";

449
450
451
  if (!$partial) {
    $output .= '</body></html>';  
  }
452
453
454
455

  return $output;
}

Dries's avatar
   
Dries committed
456
457
458
459
/**
 * Returns themed set of status and/or error messages.  The messages are grouped
 * by type.
 *
460
461
 * @return
 *   A string containing the messages.
Dries's avatar
   
Dries committed
462
463
464
465
466
467
468
469
470
 */
function theme_status_messages() {
  if ($data = drupal_get_messages()) {
    $output = '';
    foreach ($data as $type => $messages) {
      $output .= "<div class=\"messages $type\">\n";
      if (count($messages) > 1) {
        $output .= " <ul>\n";
        foreach($messages as $message) {
Dries's avatar
   
Dries committed
471
          $output .= '  <li>'. $message ."</li>\n";
Dries's avatar
   
Dries committed
472
473
474
475
        }
        $output .= " </ul>\n";
      }
      else {
Dries's avatar
   
Dries committed
476
        $output .= $messages[0];
Dries's avatar
   
Dries committed
477
478
479
480
481
482
483
484
      }
      $output .= "</div>\n";
    }

    return $output;
  }
}

Dries's avatar
   
Dries committed
485
/**
486
487
488
489
490
491
492
493
 * Return a themed set of links.
 *
 * @param $links
 *   An array of links to be themed.
 * @param $delimiter
 *   A string used to separate the links.
 * @return
 *   A string containing the themed links.
Dries's avatar
   
Dries committed
494
 */
495
function theme_links($links, $delimiter = ' | ') {
496
497
498
  if (!is_array($links)) {
    return '';
  }
Dries's avatar
   
Dries committed
499
500
  return implode($delimiter, $links);
}
Dries's avatar
   
Dries committed
501

Dries's avatar
   
Dries committed
502
/**
503
 * Return a themed image.
Dries's avatar
   
Dries committed
504
 *
Dries's avatar
   
Dries committed
505
506
507
508
509
510
 * @param $path
 *   The path of the image file.
 * @param $alt
 *   The alternative text for text-based browsers.
 * @param $title
 *   The title text is displayed when the image is hovered in some popular browsers.
511
512
 * @param $attributes
 *   Associative array of attributes to be placed in the img tag.
Steven Wittens's avatar
Steven Wittens committed
513
514
 * @param $getsize
 *   If set to true, the image's dimension are fetched and added as width/height attributes.
515
 * @return
Dries's avatar
   
Dries committed
516
 *   A string containing the image tag.
Dries's avatar
   
Dries committed
517
 */
518
function theme_image($path, $alt = '', $title = '', $attributes = NULL, $getsize = TRUE) {
519
  if (!$getsize || (is_file($path) && (list($width, $height, $type, $image_attributes) = @getimagesize($path)))) {
520
    $attributes = drupal_attributes($attributes);
521
    return '<img src="'. check_url(base_path() . $path) .'" alt="'. check_plain($alt) .'" title="'. check_plain($title) .'" '. $image_attributes . $attributes .' />';
Dries's avatar
   
Dries committed
522
  }
Dries's avatar
   
Dries committed
523
}
Dries's avatar
   
Dries committed
524

Dries's avatar
   
Dries committed
525
/**
526
 * Return a themed breadcrumb trail.
Dries's avatar
   
Dries committed
527
 *
528
529
530
 * @param $breadcrumb
 *   An array containing the breadcrumb links.
 * @return a string containing the breadcrumb output.
Dries's avatar
   
Dries committed
531
 */
Dries's avatar
   
Dries committed
532
function theme_breadcrumb($breadcrumb) {
533
534
535
  if (!empty($breadcrumb)) {
    return '<div class="breadcrumb">'. implode(' » ', $breadcrumb) .'</div>';
  }
Dries's avatar
   
Dries committed
536
}
Dries's avatar
   
Dries committed
537

538
539
540
541
542
543
544
545
546
547
548
/**
 * Return a themed help message.
 *
 * @return a string containing the helptext for the current page.
 */
function theme_help() {
  if ($help = menu_get_active_help()) {
    return '<div class="help">'. $help .'</div>';
  }
}

Dries's avatar
   
Dries committed
549
/**
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
 * Return a themed node.
 *
 * @param $node
 *   An object providing all relevant information for displaying a node:
 *   - $node->nid: The ID of the node.
 *   - $node->type: The content type (story, blog, forum...).
 *   - $node->title: The title of the node.
 *   - $node->created: The creation date, as a UNIX timestamp.
 *   - $node->teaser: A shortened version of the node body.
 *   - $node->body: The entire node contents.
 *   - $node->changed: The last modification date, as a UNIX timestamp.
 *   - $node->uid: The ID of the author.
 *   - $node->username: The username of the author.
 * @param $teaser
 *   Whether to display the teaser only, as on the main page.
 * @param $page
 *   Whether to display the node as a standalone page. If TRUE, do not display
 *   the title because it will be provided by the menu system.
 * @return
 *   A string containing the node output.
Dries's avatar
   
Dries committed
570
 */
571
572
573
function theme_node($node, $teaser = FALSE, $page = FALSE) {
  if (module_exist('taxonomy')) {
    $terms = taxonomy_link('taxonomy terms', $node);
Dries's avatar
   
Dries committed
574
575
  }

Dries's avatar
   
Dries committed
576
  if ($page == 0) {
577
    $output = t('%title by %name', array('%title' => '<h2 class="title">'. check_plain($node->title) .'</h2>', '%name' => theme('username', $node)));
Dries's avatar
   
Dries committed
578
579
  }
  else {
580
    $output = t('by %name', array('%name' => theme('username', $node)));
Dries's avatar
   
Dries committed
581
  }
Dries's avatar
   
Dries committed
582
583

  if (count($terms)) {
584
    $output .= ' <small>('. theme('links', $terms) .')</small><br />';
Dries's avatar
   
Dries committed
585
586
  }

587
  if ($teaser && $node->teaser) {
Dries's avatar
   
Dries committed
588
589
590
591
    $output .= $node->teaser;
  }
  else {
    $output .= $node->body;
Dries's avatar
   
Dries committed
592
593
  }

594
595
  if ($node->links) {
    $output .= '<div class="links">'. theme('links', $node->links) .'</div>';
Dries's avatar
   
Dries committed
596
  }
Dries's avatar
   
Dries committed
597

Dries's avatar
   
Dries committed
598
  return $output;
Dries's avatar
   
Dries committed
599
600
}

Dries's avatar
   
Dries committed
601
/**
602
 * Return a themed form element.
Dries's avatar
   
Dries committed
603
604
605
606
 *
 * @param $title the form element's title
 * @param $value the form element's data
 * @param $description the form element's description or explanation
Dries's avatar
   
Dries committed
607
 * @param $id the form element's ID used by the &lt;label&gt; tag
Dries's avatar
   
Dries committed
608
609
 * @param $required a boolean to indicate whether this is a required field or not
 * @param $error a string with an error message filed against this form element
Dries's avatar
   
Dries committed
610
 *
Dries's avatar
   
Dries committed
611
 * @return a string representing the form element
Dries's avatar
   
Dries committed
612
 */
Dries's avatar
   
Dries committed
613
function theme_form_element($title, $value, $description = NULL, $id = NULL, $required = FALSE, $error = FALSE) {
614

615
  $output  = '<div class="form-item">'."\n";
Dries's avatar
Dries committed
616
  $required = $required ? '<span class="form-required" title="'. t('This field is required.') .'">*</span>' : '';
Dries's avatar
   
Dries committed
617
618
619

  if ($title) {
    if ($id) {
620
      $output .= ' <label for="'. form_clean_id($id) .'">'. $title .":$required</label>\n";
Dries's avatar
   
Dries committed
621
622
    }
    else {
623
      $output .= ' <label>'. $title .":$required</label>\n";
Dries's avatar
   
Dries committed
624
625
626
    }
  }

627
628
  $output .= " $value\n";

Dries's avatar
   
Dries committed
629
  if ($description) {
630
    $output .= ' <div class="description">'. $description ."</div>\n";
Dries's avatar
   
Dries committed
631
632
  }

633
634
635
  $output .= "</div>\n";

  return $output;
Dries's avatar
   
Dries committed
636
}
Dries's avatar
   
Dries committed
637

Dries's avatar
   
Dries committed
638
/**
639
 * Return a themed submenu, typically displayed under the tabs.
Dries's avatar
   
Dries committed
640
 *
641
642
 * @param $links
 *   An array of links.
Dries's avatar
   
Dries committed
643
644
 */
function theme_submenu($links) {
645
  return '<div class="submenu">'. implode(' | ', $links) .'</div>';
Dries's avatar
   
Dries committed
646
647
}

Dries's avatar
   
Dries committed
648
/**
649
650
651
652
653
654
655
656
657
658
659
 * Return a themed table.
 *
 * @param $header
 *   An array containing the table headers. Each element of the array can be
 *   either a localized string or an associative array with the following keys:
 *   - "data": The localized title of the table column.
 *   - "field": The database field represented in the table column (required if
 *     user is to be able to sort on this column).
 *   - "sort": A default sort order for this column ("asc" or "desc").
 *   - Any HTML attributes, such as "colspan", to apply to the column header cell.
 * @param $rows
660
661
662
663
664
665
 *   An array of table rows. Every row is an array of cells, or an associative
 *   array with the following keys:
 *   - "data": an array of cells
 *   - Any HTML attributes, such as "class", to apply to the table row.
 *
 *   Each cell can be either a string or an associative array with the following keys:
666
667
 *   - "data": The string to display in the table cell.
 *   - Any HTML attributes, such as "colspan", to apply to the table cell.
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
 *
 *   Here's an example for $rows:
 *   @verbatim
 *   $rows = array(
 *     // Simple row
 *     array(
 *       'Cell 1', 'Cell 2', 'Cell 3'
 *     ),
 *     // Row with attributes on the row and some of its cells.
 *     array(
 *       'data' => array('Cell 1', array('data' => 'Cell 2', 'colspan' => 2)), 'class' => 'funky'
 *     )
 *   );
 *   @endverbatim
 *
683
684
 * @param $attributes
 *   An array of HTML attributes to apply to the table tag.
685
686
 * @param $caption
 *   A localized string to use for the <caption> tag.
687
688
 * @return
 *   An HTML string representing the table.
Dries's avatar
   
Dries committed
689
 */
690
function theme_table($header, $rows, $attributes = array(), $caption = NULL) {
Dries's avatar
   
Dries committed
691
  $output = '<table'. drupal_attributes($attributes) .">\n";
Dries's avatar
   
Dries committed
692

693
694
695
696
  if (isset($caption)) {
    $output .= '<caption>'. $caption ."</caption>\n";
  }

697
  // Format the table header:
698
  if (count($header)) {
Dries's avatar
   
Dries committed
699
    $ts = tablesort_init($header);
700
    $output .= ' <thead><tr>';
Dries's avatar
   
Dries committed
701
    foreach ($header as $cell) {
702
      $cell = tablesort_header($cell, $header, $ts);
Dries's avatar
   
Dries committed
703
704
      $output .= _theme_table_cell($cell, 1);
    }
705
    $output .= " </tr></thead>\n";
Dries's avatar
   
Dries committed
706
707
  }

708
  // Format the table rows:
709
  $output .= "<tbody>\n";
710
  if (count($rows)) {
Dries's avatar
   
Dries committed
711
    foreach ($rows as $number => $row) {
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
      $attributes = array();

      // Check if we're dealing with a simple or complex row
      if (isset($row['data'])) {
        foreach ($row as $key => $value) {
          if ($key == 'data') {
            $cells = $value;
          }
          else {
            $attributes[$key] = $value;
          }
        }
      }
      else {
        $cells = $row;
      }

729
730
      // Add odd/even class
      $class = ($number % 2 == 1) ? 'even': 'odd';
731
732
      if (isset($attributes['class'])) {
        $attributes['class'] .= ' '. $class;
Dries's avatar
   
Dries committed
733
734
      }
      else {
735
        $attributes['class'] = $class;
Dries's avatar
   
Dries committed
736
737
      }

738
739
      // Build row
      $output .= ' <tr'. drupal_attributes($attributes) .'>';
740
      $i = 0;
741
742
      foreach ($cells as $cell) {
        $cell = tablesort_cell($cell, $header, $ts, $i++);
Dries's avatar
   
Dries committed
743
744
745
746
747
748
        $output .= _theme_table_cell($cell, 0);
      }
      $output .= " </tr>\n";
    }
  }

749
  $output .= "</tbody></table>\n";
Dries's avatar
   
Dries committed
750
751
752
  return $output;
}

753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
/**
 * Return a themed sort icon.
 *
 * @param $style
 *   Set to either asc or desc.  This sets which icon to show.
 * @return
 *   A themed sort icon.
 */
function theme_tablesort_indicator($style) {
  if ($style == "asc"){
    return theme('image', 'misc/arrow-asc.png', t('sort icon'), t('sort ascending'));
  }
  else {
    return theme('image', 'misc/arrow-desc.png', t('sort icon'), t('sort descending'));
  }
}

Dries's avatar
   
Dries committed
770
/**
771
772
773
774
775
776
777
778
779
780
 * Return a themed box.
 *
 * @param $title
 *   The subject of the box.
 * @param $content
 *   The content of the box.
 * @param $region
 *   The region in which the box is displayed.
 * @return
 *   A string containing the box output.
Dries's avatar
   
Dries committed
781
 */
Dries's avatar
   
Dries committed
782
function theme_box($title, $content, $region = 'main') {
783
  $output = '<h2 class="title">'. $title .'</h2><div>'. $content .'</div>';
Dries's avatar
   
Dries committed
784
  return $output;
Dries's avatar
   
Dries committed
785
786
787
}

/**
788
 * Return a themed block.
Dries's avatar
   
Dries committed
789
790
791
792
793
794
 *
 * You can style your blocks by defining .block (all blocks),
 * .block-<i>module</i> (all blocks of module <i>module</i>), and
 * \#block-<i>module</i>-<i>delta</i> (specific block of module <i>module</i>
 * with delta <i>delta</i>) in your theme's CSS.
 *
795
796
 * @param $block
 *   An object populated with fields from the "blocks" database table
797
 *   ($block->module, $block->delta ...) and fields returned by
798
799
800
 *   <i>module</i>_block('view') ($block->subject, $block->content, ...).
 * @return
 *   A string containing the block output.
Dries's avatar
   
Dries committed
801
 */
Dries's avatar
   
Dries committed
802
function theme_block($block) {
Dries's avatar
   
Dries committed
803
804
805
806
  $output  = "<div class=\"block block-$block->module\" id=\"block-$block->module-$block->delta\">\n";
  $output .= " <h2 class=\"title\">$block->subject</h2>\n";
  $output .= " <div class=\"content\">$block->content</div>\n";
  $output .= "</div>\n";
Dries's avatar
   
Dries committed
807
  return $output;
Dries's avatar
   
Dries committed
808
}
Dries's avatar
   
Dries committed
809

Dries's avatar
   
Dries committed
810
/**
811
812
 * Return a themed marker, useful for marking new or updated
 * content.
Dries's avatar
   
Dries committed
813
 *
814
 * @param $type
815
816
 *   Number representing the marker type to display
 * @see MARK_NEW, MARK_UPDATED, MARK_READ
817
818
 * @return
 *   A string containing the marker.
Dries's avatar
   
Dries committed
819
 */
820
821
function theme_mark($type = MARK_NEW) {
  global $user;
822
823
  if ($user->uid) {
    if ($type == MARK_NEW) {
Dries's avatar
Dries committed
824
      return ' <span class="marker">'. t('new') .'</span>';
825
826
    }
    else if ($type == MARK_UPDATED) {
Dries's avatar
Dries committed
827
      return ' <span class="marker">'. t('updated') .'</span>';
828
    }
829
  }
Dries's avatar
   
Dries committed
830
831
}

Dries's avatar
   
Dries committed
832
833
/**
 * Import a stylesheet using @import.
834
 *
835
836
 * @param $path
 *  The path to the stylesheet.
Dries's avatar
   
Dries committed
837
838
839
840
841
842
843
 *
 * @param $media
 *  The media type to specify for the stylesheet
 *
 * @return
 *  A string containing the HTML for the stylesheet import.
 */
844
845
function theme_stylesheet_import($path, $media = 'all') {
  return '<style type="text/css" media="'. $media .'">@import "'. $path .'";</style>';
Dries's avatar
   
Dries committed
846
847
}

Dries's avatar
   
Dries committed
848
/**
849
850
851
852
853
854
 * Return a themed list of items.
 *
 * @param $items
 *   An array of items to be displayed in the list.
 * @param $title
 *   The title of the list.
855
856
 * @param $type
 *   The type of list to return (e.g. "ul", "ol")
857
858
 * @return
 *   A string containing the list output.
Dries's avatar
   
Dries committed
859
 */
860
function theme_item_list($items = array(), $title = NULL, $type = 'ul') {
861
  $output = '<div class="item-list">';
Dries's avatar
   
Dries committed
862
  if (isset($title)) {
863
    $output .= '<h3>'. $title .'</h3>';
Dries's avatar
   
Dries committed
864
865
  }

866
  if (!empty($items)) {
867
    $output .= "<$type>";
Dries's avatar
   
Dries committed
868
    foreach ($items as $item) {
869
      $output .= '<li>'. $item .'</li>';
Dries's avatar
   
Dries committed
870
    }
871
    $output .= "</$type>";
Dries's avatar
   
Dries committed
872
  }
873
  $output .= '</div>';
Dries's avatar
   
Dries committed
874
875
876
  return $output;
}

Dries's avatar
   
Dries committed
877
/**
878
 * Returns code that emits the 'more help'-link.
Dries's avatar
   
Dries committed
879
 */
Dries's avatar
   
Dries committed
880
function theme_more_help_link($url) {
881
  return '<div class="more-help-link">' . t('[<a href="%link">more help...</a>]', array('%link' => check_url($url))) . '</div>';
Dries's avatar
   
Dries committed
882
883
}

Dries's avatar
   
Dries committed
884
/**
885
 * Return code that emits an XML icon.
Dries's avatar
   
Dries committed
886
887
 */
function theme_xml_icon($url) {
Dries's avatar
   
Dries committed
888
  if ($image = theme('image', 'misc/xml.png', t('XML feed'), t('XML feed'))) {
889
    return '<a href="'. check_url($url) .'" class="xml-icon">'. $image. '</a>';
Dries's avatar
   
Dries committed
890
  }
Dries's avatar
   
Dries committed
891
892
}

893
894
895
896
897
/**
 * Return code that emits an feed icon.
 */
function theme_feed_icon($url) {
  if ($image = theme('image', 'misc/feed.png', t('Syndicate content'), t('Syndicate content'))) {
898
    return '<a href="'. check_url($url) .'" class="feed-icon">'. $image. '</a>';
899
900
901
  }
}

Dries's avatar
   
Dries committed
902
/**
903
904
 * Execute hook_footer() which is run at the end of the page right before the
 * close of the body tag.
Dries's avatar
   
Dries committed
905
906
907
 *
 * @param $main (optional)
 *
908
909
 * @return
 *   A string containing the results of the hook_footer() calls.
Dries's avatar
   
Dries committed
910
 */
Dries's avatar
   
Dries committed
911
function theme_closure($main = 0) {
Dries's avatar
   
Dries committed
912
  $footer = module_invoke_all('footer', $main);
913
  return implode("\n", $footer);
Dries's avatar
   
Dries committed
914
915
}

Dries's avatar
   
Dries committed
916
/**
917
 * Return a set of blocks available for the current user.
918
 *
919
920
921
922
 * @param $region
 *   Which set of blocks to retrieve.
 * @return
 *   A string containing the themed blocks for this region.
923
924
 */
function theme_blocks($region) {
Dries's avatar
   
Dries committed
925
  $output = '';
926
927
928
929
930

  if ($list = module_invoke('block', 'list', $region)) {
    foreach ($list as $key => $block) {
      // $key == <i>module</i>_<i>delta</i>
      $output .= theme('block', $block);
Dries's avatar
   
Dries committed
931
932
    }
  }
933
934
935
936

  // Add any content assigned to this region through drupal_set_content() calls.
  $output .= drupal_get_content($region);

Dries's avatar
   
Dries committed
937
  return $output;
Dries's avatar
   
Dries committed
938
}
939

940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
/**
 * Format a username.
 *
 * @param $object
 *   The user object to format, usually returned from user_load().
 * @return
 *   A string containing an HTML link to the user's page if the passed object
 *   suggests that this is a site user. Otherwise, only the username is returned.
 */
function theme_username($object) {

  if ($object->uid && $object->name) {
    // Shorten the name when it is too long or it will break many tables.
    if (drupal_strlen($object->name) > 20) {
      $name = drupal_substr($object->name, 0, 15) .'...';
    }
    else {
      $name = $object->name;
    }

    if (user_access('access user profiles')) {
      $output = l($name, 'user/'. $object->uid, array('title' => t('View user profile.')));
    }
    else {
964
      $output = check_plain($name);
965
966
967
968
969
970
971
972
    }
  }
  else if ($object->name) {
    // Sometimes modules display content composed by people who are
    // not registered members of the site (e.g. mailing list or news
    // aggregator modules). This clause enables modules to display
    // the true author of the content.
    if ($object->homepage) {
973
      $output = l($object->name, $object->homepage);
974
975
    }
    else {
976
      $output = check_plain($object->name);
977
978
979
980
981
982
983
984
985
986
    }

    $output .= ' ('. t('not verified') .')';
  }
  else {
    $output = variable_get('anonymous', 'Anonymous');
  }

  return $output;
}
987

988
989
990
991
992
993
994
995
996
997
function theme_progress_bar($percent, $message) {
  $output = '<div id="progress" class="progress">';
  $output .= '<div class="percentage">'. $percent .'%</div>';
  $output .= '<div class="status">'. $message .'</div>';
  $output .= '<div class="bar"><div class="filled" style="width: '. $percent .'%"></div></div>';
  $output .= '</div>';

  return $output;
}

998
/**
Dries's avatar
   
Dries committed
999
 * @} End of "defgroup themeable".
1000
 */
1001

Dries's avatar
   
Dries committed
1002
function _theme_table_cell($cell, $header = 0) {
Dries's avatar
   
Dries committed
1003
1004
  $attributes = '';

Dries's avatar
   
Dries committed
1005
  if (is_array($cell)) {
Dries's avatar
   
Dries committed
1006
    $data = $cell['data'];
Dries's avatar
   
Dries committed
1007
    foreach ($cell as $key => $value) {
Dries's avatar
   
Dries committed
1008
      if ($key != 'data')  {
Dries's avatar
   
Dries committed
1009
        $attributes .= " $key=\"$value\"";
Dries's avatar
   
Dries committed
1010
1011
      }
    }
Dries's avatar
   
Dries committed
1012
  }
Dries's avatar
   
Dries committed
1013
1014
  else {
    $data = $cell;
Dries's avatar
   
Dries committed
1015
  }
Dries's avatar
   
Dries committed
1016

Dries's avatar
   
Dries committed
1017
1018
  if ($header) {
    $output = "<th$attributes>$data</th>";
Dries's avatar
   
Dries committed
1019
  }
Dries's avatar
   
Dries committed
1020
1021
  else {
    $output = "<td$attributes>$data</td>";
Dries's avatar
   
Dries committed
1022
  }
Dries's avatar
   
Dries committed
1023

Dries's avatar
   
Dries committed
1024
1025
  return $output;
}
1026