Actions

API17

Difference between revisions of "JFolder::files"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JFolder::files|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JFolder::files|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public static JFolder::files ($path, $filter= '.', $recurse=false, $full=false, $exclude=array('.svn', 'CVS','.DS_Store','__MACOSX'), $excludefilter=array('^\..*','.*~'))
+
public static function files (
 +
        $path
 +
        $filter= '.'
 +
        $recurse=false
 +
        $full=false
 +
        $exclude=array('.svn'
 +
        'CVS'
 +
        '.DS_Store'
 +
        '__MACOSX'
 +
        $excludefilter=array('^\..*'
 +
        '.*~'
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 49: Line 57:
 
|array
 
|array
 
|array('^\..*','.*~')
 
|array('^\..*','.*~')
|Array of filter to exclude  
+
|Array of filter to exclude
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' array Files in the given folder.
array Files in the given folder.
+
* '''Defined''' on line 462 of libraries/joomla/filesystem/folder.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/filesystem/folder.php (line 456)
+
* '''Referenced by'''
* see source code in [[jplatform:filesystem/folder.php#cl-456|BitBucket]]
+
** [[JElementModuleLayouts::_getOptions/11.1|JElementModuleLayouts::_getOptions]]
===Referenced by===
+
** [[JElementComponentLayouts::_getOptions/11.1|JElementComponentLayouts::_getOptions]]
* [[JElementModuleLayouts::_getOptions/11.1|JElementModuleLayouts::_getOptions]]
+
** [[JInstallerHelper::detectType/11.1|JInstallerHelper::detectType]]
* [[JElementComponentLayouts::_getOptions/11.1|JElementComponentLayouts::_getOptions]]
+
** [[JInstallerPlugin::discover/11.1|JInstallerPlugin::discover]]
* [[JInstallerHelper::detectType/11.1|JInstallerHelper::detectType]]
+
** [[JInstallerLibrary::discover/11.1|JInstallerLibrary::discover]]
* [[JInstallerPlugin::discover/11.1|JInstallerPlugin::discover]]
+
** [[JInstaller::findManifest/11.1|JInstaller::findManifest]]
* [[JInstallerLibrary::discover/11.1|JInstallerLibrary::discover]]
+
** [[JCacheStorageCachelite::getAll/11.1|JCacheStorageCachelite::getAll]]
* [[JInstaller::findManifest/11.1|JInstaller::findManifest]]
+
** [[JFormFieldModuleLayout::getInput/11.1|JFormFieldModuleLayout::getInput]]
* [[JCacheStorageCachelite::getAll/11.1|JCacheStorageCachelite::getAll]]
+
** [[JFormFieldComponentLayout::getInput/11.1|JFormFieldComponentLayout::getInput]]
* [[JDatabase::getConnectors/11.1|JDatabase::getConnectors]]
+
** [[JFilesystemHelper::getJStreams/11.1|JFilesystemHelper::getJStreams]]
* [[JFormFieldModuleLayout::getInput/11.1|JFormFieldModuleLayout::getInput]]
+
** [[JFormFieldFileList::getOptions/11.1|JFormFieldFileList::getOptions]]
* [[JFormFieldComponentLayout::getInput/11.1|JFormFieldComponentLayout::getInput]]
+
** [[JSession::getStores/11.1|JSession::getStores]]
* [[JFilesystemHelper::getJStreams/11.1|JFilesystemHelper::getJStreams]]
+
** [[JCache::getStores/11.1|JCache::getStores]]
* [[JFormFieldFileList::getOptions/11.1|JFormFieldFileList::getOptions]]
+
** [[JHtmlList::images/11.1|JHtmlList::images]]
* [[JSession::getStores/11.1|JSession::getStores]]
+
** [[JAdapter::loadAllAdapters/11.1|JAdapter::loadAllAdapters]]
* [[JCache::getStores/11.1|JCache::getStores]]
+
** [[JInstaller::parseSchemaUpdates/11.1|JInstaller::parseSchemaUpdates]]
* [[JHtmlList::images/11.1|JHtmlList::images]]
+
** [[JLanguage::parseXMLLanguageFiles/11.1|JLanguage::parseXMLLanguageFiles]]
* [[JAdapter::loadAllAdapters/11.1|JAdapter::loadAllAdapters]]
+
** [[JInstaller::setSchemaVersion/11.1|JInstaller::setSchemaVersion]]
* [[JInstaller::parseSchemaUpdates/11.1|JInstaller::parseSchemaUpdates]]
+
** [[JInstallerPlugin::uninstall/11.1|JInstallerPlugin::uninstall]]
* [[JLanguage::parseXMLLanguageFiles/11.1|JLanguage::parseXMLLanguageFiles]]
+
** [[JInstallerLibrary::uninstall/11.1|JInstallerLibrary::uninstall]]
* [[JInstaller::setSchemaVersion/11.1|JInstaller::setSchemaVersion]]
+
** [[JInstallerFile::uninstall/11.1|JInstallerFile::uninstall]]
* [[JInstallerPlugin::uninstall/11.1|JInstallerPlugin::uninstall]]
+
** [[JInstallerHelper::unpack/11.1|JInstallerHelper::unpack]]
* [[JInstallerLibrary::uninstall/11.1|JInstallerLibrary::uninstall]]
+
* [[JInstallerFile::uninstall/11.1|JInstallerFile::uninstall]]
+
* [[JInstallerHelper::unpack/11.1|JInstallerHelper::unpack]]
+
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JFolder::files source code''' on [[jplatform:filesystem/folder.php#cl-454|BitBucket]]
 +
* {{JVer|11.1}} Class [[JFolder/11.1|JFolder]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Filesystem/11.1|Filesystem]]
 +
* [[JFolder::files|Other versions of JFolder::files]]
 +
{{SeeAlso:JFolder::files}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JFolder::files|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JFolder::files|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JFolder/11.1|JFolder]]
+
===User contributed notes===
* [[JFolder::files|Other versions of this method]]
+
{{SeeAlso:JFolder::files}}
+
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 96: Line 103:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JFolder]][[Category:JFolder::files]]</noinclude>
 
<noinclude>[[Category:JFolder]][[Category:JFolder::files]]</noinclude>

Revision as of 20: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::files

Description

Utility function to read the files in a folder.

Description:JFolder::files [Edit Descripton]

public static function files (
        $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 file 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 file.
$exclude array array('.svn', 'CVS','.DS_Store','__MACOSX') Array with names of files which should not be shown in the result.
$excludefilter array array('^\..*','.*~') Array of filter to exclude

See also

SeeAlso:JFolder::files [Edit See Also]

User contributed notes

<CodeExamplesForm />