Difference between revisions of "JFolder::copy"

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.

JFolder::copy[edit]

Description[edit]

Copy a folder.

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
Referenced by
- JInstaller::copyFiles

User contributed notes[edit]

Code Examples[edit]

@@ Line 4: / Line 4: @@
 Copy a folder.
-{{Description:JFolder::copy}}
-<span class="editsection" style="font-size:76%;">
-<nowiki>[</nowiki>[[Description:JFolder::copy|Edit Descripton]]<nowiki>]</nowiki>
-</span>
-===Since===
-{{JVer|11.1 }}
-===Synopsis===
 <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>
 {| class="wikitable"
@@ Line 39: / Line 40: @@
 |boolean
 |false
 |Optionally force folder/file overwrites.
 |-
 |$use_streams
@@ Line 47: / Line 48: @@
 |-
 |}
-===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
+* '''Referenced by'''
-===Referenced by===
+** [[API17:JInstaller::copyFiles|JInstaller::copyFiles]]
-* [[JInstaller/copyFiles/11.1|JInstaller::copyFiles]]
 ===See also===
-<span class="editsection" style="font-size:76%;">
+* {{JVer|11.1}} '''JFolder::copy source code''' on [[jplatform:filesystem/folder.php#cl-28|BitBucket]]
-<nowiki>[</nowiki>[[SeeAlso:JFolder::copy|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::copy|Other versions of JFolder::copy]]
-* [[JFolder::copy|Other versions of this method]]
-{{SeeAlso:JFolder::copy}}
-===Examples===
+===User contributed notes===
-<CodeExamplesForm />
+=== Code Examples ===
 <dpl>
 noresultsheader=\n
 category=JFolder::copy
-category=CodeExample
+namespace=CodeExample
 category=MethodExample
 include=*
+namespace=CodeExample
 format= ,,,
 </dpl>
-<noinclude>[[Category:JFolder]][[Category:JFolder::copy]]</noinclude>
+<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

API17