API17

Difference between revisions of "JFolder::files"

From Joomla! Documentation

(Layout updates)
m (preparing for archive only)
 
(5 intermediate revisions by 2 users not shown)
Line 4: Line 4:
 
Utility function to read the files in a folder.  
 
Utility function to read the files in a folder.  
  
−
{{Description:JFolder::files}}
+
 
−
<span class="editsection" style="font-size:76%;">
+
 
−
<nowiki>[</nowiki>[[Description:JFolder::files|Edit Descripton]]<nowiki>]</nowiki>
 
−
</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 55:
 
|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]]
+
** [[API17:JElementModuleLayouts::_getOptions|JElementModuleLayouts::_getOptions]]
−
===Referenced by===
+
** [[API17:JElementComponentLayouts::_getOptions|JElementComponentLayouts::_getOptions]]
−
* [[JElementModuleLayouts::_getOptions/11.1|JElementModuleLayouts::_getOptions]]
+
** [[API17:JInstallerHelper::detectType|JInstallerHelper::detectType]]
−
* [[JElementComponentLayouts::_getOptions/11.1|JElementComponentLayouts::_getOptions]]
+
** [[API17:JInstallerPlugin::discover|JInstallerPlugin::discover]]
−
* [[JInstallerHelper::detectType/11.1|JInstallerHelper::detectType]]
+
** [[API17:JInstallerLibrary::discover|JInstallerLibrary::discover]]
−
* [[JInstallerPlugin::discover/11.1|JInstallerPlugin::discover]]
+
** [[API17:JInstaller::findManifest|JInstaller::findManifest]]
−
* [[JInstallerLibrary::discover/11.1|JInstallerLibrary::discover]]
+
** [[API17:JCacheStorageCachelite::getAll|JCacheStorageCachelite::getAll]]
−
* [[JInstaller::findManifest/11.1|JInstaller::findManifest]]
+
** [[API17:JFormFieldModuleLayout::getInput|JFormFieldModuleLayout::getInput]]
−
* [[JCacheStorageCachelite::getAll/11.1|JCacheStorageCachelite::getAll]]
+
** [[API17:JFormFieldComponentLayout::getInput|JFormFieldComponentLayout::getInput]]
−
* [[JDatabase::getConnectors/11.1|JDatabase::getConnectors]]
+
** [[API17:JFilesystemHelper::getJStreams|JFilesystemHelper::getJStreams]]
−
* [[JFormFieldModuleLayout::getInput/11.1|JFormFieldModuleLayout::getInput]]
+
** [[API17:JFormFieldFileList::getOptions|JFormFieldFileList::getOptions]]
−
* [[JFormFieldComponentLayout::getInput/11.1|JFormFieldComponentLayout::getInput]]
+
** [[API17:JSession::getStores|JSession::getStores]]
−
* [[JFilesystemHelper::getJStreams/11.1|JFilesystemHelper::getJStreams]]
+
** [[API17:JCache::getStores|JCache::getStores]]
−
* [[JFormFieldFileList::getOptions/11.1|JFormFieldFileList::getOptions]]
+
** [[API17:JHtmlList::images|JHtmlList::images]]
−
* [[JSession::getStores/11.1|JSession::getStores]]
+
** [[API17:JAdapter::loadAllAdapters|JAdapter::loadAllAdapters]]
−
* [[JCache::getStores/11.1|JCache::getStores]]
+
** [[API17:JInstaller::parseSchemaUpdates|JInstaller::parseSchemaUpdates]]
−
* [[JHtmlList::images/11.1|JHtmlList::images]]
+
** [[API17:JLanguage::parseXMLLanguageFiles|JLanguage::parseXMLLanguageFiles]]
−
* [[JAdapter::loadAllAdapters/11.1|JAdapter::loadAllAdapters]]
+
** [[API17:JInstaller::setSchemaVersion|JInstaller::setSchemaVersion]]
−
* [[JInstaller::parseSchemaUpdates/11.1|JInstaller::parseSchemaUpdates]]
+
** [[API17:JInstallerPlugin::uninstall|JInstallerPlugin::uninstall]]
−
* [[JLanguage::parseXMLLanguageFiles/11.1|JLanguage::parseXMLLanguageFiles]]
+
** [[API17:JInstallerLibrary::uninstall|JInstallerLibrary::uninstall]]
−
* [[JInstaller::setSchemaVersion/11.1|JInstaller::setSchemaVersion]]
+
** [[API17:JInstallerFile::uninstall|JInstallerFile::uninstall]]
−
* [[JInstallerPlugin::uninstall/11.1|JInstallerPlugin::uninstall]]
+
** [[API17:JInstallerHelper::unpack|JInstallerHelper::unpack]]
−
* [[JInstallerLibrary::uninstall/11.1|JInstallerLibrary::uninstall]]
 
−
* [[JInstallerFile::uninstall/11.1|JInstallerFile::uninstall]]
 
−
* [[JInstallerHelper::unpack/11.1|JInstallerHelper::unpack]]
 
 
===See also===
 
===See also===
−
<span class="editsection" style="font-size:76%;">
+
* {{JVer|11.1}} '''JFolder::files source code''' on [[jplatform:filesystem/folder.php#cl-454|BitBucket]]
−
<nowiki>[</nowiki>[[SeeAlso:JFolder::files|Edit See Also]]<nowiki>]</nowiki>
+
* {{JVer|11.1}} Class [[API17:JFolder|JFolder]]
−
</span>
+
* {{JVer|11.1}} Subpackage [[API17:Subpackage_Filesystem|Filesystem]]
−
* [[JFolder/11.1|JFolder]]
+
* [[API17:JFolder::files|Other versions of JFolder::files]]
−
* [[JFolder::files|Other versions of this method]]
+
 
−
{{SeeAlso:JFolder::files}}
+
 
−
===Examples===
+
===User contributed notes===
−
<CodeExamplesForm />
+
=== Code Examples ===
 
<dpl>
 
<dpl>
 
noresultsheader=\n
 
noresultsheader=\n
 
category=JFolder::files
 
category=JFolder::files
−
category=CodeExample
+
namespace=CodeExample
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
−
<noinclude>[[Category:JFolder]][[Category:JFolder::files]]</noinclude>
+
<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

Latest revision as of 22:03, 24 March 2017

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.

Joomla 11.1 JFolder::files[edit]

Description[edit]

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

See also[edit]


User contributed notes[edit]

Code Examples[edit]


Retrieved from "https://docs.joomla.org/index.php?title=API17:JFolder::files&oldid=385090"