Wattmon Documentation Wiki

User Tools

Site Tools

You are here: start » uphp » functions
Trace:
uphp:functions

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
Next revision Both sides next revision
uphp:functions [2021/01/27 04:44]
admin 		uphp:functions [2021/09/13 05:57]
127.0.0.1 external edit
Line 2: Line 2:
  
 uPHP functions have an identical syntax to PHP functions in most cases. Below is a list of all the functions that have been implemented. uPHP functions have an identical syntax to PHP functions in most cases. Below is a list of all the functions that have been implemented.
 +
 +Certain additional functions are available as WattmonOS include files.  For a list of these see [[.library_functions:library_functions]].
  
 Click on the function name for further details: Click on the function name for further details:
Line 12: Line 14:
 |[[.functions:array_key]]|<html><span style="color:green">array<span style="color:black">, <span style="color:green"> int<span style="color:blue"> index</html>|<html><span style="color:green">string<span style="color:black"> key</html>|<html>Return the key for an <span style="color:green">array <span style="color:blue">index</html>| |[[.functions:array_key]]|<html><span style="color:green">array<span style="color:black">, <span style="color:green"> int<span style="color:blue"> index</html>|<html><span style="color:green">string<span style="color:black"> key</html>|<html>Return the key for an <span style="color:green">array <span style="color:blue">index</html>|
 |[[.functions:array_keys]]|<html><span style="color:green">array<span style="color:black"> with key/value pairs</html>|<html><span style="color:green">array<span style="color:black"> of keys</html>|<html>Return keys for an <span style="color:green">array<span style="color:black"> that has key/value pairs</html>| |[[.functions:array_keys]]|<html><span style="color:green">array<span style="color:black"> with key/value pairs</html>|<html><span style="color:green">array<span style="color:black"> of keys</html>|<html>Return keys for an <span style="color:green">array<span style="color:black"> that has key/value pairs</html>|
 +|[[.functions:array_resize]]|<html><span style="color:green">array<span style="color:black"> indexed array, <span style="color:green">int<span style="color:black"> length</html>|none|<html>Resize indexed <span style="color:green">array<span style="color:black"> </html>|
 |[[.functions:base64_decode]]|<html><span style="color:green">string<span style="color:blue"> base64</html>|<html><span style="color:green">string<span style="color:black"> decoded or <span style="color:green">int<span style="color:black"> 0</html>|<html>Decode a base64-encoded <span style="color:green">string</html>| |[[.functions:base64_decode]]|<html><span style="color:green">string<span style="color:blue"> base64</html>|<html><span style="color:green">string<span style="color:black"> decoded or <span style="color:green">int<span style="color:black"> 0</html>|<html>Decode a base64-encoded <span style="color:green">string</html>|
 |[[.functions:base64_encode]]|<html><span style="color:green">string<span style="color:black"> to encode</html>|<html><span style="color:green">string<span style="color:black"> base64 or <span style="color:green">int<span style="color:black"> 0</html>|<html>Return the base64-encoded version of a <span style="color:green">string</html>| |[[.functions:base64_encode]]|<html><span style="color:green">string<span style="color:black"> to encode</html>|<html><span style="color:green">string<span style="color:black"> base64 or <span style="color:green">int<span style="color:black"> 0</html>|<html>Return the base64-encoded version of a <span style="color:green">string</html>|
Line 26: Line 29:
 |[[.functions:disk_status]]|<html><span style="color:green">int<span style="color:blue"> drive</html>|<html><span style="color:green">int<span style="color:black"> Status</html>|Return mount status of drive| |[[.functions:disk_status]]|<html><span style="color:green">int<span style="color:blue"> drive</html>|<html><span style="color:green">int<span style="color:black"> Status</html>|Return mount status of drive|
 |[[.functions:disk_total_space]]|<html><span style="color:green">int<span style="color:blue"> drive</html>|<html><span style="color:green">int<span style="color:black"> KiloBytes</html>|Return total space on drive| |[[.functions:disk_total_space]]|<html><span style="color:green">int<span style="color:blue"> drive</html>|<html><span style="color:green">int<span style="color:black"> KiloBytes</html>|Return total space on drive|
 +|[[.functions:download]]|<html><span style="color:green">string<span style="color:blue"> url</html>|<html><span style="color:green">int<span style="color:black"> res</html>|Download a file in the background|
 +|[[.functions:download_info]]||<html><span style="color:green">array<span style="color:black"> info</html>|Get info about ongoing download|
 +|[[.functions:download_state]]||<html><span style="color:green">int<span style="color:black"> status</html>|Get state of download|
 |[[.functions:error_reporting]]|<html><span style="color:green">int<span style="color:blue"> verbosity</html>||Set the debug output level| |[[.functions:error_reporting]]|<html><span style="color:green">int<span style="color:blue"> verbosity</html>||Set the debug output level|
 +|[[.functions:ereg]]|<html><span style="color:green">string<span style="color:blue"> pattern<span style="color:black">,<span style="color:green"> string<span style="color:blue"> content [,<span style="color:green"> &amp;array<span style="color:blue"> matches]</html>|<html><span style="color:green">int</html>|<html>Perform a regex operation</html>|
 |[[.functions:exec]]|<html><span style="color:green">string<span style="color:blue"> script<span style="color:black">,<span style="color:green"> int<span style="color:blue"> delay</html>||<html>Run a <span style="color:blue">script<span style="color:black"> with an optional <span style="color:blue">delay</html>| |[[.functions:exec]]|<html><span style="color:green">string<span style="color:blue"> script<span style="color:black">,<span style="color:green"> int<span style="color:blue"> delay</html>||<html>Run a <span style="color:blue">script<span style="color:black"> with an optional <span style="color:blue">delay</html>|
 |[[.functions:exec_action]]|<html><span style="color:green">mixed<span style="color:blue"> action</html>|<html><span style="color:green">int<span style="color:black"> 1=OK</html>|<html>Triggers a manually executable <span style="color:blue">action<span style="color:black"> by id or name</html>| |[[.functions:exec_action]]|<html><span style="color:green">mixed<span style="color:blue"> action</html>|<html><span style="color:green">int<span style="color:black"> 1=OK</html>|<html>Triggers a manually executable <span style="color:blue">action<span style="color:black"> by id or name</html>|
Line 43: Line 50:
 |[[.functions:fopen]]|<html><span style="color:green">string<span style="color:blue"> filename<span style="color:black">,<span style="color:green"> string<span style="color:blue"> mode</html>|<html><span style="color:green">int<span style="color:black"> handle or 0</html>|Open a file for reading or writing| |[[.functions:fopen]]|<html><span style="color:green">string<span style="color:blue"> filename<span style="color:black">,<span style="color:green"> string<span style="color:blue"> mode</html>|<html><span style="color:green">int<span style="color:black"> handle or 0</html>|Open a file for reading or writing|
 |[[.functions:fread]]|<html><span style="color:green">int<span style="color:blue"> handle<span style="color:black">,<span style="color:green"> int<span style="color:blue"> bytes</html>|<html><span style="color:green">string<span style="color:black"> or <span style="color:green">int<span style="color:black"> 0</html>|<html>Read <span style="color:blue">bytes<span style="color:black"> from a file, stream or socket</html>| |[[.functions:fread]]|<html><span style="color:green">int<span style="color:blue"> handle<span style="color:black">,<span style="color:green"> int<span style="color:blue"> bytes</html>|<html><span style="color:green">string<span style="color:black"> or <span style="color:green">int<span style="color:black"> 0</html>|<html>Read <span style="color:blue">bytes<span style="color:black"> from a file, stream or socket</html>|
 +|[[.functions:fread_unpack]]|<html><span style="color:green">int<span style="color:blue"> handle<span style="color:black">,<html><span style="color:green">string<span style="color:blue"> format<span style="color:black">, <span style="color:green">int <span style="color:blue"> count<span style="color:black">, <span style="color:green">int <span style="color:blue"> interval<span style="color:black"></html> |<html><span style="color:green">number</html>|<html>Write contents of an indexed array to a file in binary<span style="color:black"></html>|
 +
 |[[.functions:freemem]]||<html><span style="color:green">int<span style="color:black"> bytes</html>|Return free memory space| |[[.functions:freemem]]||<html><span style="color:green">int<span style="color:black"> bytes</html>|Return free memory space|
 |[[.functions:freestack]]||<html><span style="color:green">int<span style="color:black"> bytes</html>|Return free stack space| |[[.functions:freestack]]||<html><span style="color:green">int<span style="color:black"> bytes</html>|Return free stack space|
Line 57: Line 66:
 |[[.functions:ftp_is_connecting]]|<html><span style="color:green">int<span style="color:blue"> result</html>|| Check if the FTP connection is in the process of connecting| |[[.functions:ftp_is_connecting]]|<html><span style="color:green">int<span style="color:blue"> result</html>|| Check if the FTP connection is in the process of connecting|
 |[[.functions:ftp_list]]|<html><span style="color:green">int<span style="color:blue"> result</html>|<html><span style="color:green">string<span style="color:black"> folder</html>, <html><span style="color:green">string<span style="color:black"> output_file</html>|Lists a folder on the FTP server and outputs the result to the specified file| |[[.functions:ftp_list]]|<html><span style="color:green">int<span style="color:blue"> result</html>|<html><span style="color:green">string<span style="color:black"> folder</html>, <html><span style="color:green">string<span style="color:black"> output_file</html>|Lists a folder on the FTP server and outputs the result to the specified file|
-|[[.functions:ftp_open]]|<html><span style="color:green">int<span style="color:blue"> result</html>|<html><span style="color:green">string<span style="color:black"> host</html>, <html><span style="color:green">int<span style="color:black"> port</html>, <html><span style="color:green">string<span style="color:black"> username</html>, <html><span style="color:green">string<span style="color:black"> password</html>|Open a connection to an FTP server|+|[[.functions:ftp_open]]|<html><span style="color:green">int<span style="color:blue"> result</html>|<html><span style="color:green">string<span style="color:black"> host</html>, <html><span style="color:green">int<span style="color:black"> port</html>, <html><span style="color:green">string<span style="color:black"> username</html>, <html><span style="color:green">string<span style="color:black"> password</html>, <html><span style="color:green">int<span style="color:black"> keepalive</html>, <html><span style="color:green">int<span style="color:black"> ignore_reply</html>|Open a connection to an FTP server|
 |[[.functions:ftp_size]]|<html><span style="color:green">int<span style="color:blue"> size</html>|<html><span style="color:green">string<span style="color:black"> filename</html>|Get the file size of a file on the FTP server| |[[.functions:ftp_size]]|<html><span style="color:green">int<span style="color:blue"> size</html>|<html><span style="color:green">string<span style="color:black"> filename</html>|Get the file size of a file on the FTP server|
 |[[.functions:ftp_status]]|<html><span style="color:green">array<span style="color:blue"> status</html>||Get the FTP engine status including upload and download completion information |[[.functions:ftp_status]]|<html><span style="color:green">array<span style="color:blue"> status</html>||Get the FTP engine status including upload and download completion information
Line 63: Line 72:
 |[[.functions:function_exists]]|<html><span style="color:green">string<span style="color:blue"> function_name</html>|<html><span style="color:green">int<span style="color:black"> 1 or 0</html>|Check if a function exists (custom or native)| |[[.functions:function_exists]]|<html><span style="color:green">string<span style="color:blue"> function_name</html>|<html><span style="color:green">int<span style="color:black"> 1 or 0</html>|Check if a function exists (custom or native)|
 |[[.functions:fwrite]]|<html><span style="color:green">int<span style="color:blue"> handle<span style="color:black">, <span style="color:green">mixed <span style="color:blue">data<span style="color:black">, <span style="color:green">int <span style="color:blue">length</html>|<html><span style="color:green">int<span style="color:black"> bytes written or -1</html>|<html>Write <span style="color:blue">data<span style="color:black"> to a file, stream or socket</html>| |[[.functions:fwrite]]|<html><span style="color:green">int<span style="color:blue"> handle<span style="color:black">, <span style="color:green">mixed <span style="color:blue">data<span style="color:black">, <span style="color:green">int <span style="color:blue">length</html>|<html><span style="color:green">int<span style="color:black"> bytes written or -1</html>|<html>Write <span style="color:blue">data<span style="color:black"> to a file, stream or socket</html>|
 +|[[.functions:fwrite_pack]]|<html><span style="color:green">int<span style="color:blue"> handle<span style="color:black">,<html><span style="color:green">array<span style="color:blue"> data<span style="color:black">, <span style="color:green">int <span style="color:blue"> length<span style="color:black"></html> |<html><span style="color:green">number</html>|<html>Write contents of an indexed array to a file in binary<span style="color:black"></html>|
 |[[.functions:get3gstat]]||<html><span style="color:green">array</html>|Get cellular data connection status information| |[[.functions:get3gstat]]||<html><span style="color:green">array</html>|Get cellular data connection status information|
 |[[.functions:getcwd]]||<html><span style="color:green">string<span style="color:black"> path</html>|Get the current directory| |[[.functions:getcwd]]||<html><span style="color:green">string<span style="color:black"> path</html>|Get the current directory|
 |[[.functions:getethstat]]||<html><span style="color:green">array</html>|Get Ethernet connection status information| |[[.functions:getethstat]]||<html><span style="color:green">array</html>|Get Ethernet connection status information|
 |[[.functions:getmac]]||<html><span style="color:green">string<span style="color:black"> MAC</html>|Get the Wattmon's MAC address| |[[.functions:getmac]]||<html><span style="color:green">string<span style="color:black"> MAC</html>|Get the Wattmon's MAC address|
 +|[[.functions:gettype]]|<html><span style="color:green">any<span style="color:blue"> variable<span style="color:black"></html>|<html><span style="color:green">string<span style="color:black"> type</html>|Get a variable type as a string|
 |[[.functions:getusbstat]]||<html><span style="color:green">array</html>|Get USB host status information| |[[.functions:getusbstat]]||<html><span style="color:green">array</html>|Get USB host status information|
 |[[.functions:getwifistat]]||<html><span style="color:green">array</html>|Get WIFI status information| |[[.functions:getwifistat]]||<html><span style="color:green">array</html>|Get WIFI status information|
Line 183: Line 194:
 |[[.functions:sqrt]]|<html><span style="color:green">number<span style="color:blue"> number</html>|<html><span style="color:green">number<span style="color:black"> square root</html>|Return the square root of a <html><span style="color:blue">number</html>| |[[.functions:sqrt]]|<html><span style="color:green">number<span style="color:blue"> number</html>|<html><span style="color:green">number<span style="color:black"> square root</html>|Return the square root of a <html><span style="color:blue">number</html>|
 |[[.functions:stats]]||<html><span style="color:green">array</html>|Return system statistics| |[[.functions:stats]]||<html><span style="color:green">array</html>|Return system statistics|
 +|[[.functions:str_replace]]|<html><span style="color:green">string<span style="color:blue"> search<span style="color:black">, <span style="color:green">string<span style="color:blue"> replace, <span style="color:green">string<span style="color:blue"> subject</html>|<html><span style="color:green">string<span style="color:black"> result</html>|<html>Return the string with each occurrence of <span style="color:blue">search<span style="color:black"> replaced with <span style="color:blue">replace<span style="color:black"></html>|
 |[[.functions:strftime]]|<html><span style="color:green">string<span style="color:blue"> format<span style="color:black">,<span style="color:green"> int<span style="color:blue"> timestamp</html>|<html><span style="color:green">string<span style="color:black"> formatted</html>|<html>Format a Linux <span style="color:blue">Timestamp<span style="color:black"> using a <span style="color:blue">format <span style="color:green">string</html>| |[[.functions:strftime]]|<html><span style="color:green">string<span style="color:blue"> format<span style="color:black">,<span style="color:green"> int<span style="color:blue"> timestamp</html>|<html><span style="color:green">string<span style="color:black"> formatted</html>|<html>Format a Linux <span style="color:blue">Timestamp<span style="color:black"> using a <span style="color:blue">format <span style="color:green">string</html>|
 |[[.functions:strlen]]|<html><span style="color:green">string<span style="color:blue"> input</html>|<html><span style="color:green">int<span style="color:black"> length</html>|Return the length of a <html><span style="color:green">string</html>| |[[.functions:strlen]]|<html><span style="color:green">string<span style="color:blue"> input</html>|<html><span style="color:green">int<span style="color:black"> length</html>|Return the length of a <html><span style="color:green">string</html>|
uphp/functions.txt · Last modified: 2022/09/23 04:53 by admin

Page Tools

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki