Smarty

[naish]

Hello everyone

I just extended to html_checkboxes with a new option var. If this option is set the function will assign its output to the variable named by var. This is also potentially useful for html_radios.

The output is a standard array suitable for use in e.g. html_table.

I would like everyones opinion on the extension and if it would be worth including into the standard smarty distribution?`

Thoughts and comments.
Michael.

PS. This is the code with my quick'n'dirty hack:

[php:1:519a06e251]
function smarty_function_html_checkboxes_formatted($params, &$smarty)
{
require_once $smarty->_get_plugin_filepath('shared','escape_special_chars');

$name = 'checkbox';
$values = null;
$options = null;
$selected = null;
$separator = '';
$output = null;
$var='';
$extra = '';

foreach($params as $_key => $_val) {
switch($_key) {
case 'name':
case 'separator':
case 'var':
$$_key = $_val;
break;

case 'options':
$$_key = (array)$_val;
break;

case 'values':
case 'output':
$$_key = array_values((array)$_val);
break;

case 'checked':
case 'selected':
$selected = array_values((array)$_val);
break;

case 'checkboxes':
$smarty->trigger_error('html_checkboxes: the use of the "checkboxes" attribute is deprecated, use "options" instead', E_USER_WARNING);
$options = (array)$_val;
break;

default:
$extra .= ' '.$_key.'="'.smarty_function_escape_special_chars((string)$_val).'"';
break;
}
}

if (!isset($options) && !isset($values))
return ''; /* raise error here? */

settype($selected, 'array');
$_html_result = '';
$_temp='';

if($var!='')
$result=array();

if (is_array($options)) {

foreach ($options as $_key=>$_val)
{
$_temp .= smarty_function_html_checkboxes_output($name, $_key, $_val, $selected, $extra, $separator);
if($var!='')
$result[sizeof($result)]=$_temp;
else
$_html_result.=$_temp;
}

} else {
foreach ($values as $_i=>$_key) {
$_val = isset($output[$_i]) ? $output[$_i] : '';
$_temp = smarty_function_html_checkboxes_output($name, $_key, $_val, $selected, $extra, $separator);
if($var!='')
$result[sizeof($result)]=$_temp;
else
$_html_result.=$_temp;
}

}

if($var!='')
$smarty->assign($var,$result);
else
return $_html_result;

return;
}
[/php:1:519a06e251]

[andre]

Normally smarty uses the parameter "assign" to assign a value to a variable instead of printing it. Pehaps you should rename your parameter "var" to be more similar to other smarty functions.

{html_checkboxes assign="myArray" ... }

[naish]

Good point, I shall do so immediatly. Besides there is another small bug I would like to fix.

Michael

[boots]

@andre: isn't it interesting though that the exception to the rule is the {assign} plugin?

I should think that it would be better to deprecate {assign} and instead favour the following:

{var assign=var value=val}

It is still the exact same amount of typing (grrr) but at least it uses consistent naming within the template. I don't really see the need to follow the API names when in template -- they are separate worlds, after all.

What do you think?

[andre]

Mhmm... yeah, {assign} is an exception. But doesn't a exception proves the rule

I'm not really sure if {assign} should be renamed because assigning is exactly that what it does. So what does {var} mean?!

I wouldn't change it

bye,
André