Actions

API17

Difference between revisions of "JFolder"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
 +
=={{JVer|11.1}} JFolder==
 +
===Description===
 +
{{Description:JFolder}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[Description:JFolder|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JFolder|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
{{Description:JFolder}}
 
===Defined in===
 
libraries/joomla/filesystem/folder.php
 
* see source code in [[jplatform:filesystem/folder.php|BitBucket]]
 
===Subpackage===
 
[[Subpackage Filesystem/11.1|Filesystem]]
 
===Extends===
 
===Extended by===
 
 
===Methods===
 
===Methods===
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 
|-
 
|-
 +
!Visibility
 
!Method name
 
!Method name
 
!Description
 
!Description
 
|-
 
|-
 +
|public static
 
|[[JFolder::copy/11.1|copy]]
 
|[[JFolder::copy/11.1|copy]]
 
|Copy a folder.  
 
|Copy a folder.  
 
|-
 
|-
 +
|public static
 
|[[JFolder::create/11.1|create]]
 
|[[JFolder::create/11.1|create]]
 
|Create a folder -- and all necessary parent folders.  
 
|Create a folder -- and all necessary parent folders.  
 
|-
 
|-
 +
|public static
 
|[[JFolder::delete/11.1|delete]]
 
|[[JFolder::delete/11.1|delete]]
 
|Delete a folder.  
 
|Delete a folder.  
 
|-
 
|-
 +
|public static
 
|[[JFolder::exists/11.1|exists]]
 
|[[JFolder::exists/11.1|exists]]
 
|Wrapper for the standard file_exists function.  
 
|Wrapper for the standard file_exists function.  
 
|-
 
|-
 +
|public static
 
|[[JFolder::files/11.1|files]]
 
|[[JFolder::files/11.1|files]]
 
|Utility function to read the files in a folder.  
 
|Utility function to read the files in a folder.  
 
|-
 
|-
 +
|public static
 
|[[JFolder::folders/11.1|folders]]
 
|[[JFolder::folders/11.1|folders]]
 
|Utility function to read the folders in a folder.  
 
|Utility function to read the folders in a folder.  
 
|-
 
|-
 +
|public static
 
|[[JFolder::listFolderTree/11.1|listFolderTree]]
 
|[[JFolder::listFolderTree/11.1|listFolderTree]]
 
|Lists folder in format suitable for tree display.  
 
|Lists folder in format suitable for tree display.  
 
|-
 
|-
 +
|public static
 
|[[JFolder::makeSafe/11.1|makeSafe]]
 
|[[JFolder::makeSafe/11.1|makeSafe]]
 
|Makes path name safe to use.  
 
|Makes path name safe to use.  
 
|-
 
|-
 +
|public static
 
|[[JFolder::move/11.1|move]]
 
|[[JFolder::move/11.1|move]]
 
|Moves a folder.  
 
|Moves a folder.  
 
|-
 
|-
 
|}
 
|}
 +
* '''Defined in''' libraries/joomla/filesystem/folder.php
 
===Importing===
 
===Importing===
 
<source lang="php">jimport( 'joomla.filesystem.folder' );</source>
 
<source lang="php">jimport( 'joomla.filesystem.folder' );</source>
 
===See also===
 
===See also===
* JFolder source code in [[jplatform:filesystem/folder.php|BitBucket]]
+
* {{JVer|11.1}} '''JFolder source code''' on [[jplatform:filesystem/folder.php|BitBucket]]
* [[JFolder|Other versions of this class]]
+
* {{JVer|11.1}} Subpackage [[Subpackage Filesystem/11.1|Filesystem]]
 +
* [[JFolder|Other versions of JFolder]]
 
{{SeeAlso:JFolder}}
 
{{SeeAlso:JFolder}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JFolder|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JFolder|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Examples===
+
===User contributed notes===
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 62: Line 69:
 
category=ClassExample
 
category=ClassExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JFolder]]</noinclude>
 
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JFolder]]</noinclude>

Revision as of 18:01, 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

Description

Description:JFolder [Edit Descripton]

Methods

Visibility Method name Description
public static copy Copy a folder.
public static create Create a folder -- and all necessary parent folders.
public static delete Delete a folder.
public static exists Wrapper for the standard file_exists function.
public static files Utility function to read the files in a folder.
public static folders Utility function to read the folders in a folder.
public static listFolderTree Lists folder in format suitable for tree display.
public static makeSafe Makes path name safe to use.
public static move Moves a folder.
  • Defined in libraries/joomla/filesystem/folder.php

Importing

jimport( 'joomla.filesystem.folder' );

See also

SeeAlso:JFolder [Edit See Also]

User contributed notes

<CodeExamplesForm />