API17:JFolder::listFolderTree
From Joomla! Documentation
(Difference between revisions)
(Bulk upload by Doxiki2) |
(Updated to r1448:247ba8d88526) |
||
| (One intermediate revision by one user not shown) | |||
| Line 8: | Line 8: | ||
<nowiki>[</nowiki>[[Description:JFolder::listFolderTree|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JFolder::listFolderTree|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
<source lang="php"> | <source lang="php"> | ||
| − | public static | + | public static function listFolderTree ( |
| + | $path | ||
| + | $filter | ||
| + | $maxLevel=3 | ||
| + | $level=0 | ||
| + | $parent=0 | ||
| + | ) | ||
</source> | </source> | ||
{| class="wikitable" | {| class="wikitable" | ||
| Line 44: | Line 47: | ||
|integer | |integer | ||
|0 | |0 | ||
| − | |Unique identifier of the parent folder, if any. | + | |Unique identifier of the parent folder, if any. |
|- | |- | ||
|} | |} | ||
| − | + | * '''Returns''' array Folders in the given folder. | |
| − | array Folders in the given folder. | + | * '''Defined''' on line 609 of libraries/joomla/filesystem/folder.php |
| − | + | * '''Since''' {{JVer|11.1 }} | |
| − | libraries/joomla/filesystem/folder.php | + | |
| − | + | ||
===See also=== | ===See also=== | ||
| + | * {{JVer|11.1}} '''JFolder::listFolderTree source code''' on [[jplatform:filesystem/folder.php#cl-601|BitBucket]] | ||
| + | * {{JVer|11.1}} Class [[JFolder/11.1|JFolder]] | ||
| + | * {{JVer|11.1}} Subpackage [[Subpackage_Filesystem/11.1|Filesystem]] | ||
| + | * [[JFolder::listFolderTree|Other versions of JFolder::listFolderTree]] | ||
| + | {{SeeAlso:JFolder::listFolderTree}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JFolder::listFolderTree|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JFolder::listFolderTree|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | + | ===User contributed notes=== | |
| − | + | ||
| − | + | ||
| − | === | + | |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 67: | Line 70: | ||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:JFolder]][[Category:JFolder::listFolderTree]]</noinclude> | <noinclude>[[Category:JFolder]][[Category:JFolder::listFolderTree]]</noinclude> | ||
Revision as of 20:58, 27 April 2011
JFolder::listFolderTree
Description
Lists folder in format suitable for tree display.
Description:JFolder::listFolderTree [Edit Descripton]
public static function listFolderTree ( $path $filter $maxLevel=3 $level=0 $parent=0 )
| Parameter | Type | Default | Description |
|---|---|---|---|
| $path | string | The path of the folder to read. | |
| $filter | string | A filter for folder names. | |
| $maxLevel | integer | 3 | The maximum number of levels to recursively read, defaults to three. |
| $level | integer | 0 | The current level, optional. |
| $parent | integer | 0 | Unique identifier of the parent folder, if any. |
- Returns array Folders in the given folder.
- Defined on line 609 of libraries/joomla/filesystem/folder.php
- Since
See also
- JFolder::listFolderTree source code on BitBucket
- Class JFolder
- Subpackage Filesystem
- Other versions of JFolder::listFolderTree
SeeAlso:JFolder::listFolderTree [Edit See Also]
User contributed notes
<CodeExamplesForm />
