API16

JStream/move: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 4: Line 4:




{{subst:Description:JStream/move}}
 


===Syntax===
===Syntax===
Line 72: Line 72:




{{subst:SeeAlso:JStream/move}}
 


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=move
  category=move
  category=JStream
  category=JStream
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*
  format= ,,,
  format= ,,,
</dpl>
</dpl>

Latest revision as of 02:07, 25 March 2017

Description

Moves a file



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;
}



Examples

Code Examples