aboutsummaryrefslogtreecommitdiff
path: root/engine/lib/elgglib.php
diff options
context:
space:
mode:
authoricewing <icewing@36083f99-b078-4883-b0ff-0f9b5a30f544>2008-06-04 10:34:43 +0000
committericewing <icewing@36083f99-b078-4883-b0ff-0f9b5a30f544>2008-06-04 10:34:43 +0000
commitb60ef4114772f1b14cb8ab08c343742c13209a2a (patch)
treea46265553c6724ba2e9e9485e6955c9ddb5b57a2 /engine/lib/elgglib.php
parent994176b5bd7e87e36dc0bf2643f827d1fdfaf5f1 (diff)
downloadelgg-b60ef4114772f1b14cb8ab08c343742c13209a2a.tar.gz
elgg-b60ef4114772f1b14cb8ab08c343742c13209a2a.tar.bz2
Marcus Povey <marcus@dushka.co.uk>
* Minor documentation git-svn-id: https://code.elgg.org/elgg/trunk@788 36083f99-b078-4883-b0ff-0f9b5a30f544
Diffstat (limited to 'engine/lib/elgglib.php')
-rw-r--r--engine/lib/elgglib.php4
1 files changed, 3 insertions, 1 deletions
diff --git a/engine/lib/elgglib.php b/engine/lib/elgglib.php
index 790888566..9fb8b35c4 100644
--- a/engine/lib/elgglib.php
+++ b/engine/lib/elgglib.php
@@ -1048,7 +1048,9 @@
* This function checks to see if it is being called at somepoint by a function defined somewhere
* on a given path (optionally including subdirectories).
*
- * @param string $path The full path and filename that this function must have in its call stack
+ * This function is similar to call_gatekeeper() but returns true if it is being called by a method or function which has been defined on a given path or by a specified file.
+ *
+ * @param string $path The full path and filename that this function must have in its call stack If a partial path is given and $include_subdirs is true, then the function will return true if called by any function in or below the specified path.
* @param bool $include_subdirs Are subdirectories of the path ok, or must you specify an absolute path and filename.
* @param bool $strict_mode If true then the calling method or function must be directly called by something on $path, if false the whole call stack is searched.
*/