tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

bfojcapell: Renaming of functions and new function prototype of the translator function

Browse Source 
(merged from branches/gsoc)


git-svn-id: svn://svn.silverstripe.com/silverstripe/open/modules/sapphire/trunk@41835 467b73ca-7a2a-4603-9d3b-597d59a354a9
This commit is contained in:
Ingo Schommer 2007-09-15 00:21:51 +00:00
parent 3444cf28e8
commit 0872f87358
4 changed files with 254 additions and 247 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
_config.php
View File

@ -56,5 +56,5 @@ Authenticator::registerAuthenticator('OpenIDAuthenticator');
/**
* Define a default language different than english
*/
//LocaleAPI::setLocale('ca_AD');
//LocaleAPI::set_locale('ca_AD');
?>

23
core/Core.php
View File

@ -86,8 +86,8 @@ function stripslashes_recursively(&$array) {
/**
* This is the main translator function. Returns the string defined by $class and $entity according to the currently set locale
*
* @param string $class Class where the entity was defined. It acts as a namespace.
* @param string $entity Entity that identifies the string inside the namespace.
* @param string $entity Entity that identifies the string. It must be in the form "Namespace.Entity" where Namespace will be usually
* the class name where this string is used and Entity identifies the string inside the namespace.
* @param string $string The original string itself. In a usual call this is a mandatory parameter, but if you are reusing a string which
* has already been "declared" (using another call to this function, with the same class and entity), you can omit it.
* @param string $priority Optional parameter to set a translation priority. If a string is widely used, should have a high priority (PR_HIGH),
@ -95,19 +95,16 @@ function stripslashes_recursively(&$array) {
* You can use PR_MEDIUM as well. Leaving this field blank will be interpretated as a "normal" priority (less than PR_MEDIUM).
* @param string $context If the string can be difficult to translate by any reason, you can help translators with some more info using this param
*
* @return string The translated string, according to the currently set locale {@link i18n::setLocale()}
* @return string The translated string, according to the currently set locale {@link i18n::set_locale()}
*/
function _($class, $entity, $string = "", $priority = 40, $context = "") {
function _t($entity, $string = "", $priority = 40, $context = "") {
global $lang;
$locale = i18n::getLocale();
$class = ereg_replace('.*([/\\]+)', "", $class);
if(substr($class, -4) == '.php')
$class = substr($class, 0, -4);
if(isset($lang[$locale][$class]) == false)
i18n::includeByClass($class);
$transEntity = $lang[i18n::getLocale()][$class][$entity];
$locale = i18n::get_locale();
$entityParts = explode('.',$entity);
$realEntity = array_pop($entityParts);
$class = implode('.',$entityParts);
if(!isset($lang[$locale][$class])) i18n::include_by_class($class);
$transEntity = $lang[i18n::get_locale()][$class][$realEntity];
return (is_array($transEntity) ? $transEntity[0] : $transEntity);
}

7
core/SSViewer.php
View File

@ -154,7 +154,7 @@ class SSViewer extends Object {
if(isset($_GET['debug_profile'])) Profiler::mark("SSViewer::process - compile", " for $template");
$content = file_get_contents($template);
$content = SSViewer::parseTemplateContent($content, $template);
$content = SSViewer::parseTemplateContent($content);
$fh = fopen($cacheFile,'w');
fwrite($fh, $content);
@ -199,7 +199,7 @@ class SSViewer extends Object {
return $output;
}
static function parseTemplateContent($content, $template="") {
static function parseTemplateContent($content) {
while(true) {
$oldContent = $content;
$content = preg_replace_callback('/<' . '% include +([A-Za-z0-9_]+) +%' . '>/', create_function(
@ -282,8 +282,7 @@ class SSViewer extends Object {
$content = ereg_replace('<' . '% +end_if +%' . '>', '<? } ?>', $content);
// i18n
ereg('.*[\/](.*)',$template,$path);
$content = ereg_replace('<' . '% +_\(([^)]*)\) +%' . '>', '<?= _(\''.$path[1].'\',\\1) ?>', $content);
$content = ereg_replace('<' . '% +_t\((([^)]|\)[^;])*)\); +%' . '>', '<?= _t(\\1) ?>', $content);
// </base> isnt valid html? !?
$content = ereg_replace('<' . '% +base_tag +%' . '>', '<base href="<?= Director::absoluteBaseURL(); ?>" />', $content);

101
core/i18n.php
View File

@ -16,16 +16,16 @@ define('PR_LOW',10);
class i18n extends Controller {
/**
* This static variable is used to store the current defined locale. Default value is 'en'
* This static variable is used to store the current defined locale. Default value is 'en_US'
*/
static $currentlocale = 'en';
static $currentlocale = 'en_US';
/**
* This is the main method to build the master string tables with the original strings.
* It will search for existent modules that use the i18n feature, parse the _() calls
* and write the resultant files in the lang folder of each module.
*/
static function textCollector() {
static function text_collector() {
if (!Permission::check("ADMIN")) die("You must be an admin to enable text collector mode");
echo "Collecting text...<br /><br />";
@ -37,10 +37,10 @@ class i18n extends Controller {
if (!isset($_GET['module'])) {
$topLevel = scandir($baseDir);
foreach($topLevel as $module) {
i18n::processModule($baseDir, $module);
i18n::process_module($baseDir, $module);
}
} else {
i18n::processModule($baseDir, $_GET['module']);
i18n::process_module($baseDir, $_GET['module']);
}
echo "Done!";
@ -53,16 +53,17 @@ class i18n extends Controller {
* @param string $baseDir Silverstripe's base directory
* @param string $module Module's name
*/
private static function processModule($baseDir, $module) {
private static function process_module($baseDir, $module) {
if(is_dir("$baseDir/$module") && !in_array($module, array('sapphire','jsparty','assets')) && substr($module,0,1) != '.') {
i18n::getFilesRec("$baseDir/$module/code", $fileList);
foreach($fileList as $index => $file) {
$mst .= i18n::reportCallsCode($index, $file);
i18n::get_files_rec("$baseDir/$module/code", $fileList);
$mst = '';
foreach($fileList as $file) {
$mst .= i18n::report_calls_code($file);
}
$fileList = NULL;
i18n::getFilesRec("$baseDir/$module/templates", $fileList);
i18n::get_files_rec("$baseDir/$module/templates", $fileList);
foreach($fileList as $index => $file) {
$mst .= i18n::reportCallsTpl($index, $file);
$mst .= i18n::report_calls_tpl($index, $file);
}
if ($mst) {
// Create folder for lang files
@ -72,13 +73,13 @@ class i18n extends Controller {
}
// Open the English file and write the Master String Table
if($fh = fopen($langFolder . '/en.php', "w")) {
if($fh = fopen($langFolder . '/en_US.php', "w")) {
fwrite($fh, "<?php\n\nglobal \$lang;\n\n" . $mst . "\n?>");
fclose($fh);
echo "Created file: $langFolder/en.php<br />";
echo "Created file: $langFolder/en_US.php<br />";
} else {
die("Cannot write language file! Please check permissions of $langFolder/en.php");
die("Cannot write language file! Please check permissions of $langFolder/en_US.php");
}
}
}
@ -90,43 +91,46 @@ class i18n extends Controller {
* @param string $folder base directory to scan (will scan recursively)
* @param array $fileList Array where potential files will be added to
*/
private static function getFilesRec($folder, &$fileList) {
private static function get_files_rec($folder, &$fileList) {
$items = scandir($folder);
if($items) foreach($items as $item) {
if(substr($item,0,1) == '.') continue;
if(substr($item,-4) == '.php') $fileList[substr($item,0,-4)] = "$folder/$item";
else if(substr($item,-3) == '.ss') $fileList[$item] = "$folder/$item";
else if(is_dir("$folder/$item")) i18n::getFilesRec("$folder/$item", $fileList);
else if(is_dir("$folder/$item")) i18n::get_files_rec("$folder/$item", $fileList);
}
}
/**
* Look for calls to the underscore function in php files and build our MST
*
* @param string $index Classname used to namespace strings
* @param string $file Path to the file to be parsed
* @return string Built Master String Table from this file
*/
private static function reportCallsCode($index, $file) {
private static function report_calls_code($file) {
static $callMap;
$content = file_get_contents($file);
while (ereg('_\(([^$][^,"\']*|"[^,]*"|\'[^,]*\')(,[^$][^,]*)(,[^$][^,)]*)(,[^,)]*)?(,[^)]*)?\)',$content,$regs)) {
$mst = '';
while (ereg('_t[[:space:]]*\([[:space:]]*("[^,]*"|\\\'[^,]*\\\')[[:space:]]*,[[:space:]]*("([^"]|\\\")*"|\'([^\']|\\\\\')*\')([[:space:]]*,[[:space:]]*[^,)]*)?([[:space:]]*,[[:space:]]*("([^"]|\\\")*"|\'([^\']|\\\\\')*\'))?[[:space:]]*\)', $content, $regs)) {
$entityParts = explode('.',substr($regs[1],1,-1));
$entity = array_pop($entityParts);
$class = implode('.',$entityParts);
$class = ($regs[1] == '__FILE__' ? $index : $regs[1]);
$entity = substr($regs[2],2,-1);
if (isset($callMap[$class.'--'.$entity])) echo "Warning! Redeclaring entity $entity in file $file<br>";
if ($callMap[$class.'--'.$entity]) echo "Warning! Redeclaring entity $entity in file $file<br>";
$mst .= '$lang[\'en\'][\'' . $class . '\'][\'' . substr($regs[2],2,-1) . '\'] = ';
if ($regs[4]) {
$mst .= "array(\n\t'" . substr($regs[3],2,-1) . "',\n\t" . substr($regs[4],1);
if ($regs[5]) $mst .= ",\n\t'" . substr($regs[5],2,-1) . '\'';
$mst .= '$lang[\'en_US\'][\'' . $class . '\'][\'' . $entity . '\'] = ';
if ($regs[5]) {
$mst .= "array(\n\t'" . substr($regs[2],1,-1) . "',\n\t" . substr($regs[5],1);
if ($regs[6]) {
if (substr($regs[6],1,1) == '"') $regs[6] = addcslashes($regs[6],'\'');
$mst .= ",\n\t'" . substr($regs[6],2,-1) . '\'';
}
$mst .= "\n);";
} else $mst .= '\'' . substr($regs[3],2,-1) . '\';';
} else $mst .= '\'' . substr($regs[2],1,-1) . '\';';
$mst .= "\n";
$content = str_replace($regs[0],"",$content);
$callMap[$class.'--'.$entity] = $regs[3];
$callMap[$class.'--'.$entity] = $regs[2];
}
return $mst;
@ -140,19 +144,26 @@ class i18n extends Controller {
* @param string $file Path to the file to be parsed
* @return string Built Master String Table from this file
*/
private static function reportCallsTpl($index, $file) {
private static function report_calls_tpl($index, $file) {
static $callMap;
$content = file_get_contents($file);
while (ereg('_\(([^$][^,"\']*|"[^,]*"|\'[^,]*\')(,[^$][^,)]*)(,[^,)]*)?(,[^)]*)?\)',$content,$regs)) {
$mst = '';
while (ereg('_t[[:space:]]*\([[:space:]]*("[^,]*"|\\\'[^,]*\\\')[[:space:]]*,[[:space:]]*("([^"]|\\\")*"|\'([^\']|\\\\\')*\')([[:space:]]*,[[:space:]]*[^,)]*)?([[:space:]]*,[[:space:]]*("([^"]|\\\")*"|\'([^\']|\\\\\')*\'))?[[:space:]]*\)',$content,$regs)) {
$entity = substr($regs[1],2,-1);
$entityParts = explode('.',substr($regs[1],1,-1));
$entity = array_pop($entityParts);
if ($callMap[$index.'--'.$entity]) echo "Warning! Redeclaring entity $entity in file $file<br>";
// Entity redeclaration check
if (isset($callMap[$index.'--'.$entity])) echo "Warning! Redeclaring entity $entity in file $file<br>";
$mst .= '$lang[\'en\'][\'' . $index . '\'][\'' . substr($regs[1],1,-1) . '\'] = ';
if ($regs[3]) {
$mst .= "array(\n\t'" . substr($regs[2],2,-1) . "',\n\t" . substr($regs[3],1);
if ($regs[4]) $mst .= ",\n\t'" . substr($regs[4],2,-1) . '\'';
if (substr($regs[2],0,1) == '"') $regs[2] = addcslashes($regs[2],'\'');
$mst .= '$lang[\'en_US\'][\'' . $index . '\'][\'' . $entity . '\'] = ';
if ($regs[5]) {
$mst .= "array(\n\t'" . substr($regs[2],1,-1) . "',\n\t" . substr($regs[5],1);
if ($regs[6]) {
if (substr($regs[6],1,1) == '"') $regs[6] = addcslashes($regs[6],'\'\\');
$mst .= ",\n\t'" . substr($regs[6],2,-1) . '\'';
}
$mst .= "\n);";
} else $mst .= '\'' . substr($regs[2],2,-1) . '\';';
$mst .= "\n";
@ -170,7 +181,7 @@ class i18n extends Controller {
*
* @param string $locale Locale to be set
*/
static function setLocale($locale) {
static function set_locale($locale) {
if ($locale) i18n::$currentlocale = $locale;
}
@ -179,7 +190,7 @@ class i18n extends Controller {
*
* @return string Current locale in the system
*/
static function getLocale() {
static function get_locale() {
return i18n::$currentlocale;
}
@ -188,7 +199,7 @@ class i18n extends Controller {
*
* @param string $locale All resources from any module in locale $locale will be loaded
*/
static function includeByLocale($locale) {
static function include_by_locale($locale) {
if (file_exists($file = Director::getAbsFile("cms/lang/$locale.php"))) include_once($file);
$topLevel = array_diff(scandir(Director::baseFolder()),array('cms'));
foreach($topLevel as $module) {
@ -205,7 +216,7 @@ class i18n extends Controller {
*
* @param string $class Resources for this class will be included, according to the set locale.
*/
static function includeByClass($class) {
static function include_by_class($class) {
if (substr($class,-3) == '.ss') {
global $_TEMPLATE_MANIFEST;
$path = current($_TEMPLATE_MANIFEST[substr($class,0,-3)]);
@ -216,11 +227,11 @@ class i18n extends Controller {
$path = $_CLASS_MANIFEST[$class];
ereg('.*/([^/]+)/code/',$path,$module);
}
if (file_exists($file = Director::getAbsFile("{$module[1]}/lang/". i18n::getLocale() . '.php'))) {
if (file_exists($file = Director::getAbsFile("{$module[1]}/lang/". i18n::get_locale() . '.php'))) {
include_once($file);
} else if (i18n::getLocale() != 'en') {
i18n::setLocale('en');
i18n::includeByClass($class);
} else if (i18n::get_locale() != 'en_US') {
i18n::set_locale('en_US');
i18n::include_by_class($class);
} else {
user_error("Locale file $file should exist", E_USER_WARNING);
}