API17:JFolder::copy
From Joomla! Documentation
(Difference between revisions)
(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> | ||
| − | |||
| − | |||
| − | |||
<source lang="php"> | <source lang="php"> | ||
| − | public static | + | 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''' 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 |
| − | + | * '''Since''' {{JVer|11.1 }} | |
| − | libraries/joomla/filesystem/folder.php | + | * '''Referenced by''' |
| − | * | + | ** [[JInstaller::copyFiles/11.1|JInstaller::copyFiles]] |
| − | + | ||
| − | * [[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> | ||
| − | + | ===User contributed notes=== | |
| − | + | ||
| − | + | ||
| − | === | + | |
<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 20:57, 27 April 2011
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
- Referenced by
See also
- JFolder::copy source code on BitBucket
- Class JFolder
- Subpackage Filesystem
- Other versions of JFolder::copy
SeeAlso:JFolder::copy [Edit See Also]
User contributed notes
<CodeExamplesForm />
