include/Smarty/plugins/function.html_radios.php

   1 <?php
   2
   3 /*
   4
   5 Modification information for LGPL compliance
   6
   7 r56990 - 2010-06-16 13:05:36 -0700 (Wed, 16 Jun 2010) - kjing - snapshot "Mango" svn branch to a new one for GitHub sync
   8
   9 r56989 - 2010-06-16 13:01:33 -0700 (Wed, 16 Jun 2010) - kjing - defunt "Mango" svn dev branch before github cutover
  10
  11 r55980 - 2010-04-19 13:31:28 -0700 (Mon, 19 Apr 2010) - kjing - create Mango (6.1) based on windex
  12
  13 r51719 - 2009-10-22 10:18:00 -0700 (Thu, 22 Oct 2009) - mitani - Converted to Build 3  tags and updated the build system
  14
  15 r51634 - 2009-10-19 13:32:22 -0700 (Mon, 19 Oct 2009) - mitani - Windex is the branch for Sugar Sales 1.0 development
  16
  17 r50375 - 2009-08-24 18:07:43 -0700 (Mon, 24 Aug 2009) - dwong - branch kobe2 from tokyo r50372
  18
  19 r42807 - 2008-12-29 11:16:59 -0800 (Mon, 29 Dec 2008) - dwong - Branch from trunk/sugarcrm r42806 to branches/tokyo/sugarcrm
  20
  21 r27851 - 2007-10-10 09:19:04 -0700 (Wed, 10 Oct 2007) - clee - Applied changes to radio enum field to add separator value and also blank label.
  22
  23 r8230 - 2005-10-03 17:47:19 -0700 (Mon, 03 Oct 2005) - majed - Added Sugar_Smarty to the code tree.
  24
  25
  26 */
  27
  28
  29 /**
  30  * Smarty plugin
  31  * @package Smarty
  32  * @subpackage plugins
  33  */
  34
  35
  36 /**
  37  * Smarty {html_radios} function plugin
  38  *
  39  * File:       function.html_radios.php<br>
  40  * Type:       function<br>
  41  * Name:       html_radios<br>
  42  * Date:       24.Feb.2003<br>
  43  * Purpose:    Prints out a list of radio input types<br>
  44  * Input:<br>
  45  *           - name       (optional) - string default "radio"
  46  *           - values     (required) - array
  47  *           - options    (optional) - associative array
  48  *           - checked    (optional) - array default not set
  49  *           - separator  (optional) - ie <br> or &nbsp;
  50  *           - output     (optional) - the output next to each radio button
  51  *           - assign     (optional) - assign the output as an array to this variable
  52  * Examples:
  53  * <pre>
  54  * {html_radios values=$ids output=$names}
  55  * {html_radios values=$ids name='box' separator='<br>' output=$names}
  56  * {html_radios values=$ids checked=$checked separator='<br>' output=$names}
  57  * </pre>
  58  * @link http://smarty.php.net/manual/en/language.function.html.radios.php {html_radios}
  59  *      (Smarty online manual)
  60  * @author     Christopher Kvarme <christopher.kvarme@flashjab.com>
  61  * @author credits to Monte Ohrt <monte at ohrt dot com>
  62  * @version    1.0
  63  * @param array
  64  * @param Smarty
  65  * @return string
  66  * @uses smarty_function_escape_special_chars()
  67  */
  68 function smarty_function_html_radios($params, &$smarty)
  69 {
  70
  71     require_once $smarty->_get_plugin_filepath('shared','escape_special_chars');
  72
  73     $name = 'radio';
  74     $values = null;
  75     $options = null;
  76     $selected = null;
  77     $separator = '';
  78     $labels = true;
  79     $label_ids = false;
  80     $output = null;
  81     $extra = '';
  82
  83     foreach($params as $_key => $_val) {
  84         switch($_key) {
  85             case 'name':
  86             case 'separator':
  87                 $$_key = (string)$_val;
  88                 break;
  89
  90             case 'checked':
  91             case 'selected':
  92                 if(is_array($_val)) {
  93                     $smarty->trigger_error('html_radios: the "' . $_key . '" attribute cannot be an array', E_USER_WARNING);
  94                 } else {
  95                     $selected = (string)$_val;
  96                 }
  97                 break;
  98
  99             case 'labels':
 100             case 'label_ids':
 101                 $$_key = (bool)$_val;
 102                 break;
 103
 104             case 'options':
 105                 $$_key = (array)$_val;
 106                 break;
 107
 108             case 'values':
 109             case 'output':
 110                 $$_key = array_values((array)$_val);
 111                 break;
 112
 113             case 'radios':
 114                 $smarty->trigger_error('html_radios: the use of the "radios" attribute is deprecated, use "options" instead', E_USER_WARNING);
 115                 $options = (array)$_val;
 116                 break;
 117
 118             case 'assign':
 119                 break;
 120
 121             default:
 122                 if(!is_array($_val)) {
 123                     $extra .= ' '.$_key.'="'.smarty_function_escape_special_chars($_val).'"';
 124                 } else {
 125                     $smarty->trigger_error("html_radios: extra attribute '$_key' cannot be an array", E_USER_NOTICE);
 126                 }
 127                 break;
 128         }
 129     }
 130
 131     if (!isset($options) && !isset($values))
 132         return ''; /* raise error here? */
 133
 134     $_html_result = array();
 135
 136     if (isset($options)) {
 137
 138         foreach ($options as $_key=>$_val)
 139             $_html_result[] = smarty_function_html_radios_output($name, $_key, $_val, $selected, $extra, $separator, $labels, $label_ids);
 140
 141     } else {
 142
 143         foreach ($values as $_i=>$_key) {
 144             $_val = isset($output[$_i]) ? $output[$_i] : '';
 145             $_html_result[] = smarty_function_html_radios_output($name, $_key, $_val, $selected, $extra, $separator, $labels, $label_ids);
 146         }
 147
 148     }
 149
 150     if(!empty($params['assign'])) {
 151         $smarty->assign($params['assign'], $_html_result);
 152     } else {
 153         return implode("\n",$_html_result);
 154     }
 155
 156 }
 157
 158 function smarty_function_html_radios_output($name, $value, $output, $selected, $extra, $separator, $labels, $label_ids) {
 159
 160     $_output = '';
 161     if ($labels) {
 162       if($label_ids) {
 163           $_id = smarty_function_escape_special_chars(preg_replace('![^\w\-\.]!', '_', $name . '_' . $value));
 164           $_output .= '<label for="' . $_id . '">';
 165       } else {
 166           $_output .= '<label>';
 167       }
 168    }
 169    $_output .= '<input type="radio" name="'
 170         . smarty_function_escape_special_chars($name) . '" value="'
 171         . smarty_function_escape_special_chars($value) . '"';
 172
 173    if ($labels && $label_ids) $_output .= ' id="' . $_id . '"';
 174
 175     if ((string)$value==$selected) {
 176         $_output .= ' checked="checked"';
 177     }
 178
 179     $_output .= $extra . ' />' . ($output == '' ? $GLOBALS['app_strings']['LBL_LINK_NONE'] : $output);
 180
 181     if ($labels) $_output .= '</label>';
 182     $_output .=  $separator;
 183
 184     return $_output;
 185 }
 186
 187 ?>