mirror of
https://github.com/smarty-php/smarty.git
synced 2026-05-05 12:14:12 +02:00
Finished improving designers docs
This commit is contained in:
@@ -1,9 +1,18 @@
|
||||
{math} {#language.function.math}
|
||||
======
|
||||
# {math}
|
||||
|
||||
`{math}` allows the template designer to do math equations in the
|
||||
template.
|
||||
|
||||
## Attributes
|
||||
|
||||
| Attribute Name | Required | Description |
|
||||
|----------------|----------|--------------------------------------------------|
|
||||
| equation | Yes | The equation to execute |
|
||||
| format | No | The format of the result (sprintf) |
|
||||
| var | Yes | Equation variable value |
|
||||
| assign | No | Template variable the output will be assigned to |
|
||||
| \[var \...\] | Yes | Equation variable value |
|
||||
|
||||
- Any numeric template variables may be used in the equations, and the
|
||||
result is printed in place of the tag.
|
||||
|
||||
@@ -24,81 +33,67 @@ template.
|
||||
> `{math}` is an expensive function in performance due to its use of the
|
||||
> php [`eval()`](https://www.php.net/eval) function. Doing the math in PHP
|
||||
> is much more efficient, so whenever possible do the math calculations
|
||||
> in the script and [`assign()`](#api.assign) the results to the
|
||||
> in the script and [`assign()`](../../programmers/api-functions/api-assign.md) the results to the
|
||||
> template. Definitely avoid repetitive `{math}` function calls, eg
|
||||
> within [`{section}`](#language.function.section) loops.
|
||||
> within [`{section}`](../language-builtin-functions/language-function-section.md) loops.
|
||||
|
||||
Attribute Name Type Required Default Description
|
||||
---------------- --------- ---------- --------- --------------------------------------------------
|
||||
equation string Yes *n/a* The equation to execute
|
||||
format string No *n/a* The format of the result (sprintf)
|
||||
var numeric Yes *n/a* Equation variable value
|
||||
assign string No *n/a* Template variable the output will be assigned to
|
||||
\[var \...\] numeric Yes *n/a* Equation variable value
|
||||
## Examples
|
||||
|
||||
**Example a:**
|
||||
**Example 1**
|
||||
```smarty
|
||||
|
||||
{* $height=4, $width=5 *}
|
||||
|
||||
{* $height=4, $width=5 *}
|
||||
|
||||
{math equation="x + y" x=$height y=$width}
|
||||
|
||||
{math equation="x + y" x=$height y=$width}
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```
|
||||
9
|
||||
```
|
||||
|
||||
|
||||
**Example 2**
|
||||
|
||||
```smarty
|
||||
{* $row_height = 10, $row_width = 20, #col_div# = 2, assigned in template *}
|
||||
|
||||
{math equation="height * width / division"
|
||||
height=$row_height
|
||||
width=$row_width
|
||||
division=#col_div#}
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
|
||||
9
|
||||
|
||||
```
|
||||
100
|
||||
```
|
||||
|
||||
**Example 3**
|
||||
|
||||
**Example b:**
|
||||
```smarty
|
||||
{* you can use parenthesis *}
|
||||
|
||||
|
||||
{* $row_height = 10, $row_width = 20, #col_div# = 2, assigned in template *}
|
||||
|
||||
{math equation="height * width / division"
|
||||
height=$row_height
|
||||
width=$row_width
|
||||
division=#col_div#}
|
||||
|
||||
|
||||
{math equation="(( x + y ) / z )" x=2 y=10 z=2}
|
||||
```
|
||||
|
||||
The above example will output:
|
||||
|
||||
```
|
||||
6
|
||||
```
|
||||
|
||||
100
|
||||
**Example 4**
|
||||
|
||||
```smarty
|
||||
{* you can supply a format parameter in sprintf format *}
|
||||
|
||||
{math equation="x + y" x=4.4444 y=5.0000 format="%.2f"}
|
||||
```
|
||||
|
||||
|
||||
**Example c:**
|
||||
|
||||
|
||||
{* you can use parenthesis *}
|
||||
|
||||
{math equation="(( x + y ) / z )" x=2 y=10 z=2}
|
||||
|
||||
|
||||
|
||||
The above example will output:
|
||||
|
||||
|
||||
6
|
||||
|
||||
|
||||
|
||||
**Example d:**
|
||||
|
||||
|
||||
{* you can supply a format parameter in sprintf format *}
|
||||
|
||||
{math equation="x + y" x=4.4444 y=5.0000 format="%.2f"}
|
||||
|
||||
|
||||
|
||||
The above example will output:
|
||||
|
||||
|
||||
9.44
|
||||
|
||||
|
||||
```
|
||||
9.44
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user