Difference between revisions of "JFTP/rename"
From Joomla! Documentation
< API16:JFTP
(New page: ===Description===
Method to rename a file/folder on the FTP server
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>Edit Descripton<nowi...) |
m (removing red link to edit, no existant pages) |
||
| Line 3: | Line 3: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
| − | <nowiki>[< | + | <nowiki>[<! removed edit link to red link >]</nowiki> |
</span> | </span> | ||
| − | + | <! removed transcluded page call, red link never existed > | |
===Syntax=== | ===Syntax=== | ||
| Line 64: | Line 64: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
| − | <nowiki>[< | + | <nowiki>[<! removed edit link to red link >]</nowiki> |
</span> | </span> | ||
| − | + | <! removed transcluded page call, red link never existed > | |
===Examples=== | ===Examples=== | ||
| Line 79: | Line 79: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
| + | [[Category:Archived pages API16]] | ||
Revision as of 21:54, 13 May 2013
The "API16" 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.
Description[edit]
Method to rename a file/folder on the FTP server
[<! removed edit link to red link >]
<! removed transcluded page call, red link never existed >
Syntax[edit]
rename($from, $to)| Parameter Name | Default Value | Description |
|---|---|---|
| $from | $from Path to change file/folder from | |
| $to | $to Path to change file/folder to |
Returns[edit]
boolean True if successful
Defined in[edit]
libraries/joomla/client/ftp.php
Importing[edit]
jimport( 'joomla.client.ftp' );Source Body[edit]
function rename($from, $to) {
// If native FTP support is enabled lets use it...
if (FTP_NATIVE) {
if (@ftp_rename($this->_conn, $from, $to) === false) {
JError::raiseWarning('35', 'JFTP::rename: Bad response');
return false;
}
return true;
}
// Send rename from command to the server
if (!$this->_putCmd('RNFR '.$from, 350)) {
JError::raiseWarning('35', 'JFTP::rename: Bad response', 'Server response: '.$this->_response.' [Expected: 320] From path sent: '.$from);
return false;
}
// Send rename to command to the server
if (!$this->_putCmd('RNTO '.$to, 250)) {
JError::raiseWarning('35', 'JFTP::rename: Bad response', 'Server response: '.$this->_response.' [Expected: 250] To path sent: '.$to);
return false;
}
return true;
}[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >
Examples[edit]
<CodeExamplesForm />