gnh1201/seeddms-code
1
0
Fork 0
mirror of https://git.code.sf.net/p/seeddms/code synced 2024-11-26 23:42:11 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add more documentation for isSubFolder()

Browse Source
This commit is contained in:
Uwe Steinmann 2021-09-22 09:47:40 +02:00
parent 674002c02f
commit 5a587e5c85
1 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
SeedDMS_Core/Core/inc.ClassFolder.php
View File

@ -383,11 +383,15 @@ class SeedDMS_Core_Folder extends SeedDMS_Core_Object {
/**
* Check if the folder is subfolder
*
* This function checks if the passed folder is a subfolder of the current
* folder.
* This method checks if the current folder is in the path of the
* passed subfolder. In that case the current folder is a parent,
* grant parent, grant grant parent, etc. of the subfolder or
* to say it differently the passed folder is somewhere below the
* current folder.
*
* @param SeedDMS_Core_Folder $subfolder
* @return bool true if passes folder is a subfolder
* @param SeedDMS_Core_Folder $subfolder folder to be checked if it is
* a subfolder on any level of the current folder
* @return bool true if passed folder is a subfolder, otherwise false
*/
function isSubFolder($subfolder) { /* {{{ */
$target_path = $subfolder->getPath();