Changeset 24923

Timestamp:

11/30/08 09:22:58 (6 weeks ago)

Author:

Landseer

Message:

fixed gettext plugins, partial rollback of changeset:24917

Location:

development/main/system/pnRender/plugins

Files:

• function.dcgt.php (modified) (4 diffs)
• function.dcngt.php (modified) (3 diffs)
• function.dgt.php (modified) (4 diffs)
• function.dngt.php (modified) (4 diffs)
• function.gt.php (modified) (4 diffs)
• function.ngt.php (modified) (2 diffs)

development/main/system/pnRender/plugins/function.dcgt.php

@@ -5 +5 @@
  * @copyright (c) 2004, Zikula Development Team
  * @link http://www.zikula.org
- * @version $Id: block.pnsecauthaction_block.php 24342 2008-06-06 12:03:14Z markwest $
+ * @version $Id: $
  * @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
- * @author Bernd Plagge 
  * @package Zikula_Template_Plugins
  * @subpackage Functions
  */
-
  
 /**
@@ -19 +17 @@
  * 
  * Available parameters:
- *        - domain:     textdomain to be used
- *   - name:     Name of the language constant to return
- *   - cat:               Locale category (e.g. '4' -> LC_MONETARY   
- *   - html:     Treat the language define as HTML
+ *       - domain:       textdomain to be used
+ *   - text:     string to translate
+ *   - cat:              Locale category (e.g. '4' -> LC_MONETARY   
+ *   - html:     Treat the text as HTML
  *   - assign:   If set, the results are assigned to the corresponding variable instead of printed out
  * 
  * Example
- * <!--[dcgt domain="OtherModule" name="At the tone, the time will be 12:00pm" cat="2" html="0"]-->
+ * <!--[dcgt domain="OtherModule" text="String" cat="4" html="1"]-->
  * 
  * The normal textdomain and the now to be used textdomain must have been set beforehand!
@@ -37 +35 @@
  * 
  * @author       Bernd Plagge
+ * @author       Frank Schummertz (coding guideline changes)
  * @since        2007-04-20
  * @param        array       $params      All attributes passed to this function from the template
@@ -50 +49 @@
     /* Gettext initialisation finished */
 
-        extract($params); 
-        unset($params);
-
-        if (!isset($domain)) {
+        if (!isset($params['domain'])) {
                 $smarty->trigger_error('dcgt: attribute domain required');
                 return false;
         }    
-        if (!isset($name)) {
-                $smarty->trigger_error('dcgt: attribute name required');
+        if (!isset($params['text'])) {
+                $smarty->trigger_error('dcgt: attribute text required');
                 return false;
         }    
-        if (!isset($name)) {
+        if (!isset($params['cat'])) {
                 $smarty->trigger_error('dcgt: attribute cat required');
                 return false;
         }    
         
-        if (isset($html) && ($html > 0)) {
-        $result = DataUtil::formatForDisplayHTML(dcgettext($domain, $name, $cat));        
+        if (isset($params['html']) && ($params['html'] > 0)) {
+        $result = DataUtil::formatForDisplayHTML(dgettext($params['domain'], $params['text'], $params['cat']));        
         } else {
-            $result = DataUtil::formatForDisplay(dcgettext($domain, $name, $cat));
+            $result = DataUtil::formatForDisplay(dgettext($params['domain'], $params['text'], $params['cat']));
         }
 
-    if (isset($assign)) {
-        $smarty->assign($assign, $result);
+    if (isset($params['assign'])) {
+        $smarty->assign($params['assign'], $result);
     } else {
         return $result;        
     }      
 }
-?>

development/main/system/pnRender/plugins/function.dcngt.php

@@ -5 +5 @@
  * @copyright (c) 2004, Zikula Development Team
  * @link http://www.zikula.org
- * @version $Id: block.pnsecauthaction_block.php 24342 2008-06-06 12:03:14Z markwest $
+ * @version $Id: $
  * @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
- * @author Bernd Plagge 
  * @package Zikula_Template_Plugins
  * @subpackage Functions
  */
-
  
 /**
- * Smarty function to use the PHP dcngettext() function 
+ * Smarty function to use the PHP dcngettext() function   
  * 
  * This function takes a identifier and returns the corresponding language constant.
  * 
  * Available parameters:
- *        - domain:     textdomain to be used
- *   - name:     Name of the language constant to return
- *        - plural:     Plural form
- *        - count:        The actual number (e.g. '5' apples -> count='5')  
- *   - cat:             Locale category (e.g. '4' -> LC_MONETARY   
- *   - html:     Treat the language define as HTML
- *   - assign:   If set, the results are assigned to the corresponding variable instead of printed out
+ *       - domain:        textdomain to be used
+ *   - text:      string to translate
+ *       - plural:        Plural form
+ *       - count:         The actual number (e.g. '5' apples -> count='5')      
+ *   - cat:               Locale category (e.g. '4' -> LC_MONETARY  
+ *   - html:      Treat the text as HTML
+ *   - assign:    If set, the results are assigned to the corresponding variable instead of printed out
  * 
  * Example
- * <!--[dcngt domain="OtherModule" name="%d person attended" plural="%d people attended" cat="0" html="0"]-->
+ * <!--[dcngt domain="OtherModule" name="String" cat="4" html="1"]-->
  * 
  * The normal textdomain and the now to be used textdomain must have been set beforehand!
@@ -39 +37 @@
  * 
  * @author       Bernd Plagge
+ * @author       Frank Schummertz (coding guideline changes)
  * @since        2007-04-20
  * @param        array       $params      All attributes passed to this function from the template
@@ -52 +51 @@
     /* Gettext initialisation finished */
 
-        extract($params); 
-        unset($params);
-
-        if (!isset($domain)) {
+        if (!isset($params['domain'])) {
                 $smarty->trigger_error('dcngt: attribute domain required');
                 return false;
         }    
-        if (!isset($name)) {
-                $smarty->trigger_error('dcngt: attribute name required');
+        if (!isset($params['text'])) {
+                $smarty->trigger_error('dcngt: attribute text required');
                 return false;
-        } 
-        if (!isset($plural)) {
-                $smarty->trigger_error('dcngt: attribute plural required');
-                return false;
-        } 
-        if (!isset($count)) {
-                $smarty->trigger_error('dcngt: attribute count required');
-                return false;
-        }                  
-        if (!isset($cat)) {
+        }    
+        if (!isset($params['cat'])) {
                 $smarty->trigger_error('dcngt: attribute cat required');
                 return false;
         }    
+        if (!isset($params['plural'])) {
+                $smarty->trigger_error('dcngt: attribute plural required');
+                return false;
+        }    
+        if (!isset($params['count'])) {
+                $smarty->trigger_error('dcngt: attribute count required');
+                return false;
+        }           
+        
+        if (isset($params['html']) && ($params['html'] > 0)) {
+        $result = DataUtil::formatForDisplayHTML(dgettext($params['domain'], $params['text'], $params['plural'], $params['count'], $params['cat']));        
+        } else {
+            $result = DataUtil::formatForDisplay(dgettext($params['domain'], $params['text'], $params['plural'], $params['count'], $params['cat']));
+        }
 
-
-        if (isset($html) && ($html > 0)) {
-        $result = DataUtil::formatForDisplayHTML(dcngettext($domain, $name, $plural, $count, $cat));        
-        } else {
-            $result = DataUtil::formatForDisplay(dcngettext($domain, $name, $plural, $count, $cat));
-        }       
-
-    if (isset($assign)) {
-        $smarty->assign($assign, $result);
+    if (isset($params['assign'])) {
+        $smarty->assign($params['assign'], $result);
     } else {
         return $result;        
     }      
 }
-?>

development/main/system/pnRender/plugins/function.dgt.php

@@ -5 +5 @@
  * @copyright (c) 2004, Zikula Development Team
  * @link http://www.zikula.org
- * @version $Id: block.pnsecauthaction_block.php 24342 2008-06-06 12:03:14Z markwest $
+ * @version $Id: $
  * @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
  * @package Zikula_Template_Plugins
- * @author Bernd Plagge 
- * @package Zikula_Template_Plugins
- * @subpackage Functions 
+ * @subpackage Functions
  */
-
+ 
 /**
  * Smarty function to use the PHP dgettext() function   
@@ -19 +17 @@
  * 
  * Available parameters:
- *       - domain:              textdomain to be used
- *   - name:     Name of the language constant to return
- *   - html:     Treat the language define as HTML
+ *   - domain:    textdomain to be used
+ *   - text:     string to translate
+ *   - html:     Treat the text as HTML
  *   - assign:   If set, the results are assigned to the corresponding variable instead of printed out
  * 
  * Example
- * <!--[dgt domain="OtherModule" name="Example Text" html="1"]-->
+ * <!--[dgt domain="OtherModule" name="String" html="1"]-->
  * 
  * The normal textdomain and the now to be used textdomain must have been set beforehand!
@@ -32 +30 @@
  * 
  * @author       Bernd Plagge
+ * @author       Frank Schummertz (coding guideline changes)
  * @since        2007-04-20
  * @param        array       $params      All attributes passed to this function from the template
@@ -45 +44 @@
     /* Gettext initialisation finished */
 
-        extract($params); 
-        unset($params);
-
-        if (!isset($domain)) {
+        if (!isset($params['domain'])) {
                 $smarty->trigger_error('dgt: attribute domain required');
                 return false;
         }    
-        if (!isset($name)) {
-                $smarty->trigger_error('dgt: attribute name required');
+        if (!isset($params['text'])) {
+                $smarty->trigger_error('dgt: attribute text required');
                 return false;
         }    
         
         if (isset($html) && ($html > 0)) {
-        $result = DataUtil::formatForDisplayHTML(dgettext($domain, $name));        
+        $result = DataUtil::formatForDisplayHTML(dgettext($params['domain'], $params['text']));        
         } else {
-            $result = DataUtil::formatForDisplay(dgettext($domain, $name));
+            $result = DataUtil::formatForDisplay(dgettext($params['domain'], $params['text']));
         }
 
-    if (isset($assign)) {
-        $smarty->assign($assign, $result);
+    if (isset($params['assign'])) {
+        $smarty->assign($params['assign'], $result);
     } else {
         return $result;        
     }      
 }
-?>

development/main/system/pnRender/plugins/function.dngt.php

@@ -5 +5 @@
  * @copyright (c) 2004, Zikula Development Team
  * @link http://www.zikula.org
- * @version $Id: block.pnsecauthaction_block.php 24342 2008-06-06 12:03:14Z markwest $
+ * @version $Id: $
  * @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
- * @author Bernd Plagge 
  * @package Zikula_Template_Plugins
  * @subpackage Functions
  */
 
- 
 /**
  * Smarty function to use the PHP dngettext() function   
@@ -19 +17 @@
  * 
  * Available parameters:
- *        - domain:       textdomain to be used
- *   - name:     Name of the language constant to return
- *        - plural:       Plural form
- *        - count:        The actual number (e.g. '5' apples -> count='5')
-        
- *   - html:     Treat the language define as HTML
- *   - assign:   If set, the results are assigned to the corresponding variable instead of printed out
+ *   - domain:    textdomain to be used
+ *   - text:      string to translate
+ *   - plural:    Plural form
+ *   - count:     The actual number (e.g. '5' apples -> count='5')
+ *   - html:      Treat the text as HTML
+ *   - assign:    If set, the results are assigned to the corresponding variable instead of printed out
  * 
  * Example
@@ -35 +32 @@
  * 
  * @author       Bernd Plagge
+ * @author       Frank Schummertz (coding guideline changes)
  * @since        2007-04-20
  * @param        array       $params      All attributes passed to this function from the template
@@ -48 +46 @@
     /* Gettext initialisation finished */
 
-        extract($params); 
-        unset($params);
-
-        if (!isset($domain)) {
+        if (!isset($params['domain'])) {
                 $smarty->trigger_error('dngt: attribute domain required');
                 return false;
         }    
-        if (!isset($name)) {
-                $smarty->trigger_error('dngt: attribute name required');
+        if (!isset($params['text'])) {
+                $smarty->trigger_error('dngt: attribute text required');
                 return false;
         }    
-        if (!isset($plural)) {
+        if (!isset($params['plural'])) {
                 $smarty->trigger_error('dngt: attribute plural required');
                 return false;
         }    
-        if (!isset($count)) {
+        if (!isset($params['count'])) {
                 $smarty->trigger_error('dngt: attribute count required');
                 return false;
-        }    
-
+        }           
         
-        if (isset($html) && ($html > 0)) {
-        $result = DataUtil::formatForDisplayHTML(dngettext($domain, $name, $plural, $count));        
+        if (isset($params['html']) && ($params['html'] > 0)) {
+        $result = DataUtil::formatForDisplayHTML(dngettext($params['domain'], $params['text'], $params['plural'], $params['count']));        
         } else {
-            $result = DataUtil::formatForDisplay(dngettext($domain, $name, $plural, $count));
+            $result = DataUtil::formatForDisplay(dngettext($params['domain'], $params['text'], $params['plural'], $params['count']));
         }
 
-    if (isset($assign)) {
-        $smarty->assign($assign, $result);
+    if (isset($params['assign'])) {
+        $smarty->assign($params['assign'], $result);
     } else {
         return $result;        
     }      
 }
-?>

development/main/system/pnRender/plugins/function.gt.php

@@ -5 +5 @@
  * @copyright (c) 2004, Zikula Development Team
  * @link http://www.zikula.org
- * @version $Id: block.pnsecauthaction_block.php 24342 2008-06-06 12:03:14Z markwest $
+ * @version $Id: $
  * @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
- * @author Bernd Plagge 
  * @package Zikula_Template_Plugins
  * @subpackage Functions
  */
-
  
 /**
@@ -19 +17 @@
  * 
  * Available parameters:
- *   - name:     Name of the language constant to return
+ *   - text:     the text to translate
  *   - html:     Treat the language define as HTML
  *   - tag       single variable string or array
@@ -26 +24 @@
  * 
  * Example
- * <!--[gt name="Example %s Text" tag="Message" html="1"]-->
- * Format of the 'tag' parameter: 
- *               value string separated by commas; will converted to array('a','b', 'c')
- *               if a value itself has the form 'a|True' it will be converted to array('a', 'True')
+ * <!--[gt text="Example Text" html="1"]-->
+ * 
  * 
  * @author       Bernd Plagge
+ * @author       Frank Schummertz (coding guideline changes)
  * @since        08/08/2005
  * @param        array       $params      All attributes passed to this function from the template
@@ -39 +36 @@
 function smarty_function_gt ($params, &$smarty) 
 {
-        extract($params); 
-        unset($params);
-
-        if (!isset($name)) {
-                $smarty->trigger_error('gt: attribute name required');
+        if (!isset($params['text'])) {
+                $smarty->trigger_error('gt: attribute text required');
                 return false;
         } 
 
-        if (isset($tag)) {
-                $tag = _expand_tag($tag);
+        if (isset($params['tag'])) {
                 // we call LanguageUtil::formatGettextMsg
-                if (is_string($tag)) {
-                        $name = __fGT(_($name), array( $tag ) );
+                if (is_string($params['tag'])) {
+                        $text = __fGT(_($params['text']), array( $params['tag'] ) );
                 } else {
-                        $name = __fGT( _($name), $tag );
+                        $text = __fGT( _($params['text']), $params['tag'] );
                 }
         } else {
-        $name = _($name);
+        $text = _($params['text']);
         }
 
-        if (isset($html) && ($html == true)) {
-        $result = DataUtil::formatForDisplayHTML($name);        
+        if (isset($params['html']) && ($params['html'] == true)) {
+        $result = DataUtil::formatForDisplayHTML($text);        
         } else {
-            $result = DataUtil::formatForDisplay($name);
+            $result = DataUtil::formatForDisplay($text);
         }
 
-    if (isset($assign)) {
-        $smarty->assign($assign, $result);
+    if (isset($params['assign'])) {
+        $smarty->assign($params['assign'], $result);
     } else {
         return $result;        
     }      
 }
-
-/*
- *
- * Convert a tag string to an array
- *
- * The tag string is formated as follow:
- * tag1|option1,tag2|option2,tag3,tag4|option4,tag5
- *
- * where optionN is an option for tagN and is optional
- * 
- * @author       Vincent Touchard
- * @since        19/11/2008
- * @param        string      $param      the tags in a string. Each tag separated
- *                                       by a comma, using a | between the tag and its option
- * @return       array                   the tags in an array.
- */
-function _expand_tag ($param)
-{
-        // split all the tags
-        $tags = explode(',', $param);
-        foreach ($tags as $tag) {
-                // split tag and option
-                // If no option, returns the tag, else returns an array with the tag and the option
-                $a = explode('|', $tag);
-                if (count($a) > 1) {
-                        // transform the option into a boolean
-                        $a[1] = ($a[1] == '1' || strtolower($a[1]) == 'true');
-                        $tags2[] = $a;
-                } else {
-                        $tags2[] = $tag;
-                }
-        }
-
-        return $tags2;
-}

development/main/system/pnRender/plugins/function.ngt.php

@@ -5 +5 @@
  * @copyright (c) 2004, Zikula Development Team
  * @link http://www.zikula.org
- * @version $Id: block.pnsecauthaction_block.php 24342 2008-06-06 12:03:14Z markwest $
+ * @version $Id: $
  * @license GNU/GPL - http://www.gnu.org/copyleft/gpl.html
  * @package Zikula_Template_Plugins
- * @author Bernd Plagge 
- * @package Zikula_Template_Plugins
- * @subpackage Functions 
+ * @subpackage Functions
  */
- 
+
 /**
+ * Renderer plugin
+ * 
+ * This file is a plugin for Renderer, the PostNuke implementation of Smarty
+ *
  * Smarty function to use the PHP ngettext() function   
  * 
- * This function takes a identifier and returns the corresponding language constant.
+ * This function takes a identifier and returns the corresponding language text.
  * 
  * Available parameters:
  *   - name:     Name of the language constant to return
- *        - plural:     Plural form
- *        - count:        The actual number (e.g. '5' apples -> count='5')
- *   - tag:             Use this to pass additional parameters to the plugin    
+ *        - plural:       Plural form
+ *        - count:        The actual number (e.g. '5' apples -> count='5')      
  *   - html:     Treat the language define as HTML
  *   - assign:   If set, the results are assigned to the corresponding variable instead of printed out
  * 
  * Example
- * <!--[ngt name="%d %s string" plural="%d %s strings" count="5"  tag="text" html="1"]-->
+ * <!--[ngt name="String" plural="Strings" count="5"  html="1"]-->
  * 
- * format of the 'tag' parameter: 
- *               value string separated by commas; will converted to array('a','b', 'c')
- *               if a value itself has the form 'a|True' it will be converted to array('a', 'True')
- *
+ * 
  * @author       Bernd Plagge
- * @since        2007-04-20, 2008-11-29
+ * @author       Frank Schummertz (coding guideline changes)
+ * @since        2007-04-20
  * @param        array       $params      All attributes passed to this function from the template
  * @param        object      &$smarty     Reference to the Smarty object
@@ -41 +40 @@
 function smarty_function_ngt ($params, &$smarty) 
 {
-    /* Gettext initialisation start */
+    $name   = (!isset($params['name']))   ? '' : $params['name'];
+    $plural = (!isset($params['plural'])) ? '' : $params['plural'];
+    $count  = (!isset($params['count']))  ? '' : $params['count'];
 
-    $debug=0;
-
-    /* Gettext initialisation finished */
-
-        extract($params); 
-        unset($params);
-
-        if (!isset($name)) {
-                $smarty->trigger_error('ngt: attribute name required');
+        if (empty($name)) {
+                $smarty->trigger_error('pnngt: attribute name required');
                 return false;
         }    
-        if (!isset($plural)) {
-                $smarty->trigger_error('ngt: attribute plural required');
+        if (empty($plural)) {
+                $smarty->trigger_error('pnngt: attribute plural required');
                 return false;
         }    
-        if (!isset($count)) {
-                $smarty->trigger_error('ngt: attribute count required');
+        if (empty($count)) {
+                $smarty->trigger_error('pnngt: attribute count required');
                 return false;
         }    
 
-        if (isset($tag)) {
-                $tag=_expand_tag($tag);
-
-// we call LanguageUtil::formatGettextMsg
-                if (is_string($tag)) {
-                        $name = __fNGT($name, $plural, $count, array( $tag ) );
-                } else {
-                        $name = __fNGT($name, $plural, $count, $tag );
-                }
+        
+        if (isset($params['html']) && ($params['html'] > 0)) {
+        $result = DataUtil::formatForDisplayHTML(ngettext($name, $plural, $count));        
         } else {
-        $name = sprintf(ngettext($name, $plural, $count), $count);