Gitiles
Code Review Sign In
www.giggi.me / code-igniter-v3-giggi / dcafe89f348697d273e21a2d451a99ba8c6ec68f / . / user_guide / libraries / language.html
blob: 6067fe501e9a1b571e8c0145d2597f3347116c9f [file] [log] [blame]
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2<html>
3<head>
4
5<title>Code Igniter User Guide</title>
6
7<style type='text/css' media='all'>@import url('../userguide.css');</style>
8<link rel='stylesheet' type='text/css' media='all' href='../userguide.css' />
9
10<script type="text/javascript" src="../scripts/nav.js"></script>
11<script type="text/javascript" src="../scripts/prototype.lite.js"></script>
12<script type="text/javascript" src="../scripts/moo.fx.js"></script>
13<script type="text/javascript">
14window.onload = function() {
15 myHeight = new fx.Height('nav', {duration: 400});
16 myHeight.hide();
17}
18</script>
19
20<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
21<meta http-equiv='expires' content='-1' />
22<meta http-equiv= 'pragma' content='no-cache' />
23<meta name='robots' content='all' />
24<meta name='author' content='Rick Ellis' />
25<meta name='description' content='Code Igniter User Guide' />
26
27</head>
28<body>
29
30<!-- START NAVIGATION -->
31<div id="nav"><div id="nav_inner"><script type="text/javascript">create_menu('../');</script></div></div>
32<div id="nav2"><a name="top"></a><a href="javascript:void(0);" onclick="myHeight.toggle();"><img src="../images/nav_toggle.jpg" width="153" height="44" border="0" title="Toggle Table of Contents" alt="Toggle Table of Contents" /></a></div>
33<div id="masthead">
34<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
35<tr>
admin41a16852006-09-26 18:17:19 +0000[diff] [blame]36<td><h1>Code Igniter User Guide Version 1.5.0</h1></td>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]37<td id="breadcrumb_right"><a href="../toc.html">Full Table of Contents</a></td>
38</tr>
39</table>
40</div>
41<!-- END NAVIGATION -->
42
43
44<!-- START BREADCRUMB -->
45<table cellpadding="0" cellspacing="0" border="0" style="width:100%">
46<tr>
47<td id="breadcrumb">
48<a href="http://www.codeigniter.com/">Code Igniter Home</a> &nbsp;&#8250;&nbsp;
49<a href="../index.html">User Guide Home</a> &nbsp;&#8250;&nbsp;
50Language Class
51</td>
52<td id="searchbox"><form method="get" action="http://www.google.com/search"><input type="hidden" name="as_sitesearch" id="as_sitesearch" value="www.codeigniter.com/user_guide/" />Search User Guide&nbsp; <input type="text" class="input" style="width:200px;" name="q" id="q" size="31" maxlength="255" value="" />&nbsp;<input type="submit" class="submit" name="sa" value="Go" /></form></td>
53</tr>
54</table>
55<!-- END BREADCRUMB -->
56
57<br clear="all" />
58
59
60<!-- START CONTENT -->
61<div id="content">
62
63
64<h1>Language Class</h1>
65
66<p>The Language Class provides functions to retrieve language files and lines of text for purposes of internationalization.</p>
67
68<p>In your Code Igniter system folder you'll find one called <dfn>language</dfn> containing sets of language files. You can create
69your own language files as needed in order to display error and other messages in other languages.</p>
70
adminfffef542006-09-20 23:39:28 +0000[diff] [blame]71<p>Language files are typically stored in your <dfn>system/language</dfn> directory. Alternately you can create a folder called <kbd>language</kbd> inside
72your <kbd>application</kbd> folder and store them there. Code Igniter will look first in your <dfn>system/application/language</dfn>
73directory. If the direcotry does not exist or the specified language is not located there CI will instead look in your global
74<dfn>system/language</dfn> folder.</p>
75
76<p class="important"><strong>Note:</strong>&nbsp; Each language should be stored in its own folder. For example, the English files are located at:
77<dfn>system/language/english</dfn></p>
78
79
80
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]81<h2>Creating Language Files</h2>
82
83<p>Language files must be named with <kbd>_lang.php</kbd> as the file extension. For example, let's say you want to create a file
84containing error messages. You might name it: <kbd>error_lang.php</kbd></p>
85
86<p>Within the file you will assign each line of text to an array called <var>$lang</var> with this prototype:</p>
87
88<code>$lang['language_key'] = "The actual message to be shown";</code>
89
90<p><strong>Note:</strong> It's a good practice to use a common prefix for all messages in a given file to avoid collisions with
adminfffef542006-09-20 23:39:28 +0000[diff] [blame]91similarly named items in other files. For example, if you are creating error messages you might prefix them with <var>error_</var></p>
adminb0dd10f2006-08-25 17:25:49 +0000[diff] [blame]92
93<code>$lang['<var>error</var>_email_missing'] = "You must submit an email address";<br />
94$lang['<var>error</var>_url_missing'] = "You must submit a URL";<br />
95$lang['<var>error</var>_username_missing'] = "You must submit a username";</code>
96
97
98<h2>Loading A Language File</h2>
99
100<p>In order to fetch a line from a particular file you must load the file first. Loading a language file is done with the following code:</p>
101
102<code>$this->lang->load('<samp>filename</samp>', '<dfn>language</dfn>');</code>
103
104<p>Where <samp>filename</samp> is the name of the file you wish to load (without the file extension), and <dfn>language</dfn>
105is the language set containing it (ie, english). If the second parameter is missing, the default language set in your
106<kbd>application/config/config.php</kbd> file will be used.</p>
107
108
109<h2>Fetching a Line of Text</h2>
110
111<p>Once your desired language file is loaded you can access any line of text using this function:</p>
112
113<code>$this->lang->line('<samp>language_key</samp>');</code>
114
115<p>Where <samp>language_key</samp> is the array key corresponding to the line you wish to show.</p>
116
117<p>Note: This function simply returns the line. It does not echo it for you.</p>
118
119
120
121
122
123
124</div>
125<!-- END CONTENT -->
126
127
128<div id="footer">
129<p>
130Previous Topic:&nbsp;&nbsp;<a href="loader.html">Loader Class</a>
131&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
132<a href="#top">Top of Page</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
133<a href="../index.html">User Guide Home</a>&nbsp;&nbsp;&nbsp;&middot;&nbsp;&nbsp;
134Next Topic:&nbsp;&nbsp;<a href="output.html">Output Class</a>
135<p>
136<p><a href="http://www.codeigniter.com">Code Igniter</a> &nbsp;&middot;&nbsp; Copyright &#169; 2006 &nbsp;&middot;&nbsp; <a href="http://www.pmachine.com">pMachine, Inc.</a></p>
137</div>
138
139</body>
140</html>