locale.module 5.46 KB
Newer Older
Dries's avatar
   
Dries committed
1
<?php
Dries's avatar
   
Dries committed
2

Dries's avatar
   
Dries committed
3
4
5
$module = array("help" => "locale_help",
                "admin" => "locale_admin",
                "locale" => "locale_locale");
Dries's avatar
   
Dries committed
6

Dries's avatar
   
Dries committed
7
function locale_help() {
Dries's avatar
   
Dries committed
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
 ?>
  <P>Normally programs are written and documented in English, and use English to interact with users.  This is true for a great deal of websites.  However, most people are less comfortable with English than with their own native language, and would prefer to use their mother tongue as much as possible.  Many people love see their website showing a lot less of English, and far more of their own language.</P>
  <P>Therefore drupal provides a framework to setup a multi-lingual website, or to overwrite the default texts in English.  We explored the various alternatives to support internationalization and decided to design the framework in such a way that the impact of internationalization on drupal's sources is minimized, modular and that it doesn't require a HTML or PHP wizard to maintain translations.  Maintaining translations had to be simple so it became as easy as filling out forms on the administration page.  A side effect is that translation support adds significant overhead to the dynamic generation of your website.  If you don't need translation support, consider to turn it off.</P>

  <H3>Adding a new language</H3>

  <P>Adding a new language requires you to edit your configuration file and to edit your SQL database.  Assuming you want to support Dutch (ISO 639 code: "nl") and French (ISO 639 code: "fr"), you add the following line to your configuration file's <CODE>$languages</CODE>-variable:</P>
  <PRE>
    $languages = array("nl" => "Dutch / Nederlands", "fr" => "French / Francais");
  </PRE>
  <P>Note that the default language must come first and that if you want to overwrite the default text you can add an entry for English (ISO 639 code: "en"):</P>
  <PRE>
    $languages = array("en" => "English", "nl" => "Dutch / Nederlands", "fr" => "French / Francais");
  </PRE>
  <P>After having edited your configuration file, make sure your SQL table "locales" has the required database fields setup to host your new translations.  You can add the required rows to your "locales" table from the MySQL prompt:</P>
  <PRE>
    mysql> ALTER TABLE locales ADD en TEXT DEFAULT '' NOT NULL;
    mysql> ALTER TABLE locales ADD nl TEXT DEFAULT '' NOT NULL;
    mysql> ALTER TABLE locales ADD fr TEXT DEFAULT '' NOT NULL;
  </PRE>
Dries's avatar
   
Dries committed
28
 <?php
Dries's avatar
   
Dries committed
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
}

function locale_delete($id) {
  db_query("DELETE FROM locales WHERE id = '$id'");
}

function locale_save($id, $edit) {
  foreach ($edit as $key=>$value) {
    db_query("UPDATE locales SET $key = '". check_input($value) ."' WHERE id = '$id'");
  }
}

function locale_edit($id) {
  global $languages;
  $result = db_query("SELECT * FROM locales WHERE id = '$id'");
  if ($translation = db_fetch_object($result)) {
    $output .= "<FORM ACTION=\"admin.php?mod=locale\" METHOD=\"post\">\n";
    $output .= "<B>Original string:</B><BR>\n";
Dries's avatar
   
Dries committed
47
    $output .= "<PRE>". wordwrap(check_output($translation->string)) ."</PRE><P>";
Dries's avatar
   
Dries committed
48
49
    foreach ($languages as $code=>$language) {
      $output .= "<B>$language:</B><BR>";
Dries's avatar
   
Dries committed
50
      $output .= (strlen($translation->string) > 30) ? "<TEXTAREA WRAP=\"virtual\" COLS=\"50\" ROWS=\"10\" NAME=\"edit[$code]\">". check_textarea($translation->$code) ."</TEXTAREA><P>" : "<INPUT TYPE=\"text\" NAME=\"edit[$code]\" SIZE=\"50\" VALUE=\"". check_textfield($translation->$code) ."\"><P>";
Dries's avatar
   
Dries committed
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
    }
    $output .= "<INPUT NAME=\"id\" TYPE=\"hidden\" VALUE=\"$id\">\n";
    $output .= "<INPUT NAME=\"op\" TYPE=\"submit\" VALUE=\"Save translations\">\n";
    $output .= "</FORM>\n";

    print $output;
  }
}

function locale_languages($translation) {
  global $languages;
  foreach ($languages as $key=>$value) {
    $output .= ($translation->$key) ? "$key " : "<STRIKE>$key</STRIKE> ";
  }
  return $output;
}

Dries's avatar
   
Dries committed
68
function locale_overview() {
Dries's avatar
   
Dries committed
69
  $result = db_query("SELECT * FROM locales ORDER BY string");
Dries's avatar
Dries committed
70
  $output .= "<TABLE BORDER=\"1\" CELLPADDING=\"2\" CELLSPACING=\"2\">\n";
Dries's avatar
   
Dries committed
71
  $output .= " <TR><TH>string</TH><TH>languages</TH><TH COLSPAN=\"2\">operations</TH><TR>\n";
Dries's avatar
   
Dries committed
72
  while ($locale = db_fetch_object($result)) {
Dries's avatar
   
Dries committed
73
74
    $languages = locale_languages($locale);
    $output .= " <TR><TD>". check_output($locale->string) ."<BR><SMALL><I>$locale->location</I></SMALL></TD><TD ALIGN=\"center\">$languages</TD><TD><A HREF=\"admin.php?mod=locale&op=edit&id=$locale->id\">edit</A></TD><TD><A HREF=\"admin.php?mod=locale&op=delete&id=$locale->id\">delete</A></TD></TR>";
Dries's avatar
   
Dries committed
75
  }
Dries's avatar
Dries committed
76
77
  $output .= "</TABLE>\n";
  print $output;
Dries's avatar
   
Dries committed
78
79
}

Dries's avatar
   
Dries committed
80
81
82
83
84
85
86
function locale_admin() {
  global $id, $edit, $op;

  print "<SMALL><A HREF=\"admin.php?mod=locale\">overview</A> | <A HREF=\"admin.php?mod=locale&op=help\">help</A></SMALL><HR>\n";

  switch ($op) {
    case "delete":
Dries's avatar
   
Dries committed
87
      locale_delete(check_input($id));
Dries's avatar
   
Dries committed
88
      locale_overview();
Dries's avatar
   
Dries committed
89
90
91
92
93
      break;
    case "help":
      locale_help();
      break;
    case "edit":
Dries's avatar
   
Dries committed
94
      locale_edit(check_input($id));
Dries's avatar
   
Dries committed
95
96
      break;
    case "Save translations":
Dries's avatar
   
Dries committed
97
      locale_save(check_input($id), $edit);
Dries's avatar
   
Dries committed
98
99
      // fall through
    default:
Dries's avatar
   
Dries committed
100
      locale_overview();
Dries's avatar
   
Dries committed
101
102
103
104
105
  }
}

function locale($string) {
  global $locale;
Dries's avatar
Dries committed
106
107
108
109
110
  if ($locale) {
    $result = db_query("SELECT id, $locale FROM locales WHERE STRCMP(string, '". addslashes($string) ."') = 0");
    if ($translation = db_fetch_object($result)) $string = ($translation->$locale) ? check_output($translation->$locale) : $string;
    else db_query("INSERT INTO locales (string, location) VALUES ('". addslashes($string) ."', '". check_input(getenv("REQUEST_URI")) ."')");
  }
Dries's avatar
   
Dries committed
111
112
113
114
  return $string;
}

?>