API16:JStream/move

Description

Moves a file

{{subst:Description:JStream/move}}

Syntax

move($src, $dest, $context=null, $use_prefix=true, $relative=false)

Parameter Name	Default Value	Description
$src
$dest
$context	null
$use_prefix	true
$relative	false

Defined in

libraries/joomla/filesystem/stream.php

Importing

jimport( 'joomla.filesystem.stream' );

Source Body

function move($src, $dest, $context=null, $use_prefix=true, $relative=false)
{
        $res = false;
        // Capture PHP errors
        $php_errormsg = '';
        $track_errors = ini_get('track_errors');
        ini_set('track_errors', true);

        $src = $this->_getFilename($src, 'w', $use_prefix, $relative);
        $dest = $this->_getFilename($dest, 'w', $use_prefix, $relative);
        if($context) { // use the provided context
                $res = @rename($src, $dest, $context);
        } else if($this->_context) { // use the objects context
                $res = @rename($src, $dest, $this->_context);
        } else { // don't use any context
                $res = @rename($src, $dest);
        }
        if(!$res && $php_errormsg) {
                $this->setError($php_errormsg());
        }
        $this->chmod($dest);

        // restore error tracking to what it was before
        ini_set('track_errors',$track_errors);
        return $res;
}

{{subst:SeeAlso:JStream/move}}

Examples

<CodeExamplesForm />