General function reference
Many functions in Phi are based directly on PHP functions of the same name, so the links below link to the function description on PHP.net.
The following general purpose functions are available in Phi:
-
abs
(number)returns
numberReturns the absolute value of a number.
-
acos
(number)returns
radiansReturns the arc cosine (in radians) of the input.
-
acosh
(number)returns
numberReturns the inverse hyperbolic cosine of the input.
-
array
(numbers/strings)returns
arrayThis combines its inputs together into an array.
-
array_merge
(arrays)returns
arrayThis merges two or more arrays together into one array.
-
asin
(number)returns
radiansReturns the arc sine (in radians) of the input.
-
asinh
(number)returns
numberReturns the inverse hyperbolic sine of the input.
-
atan
(number)returns
radiansReturns the arc tangent (in radians) of the input.
-
atan2
(number)returns
number -
atanh
(number)returns
numberReturns the inverse hyperbolic tangent of the input.
-
base_convert
(number, frombase, tobase)returns
stringConverts a number between bases. E.g.
base_convert('17', 8, 10) == 15 -
bindec
(binary-string)returns
numberConverts a binary string to a number. E.g.
base_convert('101') == 5 -
c
(numbers/strings)returns
arrayAn alias of
array(), this combines its inputs together into an array. -
ceil
(number)returns
numberRounds a float up to the nearest integer value.
-
cos
(radians)returns
numberReturns the cosine of the input, which needs to be in radians.
-
cosh
(number)returns
numberReturns the hyperbolic cosine of the input.
-
count
(array)returns
numberCounts the number of elements in an array.
-
cycle
(array, index)returns
elementReturns an element from an array at the specified index. If the specified index is too high then it will wrap round back to the start of the array.
-
decbin
(number)returns
binary-stringConverts an integer into a binary string, e.g.
decbin(5) == '101'. -
dechex
(number)returns
hexadecimal-stringConverts an integer into a hexadecimal string, e.g.
dechex(15) == 'F'. -
decoct
(number)returns
octal-stringConverts an integer into an octal string, e.g.
decoct(15) == '17'. -
deg2rad
(degrees)returns
radiansConverts an an in degrees into a number in radians.
-
factorial
(number)returns
numberReturns the factorial of the number entered.
-
firstQuartile
(array/numbers)returns
numberReturns the first or lower quartile of the numbers entered.
-
float
(mixed)returns
numberConverts an integer or a string to a floating point number if possible.
-
floor
(number)returns
numberRounds a float down to the nearest integer value.
-
gcd
(number, number)returns
numberReturns the greatest common divider of two integers.
-
hexdec
(hexadecimal-string)returns
numberConverts a hexadecimal string into an integer, e.g.
hexdec('F') == 15. -
int
(mixed)returns
numberConverts a floating point number or a string to an integer if possible.
-
is_finite
(number)returns
booleanChecks whether a float is finite.
-
is_infinite
(number)returns
booleanChecks whether a float is infinite.
-
is_nan
(number)returns
booleanChecks for floats marked as "non a number", e.g.
is_nan(sqrt(-1)). -
lcm
(number, number)returns
numberReturns the least common multiple of two integers.
-
length
(array/string)returns
numberReturns the length of a string, or the number of elements in an array.
-
list
(numbers/strings)returns
arrayAn alias of
array(), this combines its inputs together into an array. -
log
(number[, base])returns
numberCalculates a logarithm.
-
log10
(number)returns
numberCalculates the base-10 logarithm of the input.
-
lowerQuartile
(array/numbers)returns
numberReturns the first or lower quartile of the numbers entered.
-
max
(array/numbers)returns
numberReturns the largest of the numbers entered.
-
mean
(array/numbers)returns
numberReturns the mean of the numbers entered.
-
median
(array/numbers)returns
numberReturns the median of the numbers entered.
-
min
(array/numbers)returns
numberReturns the smallest of the numbers entered.
-
mode
(array/numbers)returns
numberReturns the most common value from the numbers entered.
-
octdec
(octal-string)returns
numberConverts an octal string into an integer, e.g.
octdec('17') == 15. -
paste
(strings)returns
stringConcatenates strings together, joining them together with a space between each.
-
print
(string)returns
nullThis allows you to check the value of variables while testing your code. The data processor ignores this function.
-
product
(array/numbers)returns
numberReturns the product of the numbers entered.
-
rad2deg
(radians)returns
degreesConverts an an in degrees into a number in radians.
-
random
(array/number/string)returns
element/number/characterReturns a random element from an array, a random character from a string, or a random integer less than or equal to the number provided.
-
range
(start, stop[, step])returns
arrayGenerates an array of integers.
-
return
()Call this to end the current Phi script. Any code after this will not be run.
Note that this is a function, so you need to include the brackets when calling it. -
rev
(array/numbers/strings)returns
arrayAn alias of
reverse, this returns an array with the inputs in reverse order. -
reverse
(array/numbers/strings)returns
arrayThis returns an array with the inputs in reverse order.
-
round
(number[, precision])returns
numberRounds the input to the specified number of decimal places.
-
shuffle
(array/numbers/strings)returns
arrayThis makes a randomly shuffled array from the inputs.
-
sin
(radians)returns
numberReturns the sine of the input, which needs to be in radians.
-
sinh
(number)returns
numberReturns the hyperbolic sine of the input.
-
sort
(array/numbers/strings)returns
arrayThis makes a sorted array from the inputs.
-
sqrt
(number)returns
numberReturns the square root of the input.
-
standardDev
(array/numbers)returns
numberReturns the standard deviation of the numbers entered.
-
string
(mixed)returns
stringConverts a number to a string.
-
sum
(array/numbers)returns
numberReturns the total of the numbers entered.
-
tan
(radians)returns
numberReturns the tangent of the input, which needs to be in radians.
-
tanh
(number)returns
numberReturns the hyperbolic tangent of the input.
-
thirdQuartile
(array/numbers)returns
numberReturns the third or upper quartile of the numbers entered.
-
trim
(string)returns
stringStrips whitespace from the beginning and end of a string.
-
upperQuartile
(array/numbers)returns
numberReturns the third or upper quartile of the numbers entered.