Joomla! Documentation™

The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

JFolder::files

Description

Utility function to read the files in a folder.

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

• Returns array Files in the given folder.
• Defined on line 462 of libraries/joomla/filesystem/folder.php
• Since
• Referenced by
  • JElementModuleLayouts::_getOptions
  • JElementComponentLayouts::_getOptions
  • JInstallerHelper::detectType
  • JInstallerPlugin::discover
  • JInstallerLibrary::discover
  • JInstaller::findManifest
  • JCacheStorageCachelite::getAll
  • JFormFieldModuleLayout::getInput
  • JFormFieldComponentLayout::getInput
  • JFilesystemHelper::getJStreams
  • JFormFieldFileList::getOptions
  • JSession::getStores
  • JCache::getStores
  • JHtmlList::images
  • JAdapter::loadAllAdapters
  • JInstaller::parseSchemaUpdates
  • JLanguage::parseXMLLanguageFiles
  • JInstaller::setSchemaVersion
  • JInstallerPlugin::uninstall
  • JInstallerLibrary::uninstall
  • JInstallerFile::uninstall
  • JInstallerHelper::unpack

See also

• JFolder::files source code on BitBucket
• Class JFolder
• Subpackage Filesystem
• Other versions of JFolder::files

User contributed notes

<CodeExamplesForm />