tims-todo/system/core/Lang.php

204 lines
5.3 KiB
PHP
Raw Permalink Normal View History

<?php
2014-08-08 15:41:59 -04:00
/**
* CodeIgniter
*
* An open source application development framework for PHP
2014-08-08 15:41:59 -04:00
*
* This content is released under the MIT License (MIT)
*
* Copyright (c) 2014 - 2019, British Columbia Institute of Technology
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
* @package CodeIgniter
* @author EllisLab Dev Team
* @copyright Copyright (c) 2008 - 2014, EllisLab, Inc. (https://ellislab.com/)
* @copyright Copyright (c) 2014 - 2019, British Columbia Institute of Technology (https://bcit.ca/)
* @license https://opensource.org/licenses/MIT MIT License
* @link https://codeigniter.com
* @since Version 1.0.0
2014-08-08 15:41:59 -04:00
* @filesource
*/
defined('BASEPATH') OR exit('No direct script access allowed');
2014-08-08 15:41:59 -04:00
/**
* Language Class
*
* @package CodeIgniter
* @subpackage Libraries
* @category Language
* @author EllisLab Dev Team
* @link https://codeigniter.com/user_guide/libraries/language.html
2014-08-08 15:41:59 -04:00
*/
class CI_Lang {
/**
* List of translations
*
* @var array
2014-08-08 15:41:59 -04:00
*/
public $language = array();
2014-08-08 15:41:59 -04:00
/**
* List of loaded language files
*
* @var array
2014-08-08 15:41:59 -04:00
*/
public $is_loaded = array();
2014-08-08 15:41:59 -04:00
/**
* Class constructor
2014-08-08 15:41:59 -04:00
*
* @return void
2014-08-08 15:41:59 -04:00
*/
public function __construct()
2014-08-08 15:41:59 -04:00
{
log_message('info', 'Language Class Initialized');
2014-08-08 15:41:59 -04:00
}
// --------------------------------------------------------------------
/**
* Load a language file
*
* @param mixed $langfile Language file name
* @param string $idiom Language name (english, etc.)
* @param bool $return Whether to return the loaded array of translations
* @param bool $add_suffix Whether to add suffix to $langfile
* @param string $alt_path Alternative path to look for the language file
*
* @return void|string[] Array containing translations, if $return is set to TRUE
2014-08-08 15:41:59 -04:00
*/
public function load($langfile, $idiom = '', $return = FALSE, $add_suffix = TRUE, $alt_path = '')
2014-08-08 15:41:59 -04:00
{
if (is_array($langfile))
{
foreach ($langfile as $value)
{
$this->load($value, $idiom, $return, $add_suffix, $alt_path);
}
return;
}
2014-08-08 15:41:59 -04:00
$langfile = str_replace('.php', '', $langfile);
if ($add_suffix === TRUE)
2014-08-08 15:41:59 -04:00
{
$langfile = preg_replace('/_lang$/', '', $langfile).'_lang';
2014-08-08 15:41:59 -04:00
}
$langfile .= '.php';
if (empty($idiom) OR ! preg_match('/^[a-z_-]+$/i', $idiom))
2014-08-08 15:41:59 -04:00
{
$config =& get_config();
$idiom = empty($config['language']) ? 'english' : $config['language'];
2014-08-08 15:41:59 -04:00
}
if ($return === FALSE && isset($this->is_loaded[$langfile]) && $this->is_loaded[$langfile] === $idiom)
{
return;
}
2014-08-08 15:41:59 -04:00
// Load the base file, so any others found can override it
$basepath = BASEPATH.'language/'.$idiom.'/'.$langfile;
if (($found = file_exists($basepath)) === TRUE)
2014-08-08 15:41:59 -04:00
{
include($basepath);
2014-08-08 15:41:59 -04:00
}
// Do we have an alternative path to look in?
if ($alt_path !== '')
2014-08-08 15:41:59 -04:00
{
$alt_path .= 'language/'.$idiom.'/'.$langfile;
if (file_exists($alt_path))
{
include($alt_path);
$found = TRUE;
}
2014-08-08 15:41:59 -04:00
}
else
{
foreach (get_instance()->load->get_package_paths(TRUE) as $package_path)
{
$package_path .= 'language/'.$idiom.'/'.$langfile;
if ($basepath !== $package_path && file_exists($package_path))
2014-08-08 15:41:59 -04:00
{
include($package_path);
2014-08-08 15:41:59 -04:00
$found = TRUE;
break;
}
}
}
if ($found !== TRUE)
{
show_error('Unable to load the requested language file: language/'.$idiom.'/'.$langfile);
}
2014-08-08 15:41:59 -04:00
if ( ! isset($lang) OR ! is_array($lang))
2014-08-08 15:41:59 -04:00
{
log_message('error', 'Language file contains no data: language/'.$idiom.'/'.$langfile);
if ($return === TRUE)
{
return array();
}
2014-08-08 15:41:59 -04:00
return;
}
if ($return === TRUE)
2014-08-08 15:41:59 -04:00
{
return $lang;
}
$this->is_loaded[$langfile] = $idiom;
2014-08-08 15:41:59 -04:00
$this->language = array_merge($this->language, $lang);
log_message('info', 'Language file loaded: language/'.$idiom.'/'.$langfile);
2014-08-08 15:41:59 -04:00
return TRUE;
}
// --------------------------------------------------------------------
/**
* Language line
2014-08-08 15:41:59 -04:00
*
* Fetches a single line of text from the language array
*
* @param string $line Language line key
* @param bool $log_errors Whether to log an error message if the line is not found
* @return string Translation
2014-08-08 15:41:59 -04:00
*/
public function line($line, $log_errors = TRUE)
2014-08-08 15:41:59 -04:00
{
$value = isset($this->language[$line]) ? $this->language[$line] : FALSE;
2014-08-08 15:41:59 -04:00
// Because killer robots like unicorns!
if ($value === FALSE && $log_errors === TRUE)
2014-08-08 15:41:59 -04:00
{
log_message('error', 'Could not find the language line "'.$line.'"');
}
return $value;
}
}