Actions

API15

JFile/move

From Joomla! Documentation

< API15:JFile
Revision as of 11:52, 12 May 2013 by JoomlaWikiBot (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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.

Contents

Description

Moves a file

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

Syntax

move($src, $dest, $path= '')
Parameter Name Default Value Description
$src $src The path to the source file
$dest $dest The path to the destination file
$path $path An optional base path to prefix to the file names

Returns

boolean True on success

Defined in

libraries/joomla/filesystem/file.php

Importing

jimport( 'joomla.filesystem.file' );

Source Body

function move($src, $dest, $path = '')
{
        // Initialize variables
        jimport('joomla.client.helper');
        $FTPOptions = JClientHelper::getCredentials('ftp');
 
        if ($path) {
                $src = JPath::clean($path.DS.$src);
                $dest = JPath::clean($path.DS.$dest);
        }
 
        //Check src path
        if (!is_readable($src) && !is_writable($src)) {
                JError::raiseWarning(21, 'JFile::move: ' . JText::_('Cannot find, read or write file') . ": '$src'");
                return false;
        }
 
        if ($FTPOptions['enabled'] == 1) {
                // Connect the FTP client
                jimport('joomla.client.ftp');
                $ftp = & JFTP::getInstance($FTPOptions['host'], $FTPOptions['port'], null, $FTPOptions['user'], $FTPOptions['pass']);
 
                //Translate path for the FTP account
                $src    = JPath::clean(str_replace(JPATH_ROOT, $FTPOptions['root'], $src), '/');
                $dest   = JPath::clean(str_replace(JPATH_ROOT, $FTPOptions['root'], $dest), '/');
 
                // Use FTP rename to simulate move
                if (!$ftp->rename($src, $dest)) {
                        JError::raiseWarning(21, JText::_('Rename failed'));
                        return false;
                }
        } else {
                if (!@ rename($src, $dest)) {
                        JError::raiseWarning(21, JText::_('Rename failed'));
                        return false;
                }
        }
        return true;
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />