number add(number $left, number $right)<\/code><\/pre>\n\n\n\nAdds $left and $right together. <\/p>\n\n\n\n| Expression<\/th> | Result<\/th><\/tr><\/thead> |
|---|
add(`3`, `4`)<\/code><\/td>7<\/code><\/td><\/tr>add(`3.0`, `4`)<\/code><\/td>7<\/code><\/td><\/tr>add(`3.5`, `4`)<\/code><\/td>7.5<\/code><\/td><\/tr>add(`-3.5`, `4`)<\/code><\/td>0.5<\/code><\/td><\/tr>add('3', `4`)<\/code><\/td>Error<\/code><\/td><\/tr>add([`0`, `1`], `2`)<\/code><\/td>Error<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n<\/div><\/div>\n<\/div><\/div>\n\n\n\n\n append<\/h2>\n\n\n\narray append(array $input, any $items)<\/code><\/pre>\n\n\n\nAppends $items to the end of the $input array.<\/p>\n\n\n\n| Expression<\/th> | Result<\/th><\/tr><\/thead> |
|---|
append([`1`, `2`, `3`], `4`)<\/code><\/td>[1, 2, 3, 4]<\/code><\/td><\/tr>append([`1`, `2`], `3`, `4`)<\/code><\/td>[1, 2, 3, 4]<\/code><\/td><\/tr>append([`1`, `2`], ['c', 'd'])<\/code><\/td>[1, 2, \"c\", \"d\"]<\/code><\/td><\/tr>append([`1`, `2`, `3`], `null`)<\/code><\/td>[1, 2, 3, null]<\/code><\/td><\/tr>append('str', `4`)<\/code><\/td>Error<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n<\/div><\/div>\n\n\n\ncalculate<\/h2>\n\n\n\nnumber calculate(string $expression, object $variables)<\/code><\/pre>\n\n\n\nExecutes a given mathematical formula using the provided variables.<\/p>\n\n\n\n Note<\/strong>: A variable can only be of type: number.<\/p>\n\n\n\nOperators<\/h3>\n\n\n\n- Addition: +<\/li>
- Subtraction: –<\/li>
- Multiplication: *<\/li>
- Division: \/<\/li>
- Modulo: %<\/li>
- Exponentiation: ^<\/li>
- Negation: !<\/li><\/ul>\n\n\n\n
Base functions<\/h3>\n\n\n\n| Function<\/th> | Arguments<\/th> | Description<\/th><\/tr><\/thead> |
|---|
| sin<\/td> | sin(a1)<\/td> | Sine<\/td><\/tr> | | cos<\/td> | cos(a1)<\/td> | Cosine<\/td><\/tr> | | asin<\/td> | asin(a1)<\/td> | Arcsine<\/td><\/tr> | | acos<\/td> | acos(a1)<\/td> | Arccosine<\/td><\/tr> | | tan<\/td> | tan(a1)<\/td> | Tangent<\/td><\/tr> | | cot<\/td> | cot(a1)<\/td> | Cotangent<\/td><\/tr> | | atan<\/td> | atan(a1)<\/td> | Arctangent<\/td><\/tr> | | acot<\/td> | acot(a1)<\/td> | Arccotangent<\/td><\/tr> | | loge<\/td> | loge(a1)<\/td> | Natural logarithm<\/td><\/tr> | | log10<\/td> | log10(a1)<\/td> | Logarithm with base 10<\/td><\/tr> | | logn<\/td> | logn(a1, a2)<\/td> | Logarithm<\/td><\/tr> | | sqrt<\/td> | sqrt(a1)<\/td> | Square root<\/td><\/tr> | | if<\/td> | if(a1, a2, a3)<\/td> | IF a1 IS true THEN a2 ELSE a3<\/td><\/tr> | | max<\/td> | max(a1, …, a_n)<\/td> | Maximum<\/td><\/tr> | | min<\/td> | min(a1, …, a_n)<\/td> | Minimum<\/td><\/tr> | | avg<\/td> | avg(a1, …, a_n)<\/td> | Average<\/td><\/tr> | | median<\/td> | median(a1, …, a_n)<\/td> | Median<\/td><\/tr> | | round<\/td> | round(a1)<\/td> | Round<\/td><\/tr> | | random<\/td> | random()<\/td> | Generate a random double value
between 0.0 and 1.0<\/td><\/tr><\/tbody><\/table>Base functions<\/figcaption><\/figure>\n\n\n\nExamples<\/h3>\n\n\n\n| Expression<\/th> | Result<\/th><\/tr><\/thead> |
|---|
\n\t\t\t\t\tcalculate('a+b', {\"a\": 10, \"b\": 20})<\/code>\n\t\t\t\t<\/td>\n\t\t\t\t\t30.0<\/code>\n\t\t\t\t<\/td><\/tr> calculate('a+b', {\"a\": '10', \"b\": '20'})<\/code> <\/td> 30.0<\/code> <\/td><\/tr>\n\t\t\t\t\tcalculate('a+b', {\"a\": 10.5, \"b\": 20})<\/code>\n\t\t\t\t<\/td>\n\t\t\t\t\t30.5<\/code>\n\t\t\t\t<\/td><\/tr> calculate('a-b', {\"a\": 10, \"b\": 20})<\/code> <\/td>\n\t\t\t\t\t-10.0<\/code>\n\t\t\t\t<\/td><\/tr>\n\t\t\t\t\tcalculate('(a+b)*10', {\"a\": 10, \"b\": 20})<\/code>\n\t\t\t\t<\/td>\n\t\t\t\t\t300.0<\/code>\n\t\t\t\t<\/td><\/tr>calculate('sin(a)*3', {\"a\": 45})<\/code><\/td> 2.552..<\/code> <\/td><\/tr> calculate('(10+20)\/10', null)<\/code> <\/td> 3.0<\/code> <\/td><\/tr>\n\t\t\t\t\tcalculate('a+b', null)<\/code>\n\t\t\t\t<\/td>\n\t\t\t\t\tError<\/code>\n\t\t\t\t<\/td><\/tr>\n\t\t\t\t\tcalculate('a+b', {})<\/code>\n\t\t\t\t<\/td>\n\t\t\t\t\tError<\/code>\n\t\t\t\t<\/td><\/tr>\n\t\t\t\t\tcalculate('10+b', {\"b\": 'aSimpleString'})<\/code>\n\t\t\t\t<\/td>\n\t\t\t\t\tError<\/code>\n\t\t\t\t<\/td><\/tr><\/tbody><\/table>Examples<\/figcaption><\/figure>\n\n\n\n
\n\n\n\n\n current_time<\/h2>\n\n\n\ndatetime current_time(number|string $offset)<\/code><\/pre>\n\n\n\nGets the current time in UTC as a datetime object and adds $offset hours to it. There is no limit for $offset, so it possible to add 30 days. The $offset argument can be a double, but will be converted to an integer. If $offset is a string, it must have an integer format.<\/p>\n\n\n\n For the examples of this function, we assume that the current time is 2021-02-19T12:00:00Z<\/code>.<\/p>\n\n\n\n| Expression<\/th> | Result<\/th><\/tr><\/thead> |
|---|
current_time(`0`)<\/code><\/td>2021-02-19T12:00:00Z<\/code><\/td><\/tr>current_time('0')<\/code><\/td>2021-02-19T12:00:00Z<\/code><\/td><\/tr>current_time(`1`)<\/code><\/td>2021-02-19T13:00:00Z<\/code><\/td><\/tr>current_time(`-1`)<\/code><\/td>2021-02-19T11:00:00Z<\/code><\/td><\/tr>current_time(`24`)<\/code><\/td>2021-02-20T12:00:00Z<\/code><\/td><\/tr>current_time(`0.5`)<\/code><\/td>2021-02-19T12:00:00Z<\/code><\/td><\/tr>current_time('0.5')<\/code><\/td>Error<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n<\/div><\/div>\n\n\n\n\n datasource<\/h2>\n\n\n\njson_object datasource(string $dataSource, string $column, string $value)<\/code><\/pre>\n\n\n\nFetches data from the specified $dataSource, filtering by $value lookup in $column.<\/p>\n\n\n\n
\n\n\n\n<\/p>\n<\/div><\/div>\n\n\n\n \n \n distinct<\/h2>\n\n\n\narray distinct(array $input)<\/code><\/pre>\n\n\n\nRemoves duplicated items from the $input array based on token equality.<\/p>\n\n\n\n \n {\n \"input\": [\n { \"name\": \"Bob\", \"id\": 0 },\n { \"name\": \"Ann\", \"id\": 0 },\n { \"name\": \"Joe\", \"id\": 1 },\n { \"name\": \"Joe\", \"id\": 1 }\n ]\n}<\/code><\/pre>\n\n\n\n[\n { \"name\": \"Bob\", \"id\": 0 },\n { \"name\": \"Ann\", \"id\": 0 },\n { \"name\": \"Joe\", \"id\": 1 }\n]<\/code><\/pre>\n<\/div><\/div>\n\n\n\n
\n<\/div><\/div>\n<\/div><\/div>\n\n\n\n\n \n distinct_by<\/h2>\n\n\n\narray distinct(array $input, &key_function)<\/code><\/pre>\n\n\n\nRemoves duplicated items from the $input array based on the key defined by $key_function.<\/p>\n\n\n\n {\n \"inputA\": [\n { \"name\": \"Bob\", \"id\": 0 },\n { \"name\": \"Ann\", \"id\": 0 },\n { \"name\": \"Joe\", \"id\": 1 },\n { \"name\": \"Xavier\", \"id\": 1 }\n ],\n \"inputB\": [\n { \"name\": \"Bob\" },\n { \"name\": \"Ann\", \"id\": 0 },\n { \"name\": \"Joe\" },\n { \"name\": \"Xavier\", \"id\": 1 }\n ]\n}<\/code><\/pre>\n\n\n\n<\/div><\/div>\n\n\n\n | Expression<\/th> | Result<\/th><\/tr><\/thead> |
|---|
distinct_by(inputA, &id)<\/code><\/td>[{ \"name\": \"Bob\", \"id\": 0 }, { \"name\": \"Joe\", \"id\": 1 }]<\/code><\/td><\/tr>distinct_by(inputB, &id)<\/code><\/td>[{ \"name\": \"Ann\", \"id\": 0 }, { \"name\": \"Xavier\", \"id\": 1 }]<\/code><\/td><\/tr>distinct_by(`[]`, &id)<\/code><\/td>[]<\/code><\/td><\/tr>distinct_by(`null`, &id)<\/code><\/td>null<\/code><\/td><\/tr>distinct_by(`{}`, &id)<\/code><\/td>Error<\/code><\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
\n<\/div><\/div>\n<\/div><\/div>\n\n\n\n | | | | | | | | | |
| | | | | | | | | | | | | |
| | | | | | | | | | | | | | | | | | | |
|
| | | | | | | | | |
| | | | | | | | | | | |