Update variables file
[asterisk/asterisk.git] / doc / README.variables
1 GENERAL ENCHANCEMENTS TO EXTENSION LOGIC : 
2
3 QUOTING: 
4
5 exten => s,5,BackGround,blabla
6
7 The parameter (blabla) can be quoted ("blabla"). In this case, a 
8 comma does not terminate the field. 
9
10 Also, characters special to variable substitution, expression evaluation, etc
11 (see below), can be quoted. For example, to literally use a $ on the 
12 string "$1231", quote it with a preceeding \. Special characters that must
13 be quoted to be used, are [ ] $ " \. (to write \ itself, use \\). 
14
15 VARIABLES: 
16
17 Parameter strings can include variables. Variable names are arbitrary strings. 
18 They are stored in the respective channel structure. 
19
20 To set a variable to a particular value, do : 
21
22 ;exten => 1,2,SetVar,varname=value
23
24 You can substitute the value of a variable everywhere using ${variablename}.
25 For example, to stringwise append $lala to $blabla and store result in $koko, 
26 do: 
27
28 ;exten => 1,2,SetVar,koko=${blabla}${lala}
29
30 There are also the following special variables: 
31
32 ${CALLERID}     Caller ID
33 ${CALLERIDNAME} Caller ID Name only
34 ${CALLERIDNUM}  Caller ID Number only
35 ${EXTEN}        Current extension
36 ${CONTEXT}      Current context
37 ${PRIORITY}     Current priority
38 ${CHANNEL}      Current channel name
39 ${EPOCH}        Current unix style epoch
40 ${DATETIME}     Current date time in the format: YYYY-MM-DD_HH:MM:SS
41
42 There are two reference modes - reference by value and reference by name. 
43 To refer to a variable with its name (as an argument to a function that 
44 requires a variable), just write the name. To refer to the variable's value, 
45 enclose it inside ${}. For example, SetVar takes as the first argument 
46 (before the =) a variable name, so: 
47
48 ;exten => 1,2,SetVar,koko=lala
49 ;exten => 1,3,SetVar,${koko}=blabla
50
51 stores to the variable "koko" the value "lala" and to variable "lala" the 
52 value "blabla". 
53
54 In fact, everything contained ${here} is just replaced with the value of 
55 the variable "here". 
56
57 EXPRESSIONS: 
58
59 Everything contained inside a bracket pair prefixed by a $ (like $[this]) is 
60 considered as an expression and it is evaluated. Evaluation works similar to 
61 (but is done on a later stage than) variable substitution: the expression 
62 (including the square brackets) is replaced by the result of the expression 
63 evaluation. The arguments and operands of the expression MUST BE separated 
64 with spaces (take care NOT to leave ANY spaces between opening and closing 
65 square brackets and the first and last arguments). 
66
67 For example, after the sequence: 
68
69 exten => 1,1,SetVar,"lala=$[1 + 2]";
70 exten => 1,2,SetVar,"koko=$[2 * ${lala}]";
71
72 the value of variable koko is "6".
73
74 Operators are listed below in order of increasing precedence.  Operators
75 with equal precedence are grouped within { } symbols.
76
77      expr1 | expr2
78              Return the evaluation of expr1 if it is neither an empty string
79              nor zero; otherwise, returns the evaluation of expr2.
80
81      expr1 & expr2
82              Return the evaluation of expr1 if neither expression evaluates to
83              an empty string or zero; otherwise, returns zero.
84
85      expr1 {=, >, >=, <, <=, !=} expr2
86              Return the results of integer comparison if both arguments are
87              integers; otherwise, returns the results of string comparison
88              using the locale-specific collation sequence.  The result of each
89              comparison is 1 if the specified relation is true, or 0 if the
90              relation is false.
91
92      expr1 {+, -} expr2
93              Return the results of addition or subtraction of integer-valued
94              arguments.
95
96      expr1 {*, /, %} expr2
97              Return the results of multiplication, integer division, or
98              remainder of integer-valued arguments.
99
100      expr1 : expr2
101              The `:' operator matches expr1 against expr2, which must be a
102              regular expression.  The regular expression is anchored to the
103              beginning of  the string with an implicit `^'.
104
105              If the match succeeds and the pattern contains at least one regu-
106              lar expression subexpression `\(...\)', the string correspond-
107              ing to `\1' is returned; otherwise the matching operator
108              returns the number of characters matched.  If the match fails and
109              the pattern contains a regular expression subexpression the null
110              string is returned; otherwise 0.
111
112 Parentheses are used for grouping in the usual manner.
113
114 The parser must be parsed with bison (bison is REQUIRED - yacc cannot 
115 produce pure parsers, which are reentrant) 
116
117 CONDITIONALS
118
119 There is one conditional operator - the conditional goto : 
120
121 ;exten => 1,2,gotoif,condition?label1:label2
122
123 If condition is true go to label1, else go to label2. Labels are interpreted
124 exactly as in the normal goto command.
125
126 "condition" is just a string. If the string is empty or "0", the condition
127 is considered to be false, if it's anything else, the condition is true. 
128 This is designed to be used together with the expression syntax described 
129 above, eg : 
130
131 exten => 1,2,gotoif,$[${CALLERID} = 123456]?2|1:3|1
132
133
134 Example of use : 
135
136 exten => s,2,SetVar,"vara=1"
137 exten => s,3,SetVar,"varb=$[${vara} + 2]"
138 exten => s,4,SetVar,"varc=$[${varb} * 2]"
139 exten => s,5,GotoIf,"$[${varc} = 6]?99|1:s|6";
140