summaryrefslogtreecommitdiffstats
path: root/user_guide_src/source/general/common_functions.rst
diff options
context:
space:
mode:
Diffstat (limited to 'user_guide_src/source/general/common_functions.rst')
-rw-r--r--user_guide_src/source/general/common_functions.rst13
1 files changed, 13 insertions, 0 deletions
diff --git a/user_guide_src/source/general/common_functions.rst b/user_guide_src/source/general/common_functions.rst
index e085ef808..2dfec9cc0 100644
--- a/user_guide_src/source/general/common_functions.rst
+++ b/user_guide_src/source/general/common_functions.rst
@@ -173,6 +173,19 @@ is_https()
Returns TRUE if a secure (HTTPS) connection is used and FALSE
in any other case (including non-HTTP requests).
+is_cli()
+========
+
+.. php:function:: is_cli()
+
+ :returns: bool
+
+Returns TRUE if the application is run through the command line
+and FALSE if not.
+
+.. note:: This function checks both if the ``PHP_SAPI`` value is 'cli'
+ or if the ``STDIN`` constant is defined.
+
function_usable()
=================