chamilo
/
chamilo-lms
mirror of https://github.com/chamilo/chamilo-lms/tree/1.11.x
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Issue #306 - Adding a new library about internationalization issues. Currently it contains routines for date/time formatting.

Browse Source
skala
Ivan Tcholakov 17 years ago
parent 3659ea7fd4
commit 0cb59eb5a7
6 changed files with 190 additions and 8 deletions
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Show Stats Download Patch File Download Diff File
  1. 133
      main/inc/lib/internationalization.lib.php
  2. 46
      main/inc/lib/internationalization_internal.lib.php
  3. 1
      main/inc/lib/main_api.lib.php
  4. 6
      main/inc/lib/multibyte_string_functions.lib.php
  5. 6
      main/inc/lib/multibyte_string_functions_internal.lib.php
  6. 6
      main/inc/lib/text.lib.php

133
main/inc/lib/internationalization.lib.php
Unescape View File

@ -0,0 +1,133 @@
<?php
/**
* ==============================================================================
* File: internationalization.lib.php
* Main API extension library for Dokeos 1.8.6+ LMS
* A library implementing internationalization related functions.
* License: GNU/GPL version 2 or later (Free Software Foundation)
* @author: Ivan Tcholakov, ivantcholakov@gmail.com
* August 2009 - initial implementation.
* @package dokeos.library
* ==============================================================================
*/
/**
* ----------------------------------------------------------------------------
* Constants
* ----------------------------------------------------------------------------
*/
// Predefined date formats in Dokeos provided by the language sub-system.
// To be used as a parameter for the function api_format_date().
define('TIME_NO_SEC_FORMAT', 0); // 15:23
define('DATE_FORMAT_SHORT', 1); // 25.08.2009
define('DATE_FORMAT_LONG', 2); // Aug 25, 09
define('DATE_TIME_FORMAT_LONG', 3); // August 25, 2009 at 03:28 PM
/**
* ----------------------------------------------------------------------------
* Date and time formats
* ----------------------------------------------------------------------------
*/
/**
* Returns formated date/time format correspondent to a given language.
* @author Patrick Cool <patrick.cool@UGent.be>, Ghent University
* @author Christophe Gesche<gesche@ipm.ucl.ac.be>
* originally inspired from from PhpMyAdmin
* @author Ivan Tcholakov, 2009, code refactoring, adding support for predefined date/time formats.
* @param string/int $date_format The date pattern. See the php-manual about the function strftime().
* Note: For $date_format the following integer constants may be used for using predefined date/time
* formats in the Dokeos system: TIME_NO_SEC_FORMAT, DATE_FORMAT_SHORT, DATE_FORMAT_LONG, DATE_TIME_FORMAT_LONG.
* @param int $time_stamp (optional) Time as an integer value. The default value -1 means now, the function time() is called internally.
* @param string $language (optional) Language indentificator. If it is omited, the current interface language is assumed.
* @return string Returns the formatted date.
* @link http://php.net/manual/en/function.strftime.php
*/
function api_format_date($date_format, $time_stamp = -1, $language = null) {
if ($time_stamp == -1) {
$time_stamp = time();
}
if (is_int($date_format)) {
switch ($date_format) {
case TIME_NO_SEC_FORMAT:
$date_format = get_lang('timeNoSecFormat', '', $language);
break;
case DATE_FORMAT_SHORT:
$date_format = get_lang('dateFormatShort', '', $language);
break;
case DATE_FORMAT_LONG:
$date_format = get_lang('dateFormatShort', '', $language);
break;
case DATE_TIME_FORMAT_LONG:
$date_format = get_lang('dateTimeFormatLong', '', $language);
break;
default:
$date_format = get_lang('dateTimeFormatLong', '', $language);
}
}
// We replace %a %A %b %B masks of date format with translated strings.
$translated = &_api_get_day_month_names($language);
$date_format = str_replace(array('%A', '%a', '%B', '%b'),
array($translated['days_long'][(int)strftime('%w', $time_stamp)],
$translated['days_short'][(int)strftime('%w', $time_stamp)],
$translated['months_long'][(int)strftime('%m', $time_stamp) - 1],
$translated['months_short'][(int)strftime('%m', $time_stamp) - 1]),
$date_format);
return strftime($date_format, $time_stamp);
}
/**
* Returns an array of translated week days in short names.
* @param string $language (optional) Language indentificator. If it is omited, the current interface language is assumed.
* @return string Returns an array of week days (short names).
* Example: api_get_week_days_short('english') means array('Sun', 'Mon', ... 'Sat').
*/
function api_get_week_days_short($language = null) {
$days = &_api_get_day_month_names($language);
return $days['days_short'];
}
/**
* Returns an array of translated week days.
* @param string $language (optional) Language indentificator. If it is omited, the current interface language is assumed.
* @return string Returns an array of week days.
* Example: api_get_week_days_long('english') means array('Sunday, 'Monday', ... 'Saturday').
*/
function api_get_week_days_long($language = null) {
$days = &_api_get_day_month_names($language);
return $days['days_long'];
}
/**
* Returns an array of translated months in short names.
* @param string $language (optional) Language indentificator. If it is omited, the current interface language is assumed.
* @return string Returns an array of months (short names).
* Example: api_get_months_short('english') means array('Jan', 'Feb', ... 'Dec').
*/
function api_get_months_short($language = null) {
$months = &_api_get_day_month_names($language);
return $months['months_short'];
}
/**
* Returns an array of translated months.
* @param string $language (optional) Language indentificator. If it is omited, the current interface language is assumed.
* @return string Returns an array of months.
* Example: api_get_months_long('english') means array('January, 'February' ... 'December').
*/
function api_get_months_long($language = null) {
$months = &_api_get_day_month_names($language);
return $months['months_long'];
}
/**
* ----------------------------------------------------------------------------
* Functions for internal use behind this API.
* ----------------------------------------------------------------------------
*/
require_once dirname(__FILE__).'/internationalization_internal.lib.php';

46
main/inc/lib/internationalization_internal.lib.php
Unescape View File

@ -0,0 +1,46 @@
<?php
/**
* ==============================================================================
* File: internationalization_internal.lib.php
* Main API extension library for Dokeos 1.8.6+ LMS,
* contains functions for internal use only.
* License: GNU/GPL version 2 or later (Free Software Foundation)
* @author: Ivan Tcholakov, ivantcholakov@gmail.com, 2009
* @package dokeos.library
* ==============================================================================
*
* Note: All functions and data structures here are not to be used directly.
* See the file internationalization.lib.php which contains the "public" API.
*/
/**
* ----------------------------------------------------------------------------
* Appendix to "Date and time formats"
* ----------------------------------------------------------------------------
*/
/**
* Returns an array of translated week days and months, short and normal names.
* @param string $language (optional) Language indentificator. If it is omited, the current interface language is assumed.
* @return string Returns a multidimensional array with translated week days and months.
*/
function &_api_get_day_month_names($language = null) {
static $date_parts = array();
if (empty($language)) {
$language = api_get_interface_language();
}
if (!isset($date_parts[$language])) {
$week_day = array('Sunday', 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday');
$month = array('January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December');
for ($i = 0; $i < 7; $i++) {
$date_parts[$language]['days_short'][] = get_lang($week_day[$i].'Short', '', $language);
$date_parts[$language]['days_long'][] = get_lang($week_day[$i].'Long', '', $language);
}
for ($i = 0; $i < 12; $i++) {
$date_parts[$language]['months_short'][] = get_lang($month[$i].'Short', '', $language);
$date_parts[$language]['months_long'][] = get_lang($month[$i].'Long', '', $language);
}
}
return $date_parts[$language];
}

1
main/inc/lib/main_api.lib.php
Unescape View File

@ -199,6 +199,7 @@ define('LOG_CONFIGURATION_SETTINGS_VARIABLE', 'settings_variable');
*/
require_once dirname(__FILE__).'/multibyte_string_functions.lib.php';
require_once dirname(__FILE__).'/internationalization.lib.php';
/*
==============================================================================

6
main/inc/lib/multibyte_string_functions.lib.php
Unescape View File

@ -9,7 +9,7 @@
* October 2008 - initial implementation.
* May 2009 - refactoring and minor corrections have been implemented.
* August 2009 - PCRE-related functions have been added,
* dependancy on mbstring extension has been lowered.
* dependancy on mbstring extension has been removed.
* @package dokeos.library
* ==============================================================================
*/
@ -1149,7 +1149,7 @@ function api_strtolower($string, $encoding = null) {
$matched = true;
} else {
$matched = false;
$properties = _api_utf8_get_letter_case_properties($codepoint, 'upper');
$properties = &_api_utf8_get_letter_case_properties($codepoint, 'upper');
if (!empty($properties)) {
foreach ($properties as $key => $value) {
if ($properties[$key]['upper'] == $codepoint && count($properties[$key]['lower'][0]) === 1) {
@ -1215,7 +1215,7 @@ function api_strtoupper($string, $encoding = null) {
$matched = true;
} else {
$matched = false;
$properties = _api_utf8_get_letter_case_properties($codepoint);
$properties = &_api_utf8_get_letter_case_properties($codepoint);
$property_count = count($properties);
if (!empty($properties)) {
foreach ($properties as $key => $value) {

6
main/inc/lib/multibyte_string_functions_internal.lib.php
Unescape View File

@ -61,13 +61,13 @@ function _api_convert_encoding($string, $to_encoding, $from_encoding) {
return $string;
}
if (!isset($character_map[$to])) {
$character_map[$to] = _api_parse_character_map($to);
$character_map[$to] = &_api_parse_character_map($to);
}
if ($character_map[$to] === false) {
return $string;
}
if (!isset($character_map[$from])) {
$character_map[$from] = _api_parse_character_map($from);
$character_map[$from] = &_api_parse_character_map($from);
}
if ($character_map[$from] === false) {
return $string;
@ -372,7 +372,7 @@ function _api_html_entity_from_unicode($codepoint) {
* @param string $type (optional) The type of initial case to be altered: 'lower' (default) or 'upper'.
* @return array Returns an array with properties used to change case of the character.
*/
function _api_utf8_get_letter_case_properties($codepoint, $type = 'lower') {
function &_api_utf8_get_letter_case_properties($codepoint, $type = 'lower') {
static $config = array();
static $range = array();
if (!isset($range[$codepoint])) {

6
main/inc/lib/text.lib.php
Unescape View File

@ -61,8 +61,9 @@ function make_clickable($string)
* @return the formatted date
*/
function format_locale_date($date_format, $time_stamp = -1)
function format_locale_date($date_format, $time_stamp = -1, $language = null)
{
/*
static $initialized = false;
static $days_short, $days_long, $months_short, $months_long;
@ -91,7 +92,8 @@ function format_locale_date($date_format, $time_stamp = -1)
$date = ereg_replace('%[b]', $months_short[(int)strftime('%m', $time_stamp)-1], $date);
return strftime($date, $time_stamp);
*/
return api_format_date($date_format, $time_stamp, $language);
} // end function format_locale_date

Write Preview
Loading…
Cancel
Save