Actions

API17

Difference between revisions of "JFolder::copy"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JFolder::copy|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JFolder::copy|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public static JFolder::copy ($src, $dest, $path= '', $force=false, $use_streams=false)
+
public static function copy (
 +
        $src
 +
        $dest
 +
        $path= ''
 +
        $force=false
 +
        $use_streams=false
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 39: Line 42:
 
|boolean
 
|boolean
 
|false
 
|false
|Optionally force folder/file overwrites.  
+
|Optionally force folder/file overwrites.
 
|-
 
|-
 
|$use_streams
 
|$use_streams
Line 47: Line 50:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' mixed  object on failure or boolean True on success.
mixed  object on failure or boolean True on success.
+
* '''Defined''' on line 36 of libraries/joomla/filesystem/folder.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/filesystem/folder.php (line 35)
+
* '''Referenced by'''
* see source code in [[jplatform:filesystem/folder.php#cl-35|BitBucket]]
+
** [[JInstaller::copyFiles/11.1|JInstaller::copyFiles]]
===Referenced by===
+
* [[JInstaller::copyFiles/11.1|JInstaller::copyFiles]]
+
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JFolder::copy source code''' on [[jplatform:filesystem/folder.php#cl-28|BitBucket]]
 +
* {{JVer|11.1}} Class [[JFolder/11.1|JFolder]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Filesystem/11.1|Filesystem]]
 +
* [[JFolder::copy|Other versions of JFolder::copy]]
 +
{{SeeAlso:JFolder::copy}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JFolder::copy|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JFolder::copy|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JFolder/11.1|JFolder]]
+
===User contributed notes===
* [[JFolder::copy|Other versions of this method]]
+
{{SeeAlso:JFolder::copy}}
+
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 69: Line 72:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JFolder]][[Category:JFolder::copy]]</noinclude>
 
<noinclude>[[Category:JFolder]][[Category:JFolder::copy]]</noinclude>

Revision as of 19:57, 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::copy

Description

Copy a folder.

Description:JFolder::copy [Edit Descripton]

public static function copy (
        $src
        $dest
        $path= ''
        $force=false
        $use_streams=false
)
Parameter Type Default Description
$src string The path to the source folder.
$dest string The path to the destination folder.
$path string An optional base path to prefix to the file names.
$force boolean false Optionally force folder/file overwrites.
$use_streams false
  • Returns mixed object on failure or boolean True on success.
  • Defined on line 36 of libraries/joomla/filesystem/folder.php
  • Since Joomla 11.1
  • Referenced by

See also

SeeAlso:JFolder::copy [Edit See Also]

User contributed notes

<CodeExamplesForm />