blob: e03afb07d88d062c82504909244612184a3a6e7c [file] [log] [blame]
Derek Jones37f4b9c2011-07-01 17:56:50 -05001<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');
Derek Allard2067d1a2008-11-13 22:59:24 +00002/**
3 * CodeIgniter
4 *
Greg Aker741de1c2010-11-10 14:52:57 -06005 * An open source application development framework for PHP 5.1.6 or newer
Derek Allard2067d1a2008-11-13 22:59:24 +00006 *
Derek Jonesf4a4bd82011-10-20 12:18:42 -05007 * NOTICE OF LICENSE
8 *
9 * Licensed under the Open Software License version 3.0
10 *
11 * This source file is subject to the Open Software License (OSL 3.0) that is
12 * bundled with this package in the files license.txt / license.rst. It is
13 * also available through the world wide web at this URL:
14 * http://opensource.org/licenses/OSL-3.0
15 * If you did not receive a copy of the license and are unable to obtain it
16 * through the world wide web, please send an email to
17 * licensing@ellislab.com so we can send you a copy immediately.
18 *
Derek Allard2067d1a2008-11-13 22:59:24 +000019 * @package CodeIgniter
Derek Jonesf4a4bd82011-10-20 12:18:42 -050020 * @author EllisLab Dev Team
21 * @copyright Copyright (c) 2008 - 2011, EllisLab, Inc. (http://ellislab.com/)
22 * @license http://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
Derek Allard2067d1a2008-11-13 22:59:24 +000023 * @link http://codeigniter.com
24 * @since Version 1.0
25 * @filesource
26 */
27
28// ------------------------------------------------------------------------
29
30/**
31 * Language Class
32 *
33 * @package CodeIgniter
34 * @subpackage Libraries
35 * @category Language
Derek Jonesf4a4bd82011-10-20 12:18:42 -050036 * @author EllisLab Dev Team
Derek Allard2067d1a2008-11-13 22:59:24 +000037 * @link http://codeigniter.com/user_guide/libraries/language.html
38 */
Derek Jones692c5482010-03-02 13:39:48 -060039class CI_Lang {
Derek Allard2067d1a2008-11-13 22:59:24 +000040
David Behlercda768a2011-08-14 23:52:48 +020041 /**
42 * List of translations
43 *
44 * @var array
45 */
Derek Allard2067d1a2008-11-13 22:59:24 +000046 var $language = array();
David Behlercda768a2011-08-14 23:52:48 +020047 /**
48 * List of loaded language files
49 *
50 * @var array
51 */
Derek Allard2067d1a2008-11-13 22:59:24 +000052 var $is_loaded = array();
53
54 /**
55 * Constructor
56 *
57 * @access public
58 */
Greg Akera9263282010-11-10 15:26:43 -060059 function __construct()
Derek Allard2067d1a2008-11-13 22:59:24 +000060 {
61 log_message('debug', "Language Class Initialized");
62 }
63
64 // --------------------------------------------------------------------
65
66 /**
67 * Load a language file
68 *
69 * @access public
70 * @param mixed the name of the language file to be loaded. Can be an array
71 * @param string the language (english, etc.)
David Behlercda768a2011-08-14 23:52:48 +020072 * @param bool return loaded array of translations
73 * @param bool add suffix to $langfile
74 * @param string alternative path to look for language file
Derek Allard2067d1a2008-11-13 22:59:24 +000075 * @return mixed
76 */
Derek Jones692c5482010-03-02 13:39:48 -060077 function load($langfile = '', $idiom = '', $return = FALSE, $add_suffix = TRUE, $alt_path = '')
Derek Allard2067d1a2008-11-13 22:59:24 +000078 {
Greg Aker3a746652011-04-19 10:59:47 -050079 $langfile = str_replace('.php', '', $langfile);
Derek Jones692c5482010-03-02 13:39:48 -060080
81 if ($add_suffix == TRUE)
82 {
83 $langfile = str_replace('_lang.', '', $langfile).'_lang';
84 }
85
Greg Aker3a746652011-04-19 10:59:47 -050086 $langfile .= '.php';
Derek Allard2067d1a2008-11-13 22:59:24 +000087
88 if (in_array($langfile, $this->is_loaded, TRUE))
89 {
90 return;
91 }
92
Derek Jones692c5482010-03-02 13:39:48 -060093 $config =& get_config();
94
Derek Allard2067d1a2008-11-13 22:59:24 +000095 if ($idiom == '')
96 {
Derek Jones692c5482010-03-02 13:39:48 -060097 $deft_lang = ( ! isset($config['language'])) ? 'english' : $config['language'];
Derek Allard2067d1a2008-11-13 22:59:24 +000098 $idiom = ($deft_lang == '') ? 'english' : $deft_lang;
99 }
100
101 // Determine where the language file is and load it
Derek Jones692c5482010-03-02 13:39:48 -0600102 if ($alt_path != '' && file_exists($alt_path.'language/'.$idiom.'/'.$langfile))
103 {
104 include($alt_path.'language/'.$idiom.'/'.$langfile);
105 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000106 else
107 {
Phil Sturgeonde3dbc32010-12-27 17:41:02 +0000108 $found = FALSE;
109
110 foreach (get_instance()->load->get_package_paths(TRUE) as $package_path)
Derek Allard2067d1a2008-11-13 22:59:24 +0000111 {
Phil Sturgeonde3dbc32010-12-27 17:41:02 +0000112 if (file_exists($package_path.'language/'.$idiom.'/'.$langfile))
113 {
114 include($package_path.'language/'.$idiom.'/'.$langfile);
115 $found = TRUE;
116 break;
117 }
Derek Allard2067d1a2008-11-13 22:59:24 +0000118 }
Phil Sturgeonde3dbc32010-12-27 17:41:02 +0000119
120 if ($found !== TRUE)
Derek Allard2067d1a2008-11-13 22:59:24 +0000121 {
Derek Allardea9e4e02009-08-17 17:40:48 +0000122 show_error('Unable to load the requested language file: language/'.$idiom.'/'.$langfile);
Derek Allard2067d1a2008-11-13 22:59:24 +0000123 }
124 }
125
Derek Jones692c5482010-03-02 13:39:48 -0600126
Frank Michelcb272b62011-08-25 10:59:55 -0400127 if ( ! isset($lang) OR ! is_array($lang))
Derek Allard2067d1a2008-11-13 22:59:24 +0000128 {
129 log_message('error', 'Language file contains no data: language/'.$idiom.'/'.$langfile);
130 return;
131 }
132
133 if ($return == TRUE)
134 {
135 return $lang;
136 }
137
138 $this->is_loaded[] = $langfile;
Frank Michel373043f2011-08-25 00:11:00 -0400139 $this->language = $this->language + $lang;
Derek Allard2067d1a2008-11-13 22:59:24 +0000140 unset($lang);
141
142 log_message('debug', 'Language file loaded: language/'.$idiom.'/'.$langfile);
143 return TRUE;
144 }
145
146 // --------------------------------------------------------------------
147
148 /**
149 * Fetch a single line of text from the language array
150 *
151 * @access public
Barry Mienydd671972010-10-04 16:33:58 +0200152 * @param string $line the language line
Derek Allard2067d1a2008-11-13 22:59:24 +0000153 * @return string
154 */
155 function line($line = '')
156 {
patwork571023b2011-04-11 11:56:41 +0200157 $value = ($line == '' OR ! isset($this->language[$line])) ? FALSE : $this->language[$line];
Eric Barnese3c41cf2011-03-21 22:07:53 -0400158
159 // Because killer robots like unicorns!
patwork571023b2011-04-11 11:56:41 +0200160 if ($value === FALSE)
Eric Barnese3c41cf2011-03-21 22:07:53 -0400161 {
162 log_message('error', 'Could not find the language line "'.$line.'"');
163 }
164
patwork571023b2011-04-11 11:56:41 +0200165 return $value;
Derek Allard2067d1a2008-11-13 22:59:24 +0000166 }
167
168}
169// END Language Class
170
Derek Jones692c5482010-03-02 13:39:48 -0600171/* End of file Lang.php */
patwork571023b2011-04-11 11:56:41 +0200172/* Location: ./system/core/Lang.php */