Actions

API17

Difference between revisions of "JFolder::folders"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
(Updated to r1448:247ba8d88526)
(One intermediate revision by one user not shown)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JFolder::folders|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JFolder::folders|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public static JFolder::folders ($path, $filter= '.', $recurse=false, $full=false, $exclude=array('.svn', 'CVS','.DS_Store','__MACOSX'), $excludefilter=array('^\..*'))
+
public static function folders (
 +
        $path
 +
        $filter= '.'
 +
        $recurse=false
 +
        $full=false
 +
        $exclude=array('.svn'
 +
        'CVS'
 +
        '.DS_Store'
 +
        '__MACOSX'
 +
        $excludefilter=array('^\..*'
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 49: Line 56:
 
|array
 
|array
 
|array('^\..*')
 
|array('^\..*')
|Array with regular expressions matching folders which should not be shown in the result.  
+
|Array with regular expressions matching folders which should not be shown in the result.
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' array Folders in the given folder.
array Folders in the given folder.
+
* '''Defined''' on line 506 of libraries/joomla/filesystem/folder.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/filesystem/folder.php
+
* '''Referenced by'''
===Referenced by===
+
** [[JTableMenu::check/11.1|JTableMenu::check]]
* [[JTableMenu/check/11.1|JTableMenu::check]]
+
** [[JInstallerTemplate::discover/11.1|JInstallerTemplate::discover]]
* [[JInstallerTemplate/discover/11.1|JInstallerTemplate::discover]]
+
** [[JInstallerPlugin::discover/11.1|JInstallerPlugin::discover]]
* [[JInstallerPlugin/discover/11.1|JInstallerPlugin::discover]]
+
** [[JInstallerComponent::discover/11.1|JInstallerComponent::discover]]
* [[JInstallerComponent/discover/11.1|JInstallerComponent::discover]]
+
** [[JInstallerModule::discover/11.1|JInstallerModule::discover]]
* [[JInstallerModule/discover/11.1|JInstallerModule::discover]]
+
** [[JInstallerLanguage::discover/11.1|JInstallerLanguage::discover]]
* [[JInstallerLanguage/discover/11.1|JInstallerLanguage::discover]]
+
** [[JCacheStorageCachelite::getAll/11.1|JCacheStorageCachelite::getAll]]
* [[JCacheStorageCachelite/getAll/11.1|JCacheStorageCachelite::getAll]]
+
** [[JDatabase::getConnectors/11.1|JDatabase::getConnectors]]
* [[JFormFieldFolderList/getOptions/11.1|JFormFieldFolderList::getOptions]]
+
** [[JFormFieldFolderList::getOptions/11.1|JFormFieldFolderList::getOptions]]
* [[JLanguage/parseLanguageFiles/11.1|JLanguage::parseLanguageFiles]]
+
** [[JLanguage::parseLanguageFiles/11.1|JLanguage::parseLanguageFiles]]
* [[JInstallerHelper/unpack/11.1|JInstallerHelper::unpack]]
+
** [[JInstallerHelper::unpack/11.1|JInstallerHelper::unpack]]
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JFolder::folders source code''' on [[jplatform:filesystem/folder.php#cl-498|BitBucket]]
 +
* {{JVer|11.1}} Class [[JFolder/11.1|JFolder]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Filesystem/11.1|Filesystem]]
 +
* [[JFolder::folders|Other versions of JFolder::folders]]
 +
{{SeeAlso:JFolder::folders}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JFolder::folders|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JFolder::folders|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JFolder/11.1|JFolder]]
+
===User contributed notes===
* [[JFolder::folders|Other versions of this method]]
+
{{SeeAlso:JFolder::folders}}
+
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 82: Line 91:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JFolder]][[Category:JFolder::folders]]</noinclude>
 
<noinclude>[[Category:JFolder]][[Category:JFolder::folders]]</noinclude>

Revision as of 19:58, 27 April 2011

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 JFolder::folders

Description

Utility function to read the folders in a folder.

Description:JFolder::folders [Edit Descripton]

public static function folders (
        $path
        $filter= '.'
        $recurse=false
        $full=false
        $exclude=array('.svn'
        'CVS'
        '.DS_Store'
        '__MACOSX'
        $excludefilter=array('^\..*'
)
Parameter Type Default Description
$path string The path of the folder to read.
$filter string '.' A filter for folder names.
$recurse mixed false True to recursively search into sub-folders, or an integer to specify the maximum depth.
$full boolean false True to return the full path to the folders.
$exclude array array('.svn', 'CVS','.DS_Store','__MACOSX') Array with names of folders which should not be shown in the result.
$excludefilter array array('^\..*') Array with regular expressions matching folders which should not be shown in the result.

See also

SeeAlso:JFolder::folders [Edit See Also]

User contributed notes

<CodeExamplesForm />